PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
ppl6::grafix::RGBFormat Klassenreferenz

Datentyp, der das Farbformat einer Zeichenfläche repräsentiert. Mehr ...

Öffentliche Typen

enum  Identifier {
  unknown =0, Palette, R5G6B5, B5G6R5,
  X1R5G5B5, X1B5G5R5, X4R4G4B4, A1R5G5B5,
  A1B5G5R5, A4R4G4B4, R8G8B8, B8G8R8,
  A8R8G8B8, A8B8G8R8, R3G3B2, A8,
  A8R3G3B2, X8R8G8B8, X8B8G8R8, GREY8,
  GREYALPHA32, X16R16G16B16, A16R16G16B16, MaxIdentifiers
}
 ID des Farbformats. Mehr ...
 

Öffentliche Methoden

 RGBFormat ()
 Konstruktor der Klasse. Mehr ...
 
 RGBFormat (Identifier id)
 Konstruktor mit Identifier. Mehr ...
 
 RGBFormat (const CString &Identifier)
 Konstruktor mit Namen. Mehr ...
 
int bitdepth () const
 Bittiefe des Farbformates. Mehr ...
 
int bitsPerPixel () const
 Anzahl erforderlicher Bits zur Darstellung eines Pixels. Mehr ...
 
int bytesPerPixel () const
 Anzahl Bytes pro Pixel. Mehr ...
 
int format () const
 Integer-Wert des Farbformats auslesen. Mehr ...
 
CString name () const
 Name des Farbformates. Mehr ...
 
 operator int () const
 Integer-Wert des Farbformats auslesen. Mehr ...
 
RGBFormatoperator= (Identifier id)
 Farbformat Anhand eines Identifiers setzten. Mehr ...
 
void setFormat (Identifier id)
 Farbformat Anhand einer ID festlegen. Mehr ...
 
int setFormat (const CString &Identifier)
 Farbformat anhand seines Namens festlegen. Mehr ...
 

Private Attribute

int f
 Interne Variable zum Speichern des Farbformats. Mehr ...
 

Freundbeziehungen

bool operator!= (const RGBFormat &r1, const RGBFormat &r2)
 Zwei Farbformate vergleichen. Mehr ...
 
bool operator!= (const RGBFormat &r1, RGBFormat::Identifier r2)
 Zwei Farbformate vergleichen. Mehr ...
 
bool operator!= (RGBFormat::Identifier r1, const RGBFormat &r2)
 Zwei Farbformate vergleichen. Mehr ...
 
bool operator== (const RGBFormat &r1, const RGBFormat &r2)
 Zwei Farbformate vergleichen. Mehr ...
 
bool operator== (const RGBFormat &r1, RGBFormat::Identifier r2)
 Zwei Farbformate vergleichen. Mehr ...
 
bool operator== (RGBFormat::Identifier r1, const RGBFormat &r2)
 Zwei Farbformate vergleichen. Mehr ...
 

Ausführliche Beschreibung

Beschreibung:
Mit dieser Klasse wird das Farbformat einer Zeichenfläche repräsentiert. Sie enthält nur einen einzigen Wert aus der Enumeration RGBFormat::Identifier, der das verwendete Farbformat festlegt.

Dokumentation der Aufzählungstypen

Beschreibung:
Diese Enumeration enthält die Namen der möglichen Farbformate. Gegenwärtig werden von der PPL-Library aber nur folgende 32-Bit-Formate unterstützt:
Aufzählungswerte
unknown 

Unbekanntes Farbformat.

Palette 

8-Bit Farbwerte aus einer Farbpalette. Es handelt sich um eine Grafik mit einer Farbpalette von 256 Farben. Satt des eigentlichen Farbwertes enthält jeder Pixel der Grafik eine Referenz auf die Farbpalette. Dieses Format war Anfang der 90er sehr populär, da es wenig Speicher braucht, sehr schnell ist und von jeder Grafikkarte unterstützt wurde.

R5G6B5 

16-Bit High-Color, 5 Bit für Rot, 6 Bit für Grün und 5 Bit für Blau, wobei Blau in den unteren Bits enthalten ist

B5G6R5 

16-Bit High-Color, 5 Bit für Blau, 6 Bit für Grün und 5 Bit für Rot, wobei Rot in den unteren Bits enthalten ist

X1R5G5B5 

16-Bit High-Color, 5 Bit für Rot, 5 Bit für Grün und 5 Bit für Blau, wobei Blau in den unteren Bits enthalten ist und das höchstwertige Bit unbenutzt ist.

X1B5G5R5 

