GlTexImage2D: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
m (Protected "GlTexImage2D" ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''_glTexImage2D:''' specify a two-dimensional texture image
{{DISPLAYTITLE:_glTexImage2D}}
The '''_glTexImage2D''' statement specifies a two-dimensional texture image.




{{PageSyntax}}
{{PageSyntax}}
: [[_glTexImage2D]] GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalformat}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}}, GLint {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}}


  SUB _glTexImage2D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL internalformat AS LONG, BYVAL width AS LONG, BYVAL height AS LONG, BYVAL border AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET)
  void '''_glTexImage2D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalFormat}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|data}});


 
{{PageParameters}}
; target
* OpenGL is using its own set of variable types to describe its command parameters.
: Specifies the target texture. Must be {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}.
* Use the following table to find the respective QB64 [[Variable Types]].
; level
{{OpenGLTypesPlugin}}
: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. If {{Parameter|target}} is {{KW|_GL_TEXTURE_RECTANGLE}} or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{Parameter|level}} must be 0.
; internalFormat
: Specifies the number of color components in the texture. Must be one of base internal formats given in Table 1, one of the sized internal formats given in Table 2, or one of the compressed internal formats given in Table 3, below.
; width
: Specifies the width of the texture image. All implementations support texture images that are at least 1024 texels wide.
; height
: Specifies the height of the texture image, or the number of layers in a texture array, in the case of the {{KW|_GL_TEXTURE_1D_ARRAY}} and {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} targets. All implementations support 2D texture images that are at least 1024 texels high, and texture arrays that are at least 256 layers deep.
; border
: This value must be 0.
{{glapi pixeltransferupparams}}




{{PageDescription}}
{{PageDescription}}
 
* OpenGL's documentation is available in several places, so we won't reproduce it here for another time.
Texturing allows elements of an image array to be read by shaders.
* The full description for this command can be found at [https://learn.microsoft.com/en-us/windows/win32/opengl/glteximage2d Microsoft Docs] and is also valid for QB64 usage.
 
To define texture images, call '''_glTexImage2D'''. The arguments describe the parameters of the texture image, such as height, width, width of the border, level-of-detail number (see {{KW|_glTexParameter}}), and number of color components provided. The last three arguments describe how the image is represented in memory.
 
If {{Parameter|target}} is {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}, or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, no data is read from {{Parameter|data}}, but all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities. If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to 0, but does not generate an error (see {{KW|_glGetError}}). To query for an entire mipmap array, use an image array level greater than or equal to 1.
 
If {{Parameter|target}} is {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_RECTANGLE}} or one of the {{KW|_GL_TEXTURE_CUBE_MAP}} targets, data is read from {{Parameter|data}} as a sequence of signed or unsigned bytes, shorts, or longs, or single-precision floating-point values, depending on {{Parameter|type}}. These values are grouped into sets of one, two, three, or four values, depending on {{Parameter|format}}, to form elements. Each data byte is treated as eight 1-bit elements, with bit ordering determined by {{KW|_GL_UNPACK_LSB_FIRST}} (see {{KW|_glPixelStore}}).
 
If {{Parameter|target}} is {{KW|_GL_TEXTURE_1D_ARRAY}}, data is interpreted as an array of one-dimensional images.
 
If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is specified, {{Parameter|data}} is treated as a byte offset into the buffer object's data store.
 
The first element corresponds to the lower left corner of the texture image. Subsequent elements progress left-to-right through the remaining texels in the lowest row of the texture image, and then in successively higher rows of the texture image. The final element corresponds to the upper right corner of the texture image.
 
{{Parameter|format}} determines the composition of each element in {{Parameter|data}}. It can assume one of these symbolic values:
 
