From 93a6590af7f866838d883d92fac655251685c3d7 Mon Sep 17 00:00:00 2001 From: manuel Date: Sat, 2 May 2009 18:58:26 +0200 Subject: adding doxygen files --- ue2/doxygen/classCWindowsBitmap.html | 462 +++++++++++++++++++++++++++++++++++ 1 file changed, 462 insertions(+) create mode 100644 ue2/doxygen/classCWindowsBitmap.html (limited to 'ue2/doxygen/classCWindowsBitmap.html') diff --git a/ue2/doxygen/classCWindowsBitmap.html b/ue2/doxygen/classCWindowsBitmap.html new file mode 100644 index 0000000..83cbbfb --- /dev/null +++ b/ue2/doxygen/classCWindowsBitmap.html @@ -0,0 +1,462 @@ + + +imgsynth2: CWindowsBitmap Class Reference + + + + +
+ +
+
+ +
+

CWindowsBitmap Class Reference

Implementation of CBitmap handling Windows Bitmaps. +More... +

+#include <cwindowsbitmap.h> +

+

+Inheritance diagram for CWindowsBitmap:
+
+ +

+ +CBitmap +CFile + +
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 CWindowsBitmap ()
 Default ctor.
 ~CWindowsBitmap ()
 Default dtor.
void read (std::ifstream &in)
 Reads Windows Bitmap from filestream. On error an exception is thrown.
void write (std::ofstream &out)
 Writes Windows Bitmap to filestream.
const uint32_t getPixelDataSize ()
 Return size of pixelbuffer.
const uint32_t getHeight ()
 Return height of bitmap in pixel.
const uint32_t getWidth ()
 Return width of bitmap in pixel.
const bool isMirrored ()
 Windows Bitmaps can be stored upside down.
const bool hasColorTable ()
 Check if bitmap has a colortable (we don't support this yet for windows bitmaps).

Protected Attributes

BITMAP_FILEHEADER m_fileheader
BITMAP_INFOHEADER m_infoheader

Classes

struct  BITMAP_FILEHEADER
 Windows Bitmap File Header structure. More...
struct  BITMAP_INFOHEADER
 Windows Bitmap Info Header structure. More...
+

Detailed Description

+Implementation of CBitmap handling Windows Bitmaps. +

+

Modulname:
cwindowsbitmap
+
Author:
Guenther Neuwirth (0626638), Manuel Mausz (0728348)
+
Date:
17.04.2009
+Implementation of CBitmap handling Windows Bitmaps.

+On error CFile::FileError is thrown.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CWindowsBitmap::CWindowsBitmap (  ) 
+
+
+ +

+Default ctor. +

+

Methodname:
CWindowsBitmap
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + +
CWindowsBitmap::~CWindowsBitmap (  )  [inline]
+
+
+ +

+Default dtor. +

+

Methodname:
~CWindowsBitmap
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void CWindowsBitmap::read (std::ifstream &  in  )  [virtual]
+
+
+ +

+Reads Windows Bitmap from filestream. On error an exception is thrown. +

+

Methodname:
read
+
Parameters:
+ + +
in filestream to read data from
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + + +
CFile::FileError 
bad_alloc 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + + +
void CWindowsBitmap::write (std::ofstream &  out  )  [virtual]
+
+
+ +

+Writes Windows Bitmap to filestream. +

+

Methodname:
write
+
Parameters:
+ + +
out filestream to read data from
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + + +
FileError 
bad_alloc 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + +
const uint32_t CWindowsBitmap::getPixelDataSize (  )  [inline, virtual]
+
+
+ +

+Return size of pixelbuffer. +

+

Methodname:
getPixelDataSize
+
Parameters:
+ + +
- 
+
+
Returns:
size of pixelbuffer
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + +
const uint32_t CWindowsBitmap::getHeight (  )  [inline, virtual]
+
+
+ +

+Return height of bitmap in pixel. +

+

Methodname:
getHeight
+
Parameters:
+ + +
- 
+
+
Returns:
height of bitmap in pixel
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + +
const uint32_t CWindowsBitmap::getWidth (  )  [inline, virtual]
+
+
+ +

+Return width of bitmap in pixel. +

+

Methodname:
getWidth
+
Parameters:
+ + +
- 
+
+
Returns:
width of bitmap in pixel
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + +
const bool CWindowsBitmap::isMirrored (  )  [inline, virtual]
+
+
+ +

+Windows Bitmaps can be stored upside down. +

+

Methodname:
isMirrored
+
Parameters:
+ + +
- 
+
+
Returns:
true if bitmap is stored upside down. false otherwise
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+ +

+
+ + + + + + + + +
const bool CWindowsBitmap::hasColorTable (  )  [inline, virtual]
+
+
+ +

+Check if bitmap has a colortable (we don't support this yet for windows bitmaps). +

+

Methodname:
hasColorTable
+
Parameters:
+ + +
- 
+
+
Returns:
true if bitmap has a colortable. false otherwise
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implements CBitmap.

+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
BITMAP_FILEHEADER CWindowsBitmap::m_fileheader [protected]
+
+
+ +

+fileheader +

+

+ +

+
+ + + + +
BITMAP_INFOHEADER CWindowsBitmap::m_infoheader [protected]
+
+
+ +

+infoheader +

+

+

The documentation for this class was generated from the following files: +
Generated on Sat May 2 18:58:11 2009 for imgsynth2 by  + +doxygen 1.5.3
+ + -- cgit v1.2.3