glReadPixels

glReadPixels

Name

glReadPixels - ließt einen Block von Pixel aus dem Framebuffer.

Delphi-Spezifikation

procedure glReadPixels(x: TGLint; y: TGLint; 
                             width: TGLsizei; height: TGLsizei; 
                             format: TGLenum; _type: TGLenum; 
                             pixels: PGLvoid);

Parameter

x, y	Beschreibt die Fensterkoordinaten des ersten Pixels, dass aus dem Framebuffer gelesen wird. Diese Position ist die untere, linke Ecke eines Rechtecks von Pixeln.
width, height	Beschreibt die Dimensionen des Pixelrechtecks. Die Angaben werden dabei in Pixel gemacht.
format	Bestimmt das Format der Pixeldaten. Folgende symbolische Werte werden akzeptiert: GL_COLOR_INDEX, GL_STENCIL_INDEX, GL_DEPTH_COMPONENT, GL_RED, GL_GREEN, GL_BLUE, GL_ALPHA, GL_RGB, GL_RGBA, GL_LUMINANCE, und GL_LUMINANCE_ALPHA
type	Beschreibt den Datentyp der Pixeldaten. Muss einer der Folgenden sein: GL_UNSIGNED_BYTE, GL_BYTE, GL_BITMAP, GL_UNSIGNED_SHORT, GL_SHORT, GL_UNSIGNED_INT, GL_INT, oder GL_FLOAT
pixels	Liefert die Pixeldaten zurück.

Beschreibung

glReadPixels kopiert Pixeldaten aus dem Framebuffer in den Klientspeicher der für pixels reserviert wurde. Der Kopiervorgang beginnt dabei mit dem Pixel, dessen linke untere Ecke am Punkt(x, y) liegt. Verschiedene Parameter kontrollieren die Verarbeitung der Pixeldaten bevor diese in den Klientspeicher geschrieben werden. Diese Parameter werden mit drei Befehlen gesetzt:
glPixelStore, glPixelTransfer und glPixelMap.
Dieser Artikel beschreibt die Effekte welche die meisten, aber nicht alle Parameter der genannten Artikel auf glReadPixels haben.

Möchte man, dass die Pixeldaten hintereinanderweg im Speicher erscheinen, so sollte man glPixelStoref(GL_PACK_ALIGNMENT,1) setzen, ansonten werden die Daten je nach Format durch Pixelstore weiter formatiert.

glReadPixels liefert die Werte der Pixel die im Rechteck [x+i, y+j] liegen. (mit 0<=i<width bzw. 0<=j<height)
Dabei bezeichnet [i,j] das i-te Pixel in der j-ten Zeile. Die Pixel werden zeilenweise beginnend mit der niedrigsten Zeile und von links nach rechts (innerhalb der Zeile) zurück geliefert.

Der Parameter format bestimmt das Format der zurück gelieferten Pixelwerte. Akzeptiert werden:

Format Parameter

GL_COLOR_INDEX

Farbindizes werden aus dem von glReadBuffer ausgewählten Farbpuffer gelesen. Jeder Index wird in eine Festkommazahl konvertiert, abhängig von Wert und Vorzeichen von GL_INDEX_SHIFT bitweise nach rechts bzw. links verschoben und zu GL_INDEX_OFFSET addiert. Ist GL_MAP_COLOR auf GL_TRUE gesetzt, werden Indizes durch ihre entsprechenden Werte aus der GL_PIXEL_MAP_I_TO_I Tabelle ersetzt.

GL_STENCIL_INDEX

Stencilwerte werden aus dem Stencilbuffer gelesen. Jeder Index wird in eine Festkommazahl konvertiert, abhängig von Wert und Vorzeichen von GL_INDEX_SHIFT bitweise nach rechts bzw. links verschoben und zu GL_INDEX_OFFSET addiert. Ist GL_MAP_STENCIL auf GL_TRUE gesetzt, werden Indizes durch ihre entsprechenden Werte aus der GL_PIXEL_MAP_S_TO_S Tabelle ersetzt.

GL_DEPTH_COMPONENT

Tiefenwertkomponenten werden aus dem Z-Buffer gelesen. Jede Komponente wird in eine Gleitkommazahl umgewandelt, so dass der minimale Wert auf 0.0 abgebildet wird und der maximale auf 1.0. Dann wird der Wert mit GL_DEPTH_SCALE multipliziert und zu GL_DEPTH_BIAS addiert und am Schluss auf den Bereich [0,1] begrenzt.

GL_RED
GL_GREEN
GL_BLUE
GL_ALPHA
GL_RGB
GL_RGBA
GL_LUMINANCE
GL_LUMINANCE_ALPHA

Hierbei verhält sich die Verarbeitung unterschiedlich, abhängig davon, ob Farbindizes oder Farbkomponenten im Colorbuffer gespeichert sind. Wenn Indizes gespeichert sind, werden sie aus dem mit glReadBuffer gesetzen Colorbuffer gelesen. Jeder Index wird in eine Festkommazahl konvertiert, abhängig von Wert und Vorzeichen von GL_INDEX_SHIFT bitweise nach rechts bzw. links verschoben und zu GL_INDEX_OFFSET addiert. Dann werden die Indizes durch ihre entsprechenden Werte aus den Tabellen GL_PIXEL_MAP_I_TO_R, GL_PIXEL_MAP_I_TO_G, GL_PIXEL_MAP_I_TO_B und GL_PIXEL_MAP_I_TO_A ersetzt.

Sind RGBA Farbkomponenten gespeichert, werden sie aus dem mit glReadBuffer gesetzen Colorbuffer gelesen.