16-Bit High-Color, jeder Farbwert wird mit 5 Bit dargestellt, wobei Rot in den unteren Bits enthalten ist und das höchstwertige Bit unbenutzt ist.

X4R4G4B4 

16-Bit High-Color, jeweils 4 Bit für Rot, Grün, Blau, wobei Blau in den unteren Bits enthalten ist und in den höchstwertigen 4-Bit unbenutzt sind.

A1R5G5B5 

16-Bit High-Color, 5 Bit für Rot, 5 Bit für Grün und 5 Bit für Blau, wobei Blau in den unteren Bits enthalten ist und das höchstwertige Bit als Alphakanal (Transparenz) verwendet wird.

A1B5G5R5 

16-Bit High-Color, jeder Farbwert wird mit 5 Bit dargestellt, wobei Rot in den unteren Bits enthalten ist und das höchstwertige Bit als Alphakanal (Transparenz) verwendet wird.

A4R4G4B4 

16-Bit High-Color, jeweils 4 Bit für Rot, Grün, Blau und Alpha, wobei Blau in den unteren Bits enthalten ist und in den höchstwertigen 4-Bit der Alphakanal (Transparenz).

R8G8B8 

24-Bit Truecolor, jeweils 8 Bit für Rot, Grün und Blau, wobei Blau im untersten Byte gespeichert wird.

B8G8R8 

24-Bit Truecolor, jeweils 8 Bit für Rot, Grün und Blau, wobei Rot im untersten Byte gespeichert wird.

A8R8G8B8 

32-Bit Truecolor, jeweils 8 Bit für den Alpha-Wert, Rot, Grün und Blau, wobei Blau im untersten Byte gespeichert wird

A8B8G8R8 

32-Bit Truecolor, jeweils 8 Bit für den Alpha-Wert, Rot, Grün und Blau, wobei Rot im untersten Byte gespeichert wird

R3G3B2 

8-Bit, 3 Bit für Rot, 3 Bit für Grün und 2 Bit für Blau, wobei Blau in den unteren Bits enthalten ist.

A8 

8-Bit Alphakanal

A8R3G3B2 

16-Bit, 3 Bit für Rot, 3 Bit für Grün, 2 Bit für Blau und 8 Bit für den Alphakanal, wobei Blau in den unteren Bits enthalten ist und in den höchstwertigen 8-Bit der Alphakanal (Transparenz).

X8R8G8B8 

32-Bit Truecolor, jeweils 8 Bit für Rot, Grün und Blau, wobei Blau im untersten Byte gespeichert wird und das höchste Byte unbenutzt ist

X8B8G8R8 

32-Bit Truecolor, jeweils 8 Bit für Rot, Grün und Blau, wobei Rot im untersten Byte gespeichert wird und das höchste Byte unbenutzt ist

GREY8 

8-Bit Graustufen

GREYALPHA32 

32-Bit Graustufen mit Alpha-Wert

X16R16G16B16 

64-Bit Truecolor, jeweils 16 Bit für den Rot, Grün und Blau-Wert, wobei Rot im untersten Doppelbyte gespeichert wird und das oberste Doppelbyte unbenutzt ist.

A16R16G16B16 

64-Bit Truecolor, jeweils 16 Bit für den Alpha-Wert, Rot, Grün und Blau, wobei Blau im untersten Doppelbyte gespeichert wird der Alpha-Kanal im obersten.

MaxIdentifiers 

Marker für den höchsten Identifier. Wird intern von der Klasse CGrafix verwendet.

Beschreibung der Konstruktoren und Destruktoren

ppl6::grafix::RGBFormat::RGBFormat ( )
Beschreibung:
Mit diesem Konstruktor wird die Klasse mit dem Farbformat "unknown" initialisiert.
ppl6::grafix::RGBFormat::RGBFormat ( Identifier  id)
Beschreibung:
Mit diesem Konstruktor wird die Klasse mit einem vorgegebenen Farbformat initialisiert
Parameter
[in]idWert aus der Enumeration RGBFormat::Identifier
ppl6::grafix::RGBFormat::RGBFormat ( const CString Identifier)
Beschreibung:
Mit diesem Konstruktor wird die Klasse mit einem Farbformat initialisiert, dass anhand seines Namens definiert wird. Die Namen sind identisch mit denen aus der Enumeration RGBFormat::Identifier
Parameter
[in]IdentifierString mit dem Namen des Farbformats
Beispiel:
RGBFormat rgb("A8R8B8G8");

Dokumentation der Elementfunktionen

