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

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

Öffentliche Methoden
	RGBFormat ()
	Konstruktor der Klasse. Mehr ...

	RGBFormat (Identifier id)
	Konstruktor mit Identifier. Mehr ...

	RGBFormat (const String &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 ...

String	name () const
	Name des Farbformates. Mehr ...

	operator int () const
	Integer-Wert des Farbformats auslesen. Mehr ...

RGBFormat &	operator= (Identifier id)
	Farbformat Anhand eines Identifiers setzten. Mehr ...

void	setFormat (Identifier id)
	Farbformat Anhand einer ID festlegen. Mehr ...

void	setFormat (const String &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

enum ppl7::grafix::RGBFormat::Identifier

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.
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
GREY8	8-Bit Graustufen
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.
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.
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.
X4B4G4R4
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).
A4B4G4R4
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).
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
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
GREYALPHA32	32-Bit Graustufen mit Alpha-Wert
MaxIdentifiers	Marker für den höchsten Identifier. Wird intern von der Klasse CGrafix verwendet.

Beschreibung der Konstruktoren und Destruktoren

ppl7::grafix::RGBFormat::RGBFormat ( )

Beschreibung:: Mit diesem Konstruktor wird die Klasse mit dem Farbformat "unknown" initialisiert.

ppl7::grafix::RGBFormat::RGBFormat ( Identifier id )

Beschreibung:: Mit diesem Konstruktor wird die Klasse mit einem vorgegebenen Farbformat initialisiert

Parameter

[in] id Wert aus der Enumeration RGBFormat::Identifier

ppl7::grafix::RGBFormat::RGBFormat ( const String & 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] Identifier String mit dem Namen des Farbformats

Beispiel:: RGBFormat rgb("A8R8B8G8");

Dokumentation der Elementfunktionen

int ppl7::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 ppl7::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 ppl7::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 ppl7::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.

String ppl7::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.

ppl7::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 & ppl7::grafix::RGBFormat::operator= ( Identifier id )

Beschreibung:: Mit diesem Operator wird das Farbformat anhand eines Wertes aus der Enumeration RGBFormat::Identifier gesetzt.

Parameter

[in] id Wert aus der Enumeration RGBFormat::Identifier

Rückgabe: Liefert eine Referenz auf die Klasse zurück.

void ppl7::grafix::RGBFormat::setFormat ( Identifier id )

Beschreibung:: Mit dieser Funktion wird das Farbformat anhand eines Wertes aus der Enumeration RGBFormat::Identifier gesetzt.

Parameter

[in] id Wert aus der Enumeration RGBFormat::Identifier

void ppl7::grafix::RGBFormat::setFormat ( const String & 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] Identifier String mit dem Namen des Farbformats

Beispiel:: RGBFormat rgb;

rgb.setFormat("A8R8B8G8");

Rückgabe: Kein Rückgabewert, im Fehlerfall wirft die Funktion eine Exception.

Ausnahmebehandlung

UnknownColorFormatException Wird geworfen, wenn der Identifier nicht erkannt wurde.

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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

r1	Erstes Farbformat. Kenn entweder eine andere RGBFormat-Klasse sein, oder ein Wert aus der Enumeration RGBFormat::Identifier
r2	Zweites 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

ppl7::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:

/jenkins/jobs/clang_ppl7/workspace/include/ppl7-grafix.h
/jenkins/jobs/clang_ppl7/workspace/src/grafix/RGBFormat.cpp

Öffentliche Typen

Öffentliche Methoden

Private Attribute

Freundbeziehungen

Ausführliche Beschreibung

Dokumentation der Aufzählungstypen

Beschreibung der Konstruktoren und Destruktoren

Dokumentation der Elementfunktionen

Freundbeziehungen und Funktionsdokumentation

Dokumentation der Datenelemente