Jede Farbkomponente wird so in eine Gleitkommazahl umgewandelt, dass der minimale Wert auf 0.0 abgebildet wird und der maximale auf 1.0. Dann wird der Wert mit GL_c_SCALE multipliziert und zu GL_c_BIAS addiert, und am Schluss auf den Bereich [0,1] begrenzt, wobei c durch R, G, B oder A ersetzt werden soll.

Ist GL_MAP_COLOR auf GL_TRUE gesetzt, wird jeder Farbkomponente durch die entsprechende Ersetzung aus der GL_PIXEL_MAP_c_TO_c Tabelle (wobei c wieder R, G, B oder A ist) ersetzt. Davor wird jede Komponente auf die Größe der entsprechenden Tabelle skaliert.

Abschließend werden die unbenötigen Daten verworfen, z.B.: GL_RED ignoriert die Grün, Blau und Alpha Komponente, und GL_RGB ignoriert nur den Alphawert. GL_LUMINANCE berechnet eine einzige Farbkomponente durch die Summe von Rot, Grün und Blau. GL_LUMINANCE_ALPHA hat zusätzlich noch einen Alphawert.

Die shift-, scale-, bias-, und lookup-Faktoren die weiter oben beschrieben wurden, werden alle durch glPixelTransfer spezifiziert. Der Inhalt der lookup-table wiederum wird über glPixelMap spezifiziert.

Der letzte Schritt beinhaltet eine Umwandlung der Indizes oder Komponenten in das in _type angegebene Format. Falls das Format GL_COLOR_INDEX or GL_STENCIL_INDEX ist, und der angegebene Typ nicht GL_FLOAT ist, dann wird jeder Wert mit dem Masken der der folgenden Tabelle maskiert. Falls der Typ GL_FLOAT ist werden die ganzen Zahlen (Typ Integer) in einen Gleitkommerwert umgerechnet.

Falls das Format GL_RED, GL_GREEN, GL_BLUE, GL_ALPHA, GL_RGB, GL_RGBA, GL_LUMINANCE oder GL_LUMINANCE_ALPHA ist und der Typ nicht GL_FLOAT ist, wird jede Komponente mit einen Wert multipliziert, welcher folgender Tabelle entnommen werden kann. Falls der Typ GL_FLOAT ist werden alle Komponten beibehalten wie sie sind.(Oder in das entsprechend Gleitkommaformat konventiert, falls sich dieses von dem der in GL genutzten unterscheidet)

Type	Index Mask	Komponenten Konvertierung
GL_UNSIGNED_BYTE	2^8-1	(2^8-1)c
GL_BYTE	2^7-1	([2^7-1]c-1)/2
GL_BITMAP	1	1
GL_UNSIGNED_SHORT	2^16-1	(2^16-1) c
GL_SHORT	2^15-1	[(2^15-1) c-1] / 2
GL_UNSIGNED_INT	2^32-1	(2^32-1) c
GL_INT	2^31-1	[(2^31-1) c-1] / 2
GL_FLOAT	keine	c

Ein Rechenbeispiel zum besseren Verständnis.

Die zurückgegeben Werte werden wie folgt im Speicher plaziert: Falls das Format GL_COLOR_INDEX, GL_STENCIL_INDEX, GL_DEPTH_COMPONENT, GL_RED, GL_GREEN, GL_BLUE, GL_ALPHA, oder GL_LUMINANCE ist, wird ein einzelner Wert zurückgegeben und die Daten für die iten Pixel in der jten Reihe werden an der Stelle (j) width + i plaziert. GL_RGB gibt drei Werte zurück, GL_RGBA vier, und GL_LUMINANCE_ALPHA zwei für jeden Pixel. Alle Werte die zu einem einzelnen Pixel gehören liegen nebeneinander im Feld pixels. Speicher Parameter werden von glPixelStore gesetzt, zum Beispiel legen GL_PACK_SWAP_BYTES und GL_PACK_LSB_FIRST fest, auf welche Art die Daten in den Speicher geschrieben werden.

Hinweise

Werte von Pixeln außerhalb des Fensters, das mit dem aktuellen GL-Kontext verbunden ist, sind undefiniert.

Wenn ein Fehler bei der Durchführung der Funktion auftritt, werden keine Veränderungen am Inhalt von pixels durchgeführt.

Fehlermeldungen

GL_INVALID_ENUM wird generiert wenn format oder type ein ungültiger Wert übergeben wird.
GL_INVALID_VALUE wird generiert wenn entweder width oder height negativ ist.
GL_INVALID_OPERATION wird generiert wenn format GL_COLOR_INDEX ist und der Farbpuffer RGBA Werte enthält.
GL_INVALID_OPERATION wird generiert wenn format GL_STENCIL_INDEX ist und kein Schablonen-(/Stencil-)Puffer existiert.
GL_INVALID_OPERATION wird generiert wenn format GL_DEPTH_COMPONENT ist und kein Tiefenpuffer existiert.
GL_INVALID_OPERATION wird generiert wenn glReadPixels innerhalb eines glBegin-glEnd Blocks aufgerufen wird.

Zugehörige Wertrückgaben

glGet mit Token GL_INDEX_MODE

Anwendungs Möglichkeiten

Dies ist die Funktion mit welcher Screenshots erzeugt werden können. Durch das Auslesen des Tiefenpuffer, können Heightmaps erstellt werden. Auch erhält man so die nötige Z-Koordinate wenn man mit gluUnProject die ursprüngliche Koordinate errechnen möchte.

Siehe auch

glCopyPixels, glDrawPixels, glPixelMap, glPixelStore, glPixelTransfer, glReadBuffer