int ppl6::grafix::RGBFormat::bitdepth ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl Bits zurück, die zur Darstellung des gewählten Farbformats erforderlich sind. Ist in der Regel 8, 16, 24, 32 oder 64. Die Funktion ist identisch mit RGBFormat::bitsPerPixel.
Rückgabe
Anzahl erforderlicher Bits oder 0, wenn kein Farbformat gesetzt ist.
int ppl6::grafix::RGBFormat::bitsPerPixel ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl Bits zurück, die zur Darstellung des gewählten Farbformats erforderlich sind. Ist in der Regel 8, 16, 24, 32 oder 64. Die Funktion ist identisch mit RGBFormat::bitdepth.
Rückgabe
Anzahl erforderlicher Bits oder 0, wenn kein Farbformat gesetzt ist.
int ppl6::grafix::RGBFormat::bytesPerPixel ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl Bytes zurück, die zur Darstellung des gewählten Farbformats erforderlich sind. Ist in der Regel 1, 2, 3, 4 oder 8. Die Funktion ruft intern RGBFormat::bitdepth auf und teilt das Ergebnis durch 8.
Rückgabe
Anzahl erforderlicher Bytes pro Pixel oder 0, wenn kein Farbformat gesetzt ist.
int ppl6::grafix::RGBFormat::format ( ) const
Beschreibung:
Mit dieser Funktion wird der Integer-Wert des Farbformates ausgelesen. Der Wert entspricht der Position des Farbformates innerhalb der Enumeration RGBFormat::Identifier.
Rückgabe
Integer-Wert, der das Farbformat repräsentiert.
CString ppl6::grafix::RGBFormat::name ( ) const
Beschreibung:
Diese Funktion gibt den Namen des aktuell gewählten Farbformates als String zurück.
Rückgabe
String mit dem Namen des Farbformates, oder "unknown", wenn kein Farbformat gesetzt wurde.
ppl6::grafix::RGBFormat::operator int ( ) const
Beschreibung:
Mit diesem Operator wird der Integer-Wert des Farbformates ausgelesen. Der Wert entspricht der Position des Farbformates innerhalb der Enumeration RGBFormat::Identifier.
Rückgabe
Integer-Wert, der das Farbformat repräsentiert.
RGBFormat & ppl6::grafix::RGBFormat::operator= ( Identifier  id)
Beschreibung:
Mit diesem Operator wird das Farbformat anhand eines Wertes aus der Enumeration RGBFormat::Identifier gesetzt.
Parameter
[in]idWert aus der Enumeration RGBFormat::Identifier
Rückgabe
Liefert eine Referenz auf die Klasse zurück.
void ppl6::grafix::RGBFormat::setFormat ( Identifier  id)
Beschreibung:
Mit dieser Funktion wird das Farbformat anhand eines Wertes aus der Enumeration RGBFormat::Identifier gesetzt.
Parameter
[in]idWert aus der Enumeration RGBFormat::Identifier
int ppl6::grafix::RGBFormat::setFormat ( const CString Identifier)
Beschreibung:
Mit dieser Funktion wird das Farbformat anhand seines Namens gesetzt. Die Namen sind identisch mit denen aus der Enumeration RGBFormat::Identifier.
Parameter
[in]IdentifierString mit dem Namen des Farbformats
Beispiel:
rgb.setFormat("A8R8B8G8");
Rückgabe
Die Funktion gibt 1 zurück, wenn der String erkannt wurde und das Farbformat bekannt ist. Ist dies nicht der Fall, wird 0 zurückgegeben und der Fehlercode 1065 gesetzt.

Freundbeziehungen und Funktionsdokumentation

bool operator!= ( const RGBFormat r1,
const RGBFormat r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.
bool operator!= ( const RGBFormat r1,
RGBFormat::Identifier  r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.
bool operator!= ( RGBFormat::Identifier  r1,
const RGBFormat r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.
bool operator== ( const RGBFormat r1,
const RGBFormat r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.
bool operator== ( const RGBFormat r1,
RGBFormat::Identifier  r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.
bool operator== ( RGBFormat::Identifier  r1,
const RGBFormat r2 
)
friend
Beschreibung:
Mit dem Operatoren != und == können zwei Farbwerte miteinander verglichen werden.
Parameter
r1Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2Zweites Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
Rückgabe
Wird == verwendet, liefert die Funktion true zurück, wenn beide Farbformate identisch sind, sonst false. Wird != verwendet, liefert die Funktion true zurück, wenn die beiden Farbformate unterschiedlich sind, sonst true.

Dokumentation der Datenelemente

ppl6::grafix::RGBFormat::f
private
Beschreibung:
Diese Variable wird intern von der RGBFormat-Klasse zum Speichern des Farbformats verwendet.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: