Difference between revisions of "Template:Glapi pixeltransferupparams"

From OpenGL Wiki
Jump to navigation Jump to search
(Pixel transfer parameters for documentation pages.)
 
(Correction for the `data` parameter.)
Line 4: Line 4:
 
: Specifies the data type of the pixel data. The following symbolic values are accepted: {{enum|GL_UNSIGNED_BYTE}}, {{enum|GL_BYTE}}, {{enum|GL_UNSIGNED_SHORT}}, {{enum|GL_SHORT}}, {{enum|GL_UNSIGNED_INT}}, {{enum|GL_INT}}, {{enum|GL_FLOAT}}, {{enum|GL_UNSIGNED_BYTE_3_3_2}}, {{enum|GL_UNSIGNED_BYTE_2_3_3_REV}}, {{enum|GL_UNSIGNED_SHORT_5_6_5}}, {{enum|GL_UNSIGNED_SHORT_5_6_5_REV}}, {{enum|GL_UNSIGNED_SHORT_4_4_4_4}}, {{enum|GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{enum|GL_UNSIGNED_SHORT_5_5_5_1}}, {{enum|GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{enum|GL_UNSIGNED_INT_8_8_8_8}}, {{enum|GL_UNSIGNED_INT_8_8_8_8_REV}}, {{enum|GL_UNSIGNED_INT_10_10_10_2}}, and {{enum|GL_UNSIGNED_INT_2_10_10_10_REV}}.
 
: Specifies the data type of the pixel data. The following symbolic values are accepted: {{enum|GL_UNSIGNED_BYTE}}, {{enum|GL_BYTE}}, {{enum|GL_UNSIGNED_SHORT}}, {{enum|GL_SHORT}}, {{enum|GL_UNSIGNED_INT}}, {{enum|GL_INT}}, {{enum|GL_FLOAT}}, {{enum|GL_UNSIGNED_BYTE_3_3_2}}, {{enum|GL_UNSIGNED_BYTE_2_3_3_REV}}, {{enum|GL_UNSIGNED_SHORT_5_6_5}}, {{enum|GL_UNSIGNED_SHORT_5_6_5_REV}}, {{enum|GL_UNSIGNED_SHORT_4_4_4_4}}, {{enum|GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{enum|GL_UNSIGNED_SHORT_5_5_5_1}}, {{enum|GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{enum|GL_UNSIGNED_INT_8_8_8_8}}, {{enum|GL_UNSIGNED_INT_8_8_8_8_REV}}, {{enum|GL_UNSIGNED_INT_10_10_10_2}}, and {{enum|GL_UNSIGNED_INT_2_10_10_10_REV}}.
 
; data
 
; data
: Specifies a pointer to the image data in memory.
+
: Specifies a pointer to the image data in memory, or if a [[Buffer Object|buffer]] is bound to {{enum|GL_PIXEL_UNPACK_BUFFER}}, this provides an integer offset into the bound buffer object. If a buffer is not bound to {{enum|GL_PIXEL_UNPACK_BUFFER}}, {{#if: {{{1}}}|this parameter may not be NULL.|and this parameter is NULL, no [[Pixel Transfer]] will be performed.}}

Revision as of 15:27, 24 May 2012

format
Specifies the format of the pixel data. The following symbolic values are accepted: GL_RED, GL_RG, GL_RGB, GL_BGR, GL_RGBA, and GL_BGRA.
type
Specifies the data type of the pixel data. The following symbolic values are accepted: GL_UNSIGNED_BYTE, GL_BYTE, GL_UNSIGNED_SHORT, GL_SHORT, GL_UNSIGNED_INT, GL_INT, GL_FLOAT, GL_UNSIGNED_BYTE_3_3_2, GL_UNSIGNED_BYTE_2_3_3_REV, GL_UNSIGNED_SHORT_5_6_5, GL_UNSIGNED_SHORT_5_6_5_REV, GL_UNSIGNED_SHORT_4_4_4_4, GL_UNSIGNED_SHORT_4_4_4_4_REV, GL_UNSIGNED_SHORT_5_5_5_1, GL_UNSIGNED_SHORT_1_5_5_5_REV, GL_UNSIGNED_INT_8_8_8_8, GL_UNSIGNED_INT_8_8_8_8_REV, GL_UNSIGNED_INT_10_10_10_2, and GL_UNSIGNED_INT_2_10_10_10_REV.
data
Specifies a pointer to the image data in memory, or if a buffer is bound to GL_PIXEL_UNPACK_BUFFER, this provides an integer offset into the bound buffer object. If a buffer is not bound to GL_PIXEL_UNPACK_BUFFER, this parameter may not be NULL.