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

CPixelFormat Class Reference

Abstract class for handling different color bitcount of Bitmaps. +More... +

+#include <cpixelformat.h> +

+

+Inheritance diagram for CPixelFormat:
+
+ +

+ +CPixelFormat_BGR24 +CPixelFormat_BGR555 +CPixelFormat_Indexed8 + +
+ +

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

Public Member Functions

 CPixelFormat (CBitmap *bitmap)
 Default ctor.
virtual ~CPixelFormat ()
 Default dtor (virtual).
virtual void getPixel (RGBPIXEL &pixel, const uint32_t x, const uint32_t y)=0
 Get pixel at coordinates x, y.
virtual void setPixel (const RGBPIXEL &pixel, const uint32_t x, const uint32_t y)=0
 Modifies pixel at coordinates x, y.
virtual uint32_t getBitCount ()=0
 returns color bitcount supported by this class
virtual void getMaxColor (RGBPIXEL &pixel)=0
 Get maximum values for RGB pixel.

Protected Attributes

CBitmap * m_bitmap

Classes

class  PixelFormatError
 Exception thrown by implemententations of CPixelFormat. More...
struct  RGBPIXEL
 RGB Pixel structure. More...
+

Detailed Description

+Abstract class for handling different color bitcount of Bitmaps. +

+Needed for generic use in CBitmap.

+On error throw PixelFormatError.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
CPixelFormat::CPixelFormat (CBitmap *  bitmap  )  [inline]
+
+
+ +

+Default ctor. +

+

Methodname:
CPixelFormat
+
Parameters:
+ + +
bitmap pointer to CBitmap instance
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + +
virtual CPixelFormat::~CPixelFormat (  )  [inline, virtual]
+
+
+ +

+Default dtor (virtual). +

+

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

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void CPixelFormat::getPixel (RGBPIXEL &  pixel,
const uint32_t  x,
const uint32_t  y 
) [pure virtual]
+
+
+ +

+Get pixel at coordinates x, y. +

+

Methodname:
getPixel
+
Parameters:
+ + + + +
pixel reference to pixel data
x x-coordinate
y y-coordinate
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
PixelFormatError 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void CPixelFormat::setPixel (const RGBPIXEL &  pixel,
const uint32_t  x,
const uint32_t  y 
) [pure virtual]
+
+
+ +

+Modifies pixel at coordinates x, y. +

+

Methodname:
setPixel
+
Parameters:
+ + + + +
pixel reference to new pixel data
x x-coordinate
y y-coordinate
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
PixelFormatError 
+
+
Conditions:
none
+ +
+

+ +

+
+ + + + + + + + +
virtual uint32_t CPixelFormat::getBitCount (  )  [pure virtual]
+
+
+ +

+returns color bitcount supported by this class +

+

Methodname:
getBitCount
+
Parameters:
+ + +
- 
+
+
Returns:
color bitcount supported by this class
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +

Implemented in CPixelFormat_BGR24, CPixelFormat_BGR555, and CPixelFormat_Indexed8.

+ +
+

+ +

+
+ + + + + + + + + +
virtual void CPixelFormat::getMaxColor (RGBPIXEL &  pixel  )  [pure virtual]
+
+
+ +

+Get maximum values for RGB pixel. +

+

Methodname:
getMaxColor
+
Parameters:
+ + +
pixel reference to pixel struct
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
CBitmap* CPixelFormat::m_bitmap [protected]
+
+
+ +

+pointer to CBitmap instance +

+

+

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