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/classCPixmap.html | 596 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 596 insertions(+) create mode 100644 ue2/doxygen/classCPixmap.html (limited to 'ue2/doxygen/classCPixmap.html') diff --git a/ue2/doxygen/classCPixmap.html b/ue2/doxygen/classCPixmap.html new file mode 100644 index 0000000..cb1d740 --- /dev/null +++ b/ue2/doxygen/classCPixmap.html @@ -0,0 +1,596 @@ + + +imgsynth2: CPixmap Class Reference + + + + +
+ +
+
+ +
+

CPixmap Class Reference

Implementation of CFile handling Pixmap file format. +More... +

+#include <cpixmap.h> +

+

+Inheritance diagram for CPixmap:
+
+ +

+ +CBitmap +CFile + +
+ +

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

Public Member Functions

 CPixmap ()
 Default ctor.
 ~CPixmap ()
 Default dtor.
void read (std::ifstream &in)
 Reads Pixmap from filestream. On error an exception is thrown.
void write (std::ofstream &out)
 Writes Pixmap 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 hasColorTable ()
 Check if bitmap has a colortable (we don't support this yet for windows bitmaps).
const bool isMirrored ()
 Windows Bitmaps can be stored upside down.

Protected Member Functions

std::string getLine (std::ifstream &in, bool ignore_comments=true)
 read trimmed line (terminated by
+) from filestream
std::string getCArrayLine (std::ifstream &in)
 read trimmed c-arrayline from filestream
const std::string getXPMColorID (unsigned int index, unsigned int length)
 get xpm color identifier, generated using an index

Protected Attributes

PIXMAP_FILEHEADER m_fileheader
std::string m_imagename

Classes

struct  PIXMAP_FILEHEADER
 Pixmap Header structure. More...
+

Detailed Description

+Implementation of CFile handling Pixmap file format. +

+In order to support operations on pixmaps in color mode an implementations of CPixelFormat is used. These classe are allowed to modify the pixmap header, pixelbuffer and color table directly.

+On error CFile::FileError is thrown.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CPixmap::CPixmap (  ) 
+
+
+ +

+Default ctor. +

+

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

+ +

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

+Default dtor. +

+

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

+

Member Function Documentation

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

+Reads Pixmap 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 CPixmap::write (std::ofstream &  out  )  [virtual]
+
+
+ +

+Writes Pixmap 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 CPixmap::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 CPixmap::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 CPixmap::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 CPixmap::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.

+ +
+

+ +

+
+ + + + + + + + +
const bool CPixmap::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.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
std::string CPixmap::getLine (std::ifstream &  in,
bool  ignore_comments = true 
) [protected]
+
+
+ +

+read trimmed line (terminated by
+) from filestream +

+

Methodname:
getLine
+
Parameters:
+ + + +
in filestream to read data from
ignore_comments true: ignore c-like comments
+
+
Returns:
return trimmed line from filestream
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + + +
std::string CPixmap::getCArrayLine (std::ifstream &  in  )  [protected]
+
+
+ +

+read trimmed c-arrayline from filestream +

+

Methodname:
getArrayLine
+
Parameters:
+ + +
in filestream to read data from
+
+
Returns:
return trimmed c-arrayline from filestream
+
Global variables used:
none
+
Exceptions:
+ + +
FileError 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
const std::string CPixmap::getXPMColorID (unsigned int  index,
unsigned int  length 
) [protected]
+
+
+ +

+get xpm color identifier, generated using an index +

+

Methodname:
getXPMColorID
+
Parameters:
+ + + +
index index used to generate the xpm color identifier
length length of xpm color identifier
+
+
Returns:
return xpm color identifier, generated using index
+
Global variables used:
none
+
Exceptions:
+ + +
FileError 
+
+
Conditions:
none
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
PIXMAP_FILEHEADER CPixmap::m_fileheader [protected]
+
+
+ +

+fileheader +

+

+ +

+
+ + + + +
std::string CPixmap::m_imagename [protected]
+
+
+ +

+name of image/c-array +

+

+

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