; {{KW|_GL_RED}}
: Each element is a single red component. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for green and blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1].
; {{KW|_GL_RG}}
: Each element is a red/green double. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1].
; {{KW|_GL_RGB}}
: ; {{KW|_GL_BGR}}
: Each element is an RGB triple. The GL converts it to floating point and assembles it into an RGBA element by attaching 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1].
; {{KW|_GL_RGBA}}
: ; {{KW|_GL_BGRA}}
: Each element contains all four components. Each component is multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1].
; {{KW|_GL_DEPTH_COMPONENT}}
: Each element is a single depth value. The GL converts it to floating point, multiplies by the signed scale factor {{KW|_GL_DEPTH_SCALE}}, adds the signed bias {{KW|_GL_DEPTH_BIAS}}, and clamps to the range [0,1].
; {{KW|_GL_DEPTH_STENCIL}}
: Each element is a pair of depth and stencil values. The depth component of the pair is interpreted as in {{KW|_GL_DEPTH_COMPONENT}}. The stencil component is interpreted based on specified the depth + stencil internal format.
If an application wants to store the texture at a certain resolution or in a certain format, it can request the resolution and format with {{Parameter|internalFormat}}. The GL will choose an internal representation that closely approximates that requested by {{Parameter|internalFormat}}, but it may not match exactly. (The representations specified by {{KW|_GL_RED}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}}, and {{KW|_GL_RGBA}} must match exactly.)
 
{{Parameter|internalFormat}} may be one of the base internal formats shown in Table 1, below
 
{{glapi baseformattable}}
 
{{Parameter|internalFormat}} may also be one of the sized internal formats shown in Table 2, below
 
{{glapi internalformattable}}
 
Finally, {{Parameter|internalFormat}} may also be one of the generic or compressed compressed texture formats shown in Table 3 below
 
{{glapi compressedformattable}}
 
If the {{Parameter|internalFormat}} parameter is one of the generic compressed formats, {{KW|_GL_COMPRESSED_RED}}, {{KW|_GL_COMPRESSED_RG}}, {{KW|_GL_COMPRESSED_RGB}}, or {{KW|_GL_COMPRESSED_RGBA}}, the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format.
 
If the {{Parameter|internalFormat}} parameter is {{KW|_GL_SRGB}}, {{KW|_GL_SRGB8}}, {{KW|_GL_SRGB_ALPHA}}, or {{KW|_GL_SRGB8_ALPHA8}}, the texture is treated as if the red, green, or blue components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component c<sub>s</sub> to a linear component c<sub>l</sub> is:
 
{{glapi srgb equation}}
 
Assume c<sub>s</sub> is the sRGB component in the range [0,1].
 
Use the {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, or {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}} target to try out a resolution and format. The implementation will update and recompute its best match for the requested storage resolution and format. To then query this state, call {{KW|_glGetTexLevelParameter}}. If the texture cannot be accommodated, texture state is set to 0.
 
A one-component texture image uses only the red component of the RGBA color extracted from {{Parameter|data}}. A two-component image uses the R and G values. A three-component image uses the R, G, and B values. A four-component image uses all of the RGBA components.
 
Image-based shadowing can be enabled by comparing texture r coordinates to depth texture values to generate a boolean result. See {{KW|_glTexParameter}} for details on texture comparison.
 
 
{{PageNotes}}
 
The {{KW|_glPixelStore}} mode affects texture images.
 
{{Parameter|data}} may be a null pointer. In this case, texture memory is allocated to accommodate a texture of width {{Parameter|width}} and height {{Parameter|height}}. You can then download subtextures to initialize this texture memory. The image is undefined if the user tries to apply an uninitialized portion of the texture image to a primitive.
 
'''_glTexImage2D''' specifies the two-dimensional texture for the current texture unit, specified with {{KW|_glActiveTexture}}.
 
 
{{PageErrors}}
 
{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, or {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}.
 
{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is one of the six cube map 2D image targets and the width and height parameters are not equal.
 
{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|type}} is not a type constant.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_1D_ARRAY}} or {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} and {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is {{KW|_GL_TEXTURE_1D_ARRAY}} or {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} and {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_ARRAY_TEXTURE_LAYERS}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0.
 
{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log<sub>2</sub>(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|internalFormat}} is not one of the accepted resolution and format symbolic constants.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} or {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|border}} is not 0.
 
{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}}, or {{KW|_GL_UNSIGNED_INT_10F_11F_11F_REV}}, and {{Parameter|format}} is not {{KW|_GL_RGB}}.
 
{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}}, or {{KW|_GL_UNSIGNED_INT_5_9_9_9_REV}}, and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}.
 
