Difference between revisions of "Template:Glapi pixeltransferupparams"

From OpenGL Wiki
Jump to navigation Jump to search
(Correction for the `data` parameter.)
m (typo)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
; format
 
; format
: Specifies the format of the pixel data. The following symbolic values are accepted: {{enum|GL_RED}}, {{enum|GL_RG}}, {{enum|GL_RGB}}, {{enum|GL_BGR}}, {{enum|GL_RGBA}}, and {{enum|GL_BGRA}}.
+
: Specifies the [[Pixel Transfer#Pixel_format|format of the pixel data]]. For transfers of depth, stencil, or depth/stencil data, you must use {{enum|GL_DEPTH_COMPONENT}}, {{enum|GL_STENCIL_INDEX}}, or {{enum|GL_DEPTH_STENCIL}}, where appropriate. For transfers of normalized integer or floating-point color image data, you must use one of the following: {{enum|GL_RED}}, {{enum|GL_GREEN}}, {{enum|GL_BLUE}}, {{enum|GL_RG}}, {{enum|GL_RGB}}, {{enum|GL_BGR}}, {{enum|GL_RGBA}}, and {{enum|GL_BGRA}}. For transfers of non-normalized integer data, you must use one of the following: {{enum|GL_RED_INTEGER}}, {{enum|GL_GREEN_INTEGER}}, {{enum|GL_BLUE_INTEGER}}, {{enum|GL_RG_INTEGER}}, {{enum|GL_RGB_INTEGER}}, {{enum|GL_BGR_INTEGER}}, {{enum|GL_RGBA_INTEGER}}, and {{enum|GL_BGRA_INTEGER}}. {{#if: {{{1}}}||Even if no actual pixel transfer is made ({{param|data}} is NULL and no buffer is bound to {{enum|GL_PIXEL_UNPACK_BUFFER}}), you must set this parameter correctly for the internal format of the destination image.}}
 
; type
 
; type
 
: 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, 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.}}
+
: Specifies a pointer to {{#ifeq: {{{single|+}}} | {{{single|-}}} | a single pixel of data to upload. This parameter may not be NULL. | the image data in memory, or if a [[Buffer Object|buffer]] is bound to {{#ifeq: {{{read|+}}} | {{{read|-}}}|{{enum|GL_PIXEL_PACK_BUFFER}}|{{enum|GL_PIXEL_UNPACK_BUFFER}}}}, this provides an integer offset into the bound buffer object. If a buffer is not bound to {{#ifeq: {{{read|+}}} | {{{read|-}}}|{{enum|GL_PIXEL_PACK_BUFFER}}|{{enum|GL_PIXEL_UNPACK_BUFFER}}}}, {{#ifeq: {{{1|+}}} | {{{1|-}}}|this parameter may not be NULL.|and this parameter is NULL, no [[Pixel Transfer]] will be performed.}} }}
 +
<noinclude>[[Category:Template API Helpers]]</noinclude>

Latest revision as of 00:45, 25 July 2013

format
Specifies the format of the pixel data. For transfers of depth, stencil, or depth/stencil data, you must use GL_DEPTH_COMPONENT, GL_STENCIL_INDEX, or GL_DEPTH_STENCIL, where appropriate. For transfers of normalized integer or floating-point color image data, you must use one of the following: GL_RED, GL_GREEN, GL_BLUE, GL_RG, GL_RGB, GL_BGR, GL_RGBA, and GL_BGRA. For transfers of non-normalized integer data, you must use one of the following: GL_RED_INTEGER, GL_GREEN_INTEGER, GL_BLUE_INTEGER, GL_RG_INTEGER, GL_RGB_INTEGER, GL_BGR_INTEGER, GL_RGBA_INTEGER, and GL_BGRA_INTEGER.
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, and this parameter is NULL, no Pixel Transfer will be performed.