{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_TEXTURE_RECTANGLE}}, or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, and {{Parameter|internalFormat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}.
 
{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_COMPONENT}} and {{Parameter|internalFormat}} is not {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}.
 
{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|internalFormat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}, and {{Parameter|format}} is not {{KW|_GL_DEPTH_COMPONENT}}.
 
{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped.
 
{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size.
 
{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}.
 
{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is {{KW|_GL_TEXTURE_RECTANGLE}} or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}} and {{Parameter|level}} is not 0.
 
 
{{PageUseWith}}
 
{{KW|_glGetTexImage}}
 
{{KW|_glGet}} with argument {{KW|_GL_PIXEL_UNPACK_BUFFER_BINDING}}




{{PageSeeAlso}}
{{PageSeeAlso}}
 
* [[_GL|SUB _GL]]
[[_GL|SUB _GL]]
* [[_glBegin]], [[_glDrawPixels]], [[_glEnd]], [https://learn.microsoft.com/en-us/windows/win32/opengl/glfog _glFog]
{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glTexImage1D}}, {{KW|_glTexImage2DMultisample}}, {{KW|_glTexImage3D}}, {{KW|_glTexImage3DMultisample}}, {{KW|_glTexSubImage2D}}, {{KW|_glPixelStore}}
* [[_glIsEnabled]], [https://learn.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://learn.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://learn.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv]
 
* [https://learn.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [https://learn.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter]
 
{{PageCopyright}}




{{PageNavigation}}
{{PageNavigation}}

Latest revision as of 01:49, 28 January 2023

The _glTexImage2D statement specifies a two-dimensional texture image.


Syntax

_glTexImage2D GLenum target, GLint level, GLint internalformat, GLsizei width, GLsizei height, GLint border, GLint format, GLenum type, const GLvoid *pixels


Parameters

  • OpenGL is using its own set of variable types to describe its command parameters.
  • Use the following table to find the respective QB64 Variable Types.
   Table 2: Relations between the OpenGL variable types vs. C/C++ and QB64.
 ┌──────────────┬────────────────┬──────────────────────────────────────────┐
 │    OpenGL    │     C/C++      │     QB64                                 │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLenum       │ unsigned int   │ _UNSIGNED LONG                           │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLboolean    │ unsigned char  │ _UNSIGNED _BYTE                          │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLbitfield   │ unsigned int   │ _UNSIGNED LONG                           │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLbyte       │ signed char    │ _BYTE                                    │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLshort      │ short          │ INTEGER                                  │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLint        │ int            │ LONG                                     │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLsizei      │ int            │ LONG                                     │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLubyte      │ unsigned char  │ _UNSIGNED _BYTE                          │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLushort     │ unsigned short │ _UNSIGNED INTEGER                        │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLuint       │ unsigned int   │ _UNSIGNED LONG                           │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLfloat      │ float          │ SINGLE                                   │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLclampf     │ float          │ SINGLE                                   │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLdouble     │ double         │ DOUBLE                                   │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLclampd     │ double         │ DOUBLE                                   │
 ├──────────────┼────────────────┼──────────────────────────────────────────┤
 │ GLvoid   (1) │ void           │ _OFFSET(any fixed lenght string or _BYTE │
 │              │                │         array element)                   │
 └──────────────┴────────────────┴──────────────────────────────────────────┘
 Note: If a parameter has an asterisk (*) in front, then it's a pointer to
       the designated OpenGL variable type, rather than a value of that type.
       Those must be passed using the _OFFSET(...) notation.

 E.g.  GLuint *anyParam is actually the offset of a _UNSIGNED LONG (~&)
       variable or array, which must be passed as _OFFSET(anyVar~&) or
       _OFFSET(anyArr~&()) respectively.

  (1)  This type is regularly only used for pointers (with asterisk (*)) to
       any byte sized memory data, hence _BYTE or fixed length strings.


Description

  • OpenGL's documentation is available in several places, so we won't reproduce it here for another time.
  • The full description for this command can be found at Microsoft Docs and is also valid for QB64 usage.


See also


Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
Retrieved from "https://qb64phoenix.com/qb64wiki/index.php?title=GlTexImage2D&oldid=7078"