GL10

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

OpenGL ES 1.0 constant.

Select server-side active texture unit.

glActiveTexture selects which texture unit subsequent texture state calls will affect. The number of texture units an implementation supports is implementation dependent, it must be at least 1 for OpenGL ES 1.0, or 2 for OpenGL ES 1.1.

Notes

It is always the case that GL_TEXTUREi = GL_TEXTURE0 + i.

A texture unit consists of the texture enable state, texture matrix stack, texture environment and currently bound texture. Modifying any of these states has an effect only on the active texture unit.

Vertex arrays are client-side GL resources, which are selected by the glClientActiveTexture routine.

Errors

GL_INVALID_ENUM is generated if texture is not one of GL_TEXTUREi, where 0 <= i < GL_MAX_TEXTURE_UNITS.

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_UNITS.

Specify the alpha test function.

The alpha test discards fragments depending on the outcome of a comparison between an incoming fragment's alpha value and a constant reference value. glAlphaFunc specifies the reference value and the comparison function. The comparison is performed only if alpha testing is enabled. To enable and disable alpha testing, call glEnable and glDisable with argument GL_ALPHA_TEST. Alpha testing is initially disabled.

func and ref specify the conditions under which the pixel is drawn. The incoming alpha value is compared to ref using the function specified by func. If the value passes the comparison, the incoming fragment is drawn if it also passes subsequent stencil and depth buffer tests. If the value fails the comparison, no change is made to the frame buffer at that pixel location. The comparison functions are as follows:

• GL_NEVER
Never passes.
• GL_LESS
Passes if the incoming alpha value is less than the reference value.
• GL_EQUAL
Passes if the incoming alpha value is equal to the reference value.
• GL_LEQUAL
Passes if the incoming alpha value is less than or equal to the reference value.
• GL_GREATER
Passes if the incoming alpha value is greater than the reference value.
• GL_NOTEQUAL
Passes if the incoming alpha value is not equal to the reference value.
• GL_GEQUAL
Passes if the incoming alpha value is greater than or equal to the reference value.
• GL_ALWAYS
Always passes (initial value).

glAlphaFunc operates on all pixel write operations, including those resulting from the scan conversion of points, lines, and polygons. glAlphaFunc does not affect glClear.

Errors

GL_INVALID_ENUM is generated if func is not an accepted value.

Fixed-point version of glAlphaFunc.

Bind a named texture to a texturing target.

glBindTexture lets you create or use a named texture. Calling glBindTexture with target set to GL_TEXTURE_2D, and texture set to the name of the new texture binds the texture name to the target. When a texture is bound to a target, the previous binding for that target is automatically broken.

Texture names are unsigned integers. The value 0 is reserved to represent the default texture for each texture target. Texture names and the corresponding texture contents are local to the shared texture-object space (see eglCreateContext) of the current GL rendering context.

You may use glGenTextures to generate a set of new texture names.

While a texture is bound, GL operations on the target to which it is bound affect the bound texture. If texture mapping of the dimensionality of the target to which a texture is bound is active, the bound texture is used. In effect, the texture targets become aliases for the textures currently bound to them, and the texture name 0 refers to the default textures that were bound to them at initialization.

A texture binding created with glBindTexture remains active until a different texture is bound to the same target, or until the bound texture is deleted with glDeleteTextures.

Once created, a named texture may be re-bound to the target of the matching dimensionality as often as needed. It is usually much faster to use glBindTexture to bind an existing named texture to one of the texture targets than it is to reload the texture image using glTexImage2D.

Errors

GL_INVALID_ENUM is generated if target is not one of the allowable values.

Specify pixel arithmetic.

Pixels can be drawn using a function that blends the incoming (source) values with the values that are already in the color buffer (the destination values). Use glEnable and glDisable with argument GL_BLEND to enable and disable blending. Blending is initially disabled.

glBlendFunc defines the operation of blending when it is enabled. sfactor specifies which of eleven methods is used to scale the source color components. dfactor specifies which of ten methods is used to scale the destination color components. The eleven possible methods are described in the following table. Each method defines four scale factors, one each for red, green, blue, and alpha.

In the table and in subsequent equations, source and destination color components are referred to as (Rs, Gs, Bs, As) and (Rd, Gd, Bd, Ad). They are understood to have integer values between 0 and (kR, kG, kB, kA), where

 kc = 2mc - 1
 

Source and destination scale factors are referred to as (sR, sG, sB, sA) and (dR, dG, dB, dA). The scale factors described in the table, denoted (fR, fG, fB, fA), represent either source or destination factors. All scale factors have range [0, 1].

 Parameter               (fR, fG, fB, fA)
 
 GL_ZERO                 (0, 0, 0, 0)
 GL_ONE                  (1, 1, 1, 1)
 GL_SRC_COLOR            (Rs/kR, Gs/kG, Bs/kB, As/kA )
 GL_ONE_MINUS_SRC_COLOR  (1, 1, 1, 1) - (Rs/kR, Gs/kG, Bs/kB, As/kA)
 GL_DST_COLOR            (Rd/kR, Gd/kG, Bd/kB, Ad/kA )
 GL_ONE_MINUS_DST_COLOR  (1, 1, 1, 1) - (Rd/kR, Gd/kG, Bd/kB, Ad/kA)
 GL_SRC_ALPHA            (As/kA, As/kA, As/kA, As/kA )
 GL_ONE_MINUS_SRC_ALPHA  (1, 1, 1, 1) - (As/kA, As/kA, As/kA, As/kA)
 GL_DST_ALPHA            (Ad/kA, Ad/kA, Ad/kA, Ad/kA )
 GL_ONE_MINUS_DST_ALPHA  (1, 1, 1, 1) - (Ad/kA, Ad/kA, Ad/kA, Ad/kA)
 GL_SRC_ALPHA_SATURATE   (i, i, i, 1)
 

In the table,

 i = min(As, kA - Ad) / kA
 

To determine the blended values of a pixel, the system uses the following equations:

 Rd = min( kR, Rs sR + Rd dR )
 Gd = min( kG, Gs sG + Gd dG )
 Bd = min( kB, Bs sB + Bd dB )
 Ad = min( kA, As sA + Ad dA )
 

Despite the apparent precision of the above equations, blending arithmetic is not exactly specified, because blending operates with imprecise integer color values. However, a blend factor that should be equal to 1 is guaranteed not to modify its multiplicand, and a blend factor equal to 0 reduces its multiplicand to 0. For example, when sfactor is GL_SRC_ALPHA, dfactor is GL_ONE_MINUS_SRC_ALPHA, and As is equal to kA, the equations reduce to simple replacement:

 Rd = Rs
 Gd = Gs
 Bd = Bs
 Ad = As
 

glBlendFunc operates on all pixel write operations, including the scan conversion of points, lines, and polygons. glBlendFunc does not affect glClear.

Examples

Transparency is best implemented using glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA) with primitives sorted from farthest to nearest. Note that this transparency calculation does not require the presence of alpha bitplanes in the color buffer.

glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA) is also useful for rendering antialiased points and lines.

Notes

Errors

GL_INVALID_ENUM is generated if either sfactor or dfactor is not an accepted value.

Clear buffers to preset values.

glClear sets the bitplane area of the window to values previously selected by glClearColor, glClearDepth, and glClearStencil.

The pixel ownership test, the scissor test, dithering, and the color buffer masks affect the operation of glClear. The scissor box bounds the cleared region. Alpha function, blend function, logical operation, stenciling, texture mapping, and depth-buffering are ignored by glClear.

glClear takes a single argument that is the bitwise OR of several values indicating which buffer is to be cleared.

The values are as follows:

• GL_COLOR_BUFFER_BIT
Indicates the color buffer.
• GL_DEPTH_BUFFER_BIT
Indicates the depth buffer.
• GL_STENCIL_BUFFER_BIT
Indicates the stencil buffer.

The value to which each buffer is cleared depends on the setting of the clear value for that buffer.

Notes

If a buffer is not present, then a glClear directed at that buffer has no effect.

Errors

GL_INVALID_VALUE is generated if any bit other than the defined bits is set in mask.

Specify clear values for the color buffer.

glClearColor specifies the red, green, blue, and alpha values used by glClear to clear the color buffer. Values specified by glClearColor are clamped to the range [0, 1].

Fixed-point version of glClearColor.

Specify the clear value for the depth buffer.

glClearDepth specifies the depth value used by glClear to clear the depth buffer. Values specified by glClearDepth are clamped to the range [0, 1].

Fixed-point version of glClearDepth.

Specify the clear value for the stencil buffer.

glClearStencil specifies the index used by glClear to clear the stencil buffer. s is masked with 2^m - 1, where m is the number of bits in the stencil buffer.

Associated Gets

glGetIntegerv with argument GL_STENCIL_BITS

Select client-side active texture unit.

glClientActiveTexture selects the vertex array client state parameters to be modified by glTexCoordPointer, and enabled or disabled with glEnableClientState or glDisableClientState, respectively, when called with a parameter of GL_TEXTURE_COORD_ARRAY.

Notes

It is always the case that GL_TEXTUREi = GL_TEXTURE0 + i.

Errors

GL_INVALID_ENUM is generated if texture is not one of GL_TEXTUREi, where 0 <= i < GL_MAX_TEXTURE_UNITS.

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_UNITS

Set the current color.

The GL stores a current four-valued RGBA color. glColor sets a new four-valued RGBA color.

Current color values are stored in fixed-point or floating-point. In case the values are stored in floating-point, the mantissa and exponent sizes are unspecified.

Neither fixed-point nor floating-point values are clamped to the range [0, 1] before the current color is updated. However, color components are clamped to this range before they are interpolated or written into the color buffer.

Fixed-point version of glColor.

Enable and disable writing of color buffer components.

glColorMask specifies whether the individual components in the color buffer can or cannot be written. If red is false, for example, no change is made to the red component of any pixel in the color buffer, regardless of the drawing operation attempted, including glClear.

Changes to individual bits of components cannot be controlled. Rather, changes are either enabled or disabled for entire color components.

Define an array of colors.

glColorPointer specifies an array of color components to use when rendering. size specifies the number of components per color, and must be 4. type specifies the data type of each color component, and stride specifies the byte stride from one color to the next allowing vertices and attributes to be packed into a single array or stored in separate arrays. (Single-array storage may be more efficient on some implementations.)

When a color array is specified, size, type, stride, and pointer are saved as client-side state.

If the color array is enabled, it is used when glDrawArrays, or glDrawElements is called. To enable and disable the color array, call glEnableClientState and glDisableClientState with the argument GL_COLOR_ARRAY. The color array is initially disabled and isn't accessed when glDrawArrays or glDrawElements is called.

Use glDrawArrays to construct a sequence of primitives (all of the same type) from prespecified vertex and vertex attribute arrays. Use glDrawElements to construct a sequence of primitives by indexing vertices and vertex attributes.

Setting pointer to null releases any previously set Buffer.

Notes

glColorPointer is typically implemented on the client side.

Errors

GL_INVALID_VALUE is generated if size is not 4.

GL_INVALID_ENUM is generated if type is not an accepted value.

GL_INVALID_VALUE is generated if stride is negative.

The pointer argument must be a direct buffer with a type matching that specified by the type argument.

Specify a two-dimensional compressed texture image.

glCompressedTexImage2D defines a two-dimensional texture image in compressed format.

The supported compressed formats are paletted textures. The layout of the compressed image is a palette followed by multiple mip-levels of texture indices used for lookup into the palette. The palette format can be one of R5_G6_B5, RGBA4, RGB5_A1, RGB8, or RGBA8. The texture indices can have a resolution of 4 or 8 bits. As a result, the number of palette entries is either 16 or 256. If level is 0, only one mip-level of texture indices is described in data. Otherwise, the negative value of level specifies up to which mip-level the texture indices are described. A possibly remaining pad nibble (half byte) for the lowest resolution mip-level is ignored.

Notes

glPixelStore has no effect on compressed texture images.

glCompressedTexImage2D specifies the two-dimensional texture for the currently bound texture, specified with glBindTexture, and the current texture unit, specified with glActiveTexture.

Errors

GL_INVALID_ENUM is generated if target is not GL_TEXTURE_2D.

GL_INVALID_VALUE may be generated if level is greater than 0 or the absolute value of level is greater than log_2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.

(1.0) GL_INVALID_VALUE is generated if internalformat is not one of the accepted symbolic constants.

(1.1) GL_INVALID_ENUM is generated if internalformat is not one of the accepted symbolic constants.

GL_INVALID_VALUE is generated if width or height is less than 0 or greater than 2 + GL_MAX_TEXTURE_SIZE, or if either cannot be represented as 2^k + 2*border for some integer k.

GL_INVALID_VALUE is generated if border is not 0.

GL_INVALID_VALUE is generated if imageSize is not consistent with format, dimentions, and contents of the compressed image.

Specify a two-dimensional compressed texture subimage.

glCompressedTexSubImage2D redefines a contiguous subregion of an existing two-dimensional compressed texture image. The texels referenced by pixels replace the portion of the existing texture array with x indices xoffset and xoffset + width - 1, inclusive, and y indices yoffset and yoffset + height - 1, inclusive. This region may not include any texels outside the range of the texture array as it was originally specified. It is not an error to specify a subtexture with zero width or height, but such a specification has no effect.

Currently, there is no supported compressed format for this function.

Notes

glPixelStore has no effect on compressed texture images.

glCompressedTexSubImage2D specifies the two-dimensional sub texture for the currently bound texture, specified with glBindTexture, and the current texture unit, specified with glActiveTexture.

Errors

GL_INVALID_ENUM is generated if target is not GL_TEXTURE_2D.

GL_INVALID_OPERATION is generated if the texture array has not been defined by a previous glCompressedTexImage2D operation.

GL_INVALID_VALUE is generated if level is less than 0.

GL_INVALID_VALUE may be generated if level is greater than log2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.

GL_INVALID_VALUE is generated if xoffset < -b, xoffset + width > (w - b), yoffset < -b, or yoffset + height > (h - b) , where w is the texture width, h is the texture height, and b is the border of the texture image being modified. Note that w and h include twice the border width.

GL_INVALID_VALUE is generated if width or height is less than 0.

GL_INVALID_ENUM is generated if type is not a type constant.

GL_INVALID_OPERATION is generated if type is GL_UNSIGNED_SHORT_5_6_5 and format is not GL_RGB.

GL_INVALID_OPERATION is generated if type is one of GL_UNSIGNED_SHORT_4_4_4_4, or GL_UNSIGNED_SHORT_5_5_5_1 and format is not GL_RGBA.

GL_INVALID_OPERATION is generated if none of the above error conditions apply.

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_SIZE

Specify a two-dimensional texture image with pixels from the color buffer.

glCopyTexImage2D defines a two-dimensional texture image with pixels from the color buffer.

The screen-aligned pixel rectangle with lower left corner at ( x, y) and with a width of width + 2*border and a height of height + 2* border defines the texture array at the mipmap level specified by level. internalformat specifies the color components of the texture.

The red, green, blue, and alpha components of each pixel that is read are converted to an internal fixed-point or floating-point format with unspecified precision. The conversion maps the largest representable component value to 1.0, and component value 0 to 0.0. The values are then converted to the texture's internal format for storage in the texel array.

internalformat must be chosen such that color buffer components can be dropped during conversion to the internal format, but new components cannot be added. For example, an RGB color buffer can be used to create LUMINANCE or RGB textures, but not ALPHA, LUMINANCE_ALPHA or RGBA textures.

Pixel ordering is such that lower x and y screen coordinates correspond to lower s and t texture coordinates.

If any of the pixels within the specified rectangle of the color buffer are outside the window associated with the current rendering context, then the values obtained for those pixels are undefined.

Notes

An image with height or width of 0 indicates a null-texture.

Errors

GL_INVALID_ENUM is generated if target is not GL_TEXTURE_2D.

GL_INVALID_OPERATION is generated if internalformat is not compatible with the color buffer format.

GL_INVALID_VALUE is generated if level is less than 0.

GL_INVALID_VALUE may be generated if level is greater than log_2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.

GL_INVALID_VALUE is generated if width or height is less than 0, greater than GL_MAX_TEXTURE_SIZE, or if width or height cannot be represented as 2^k + 2* border for some integer k.

GL_INVALID_VALUE is generated if border is not 0.

(1.0) GL_INVALID_VALUE is generated if internalformat is not an accepted constant.

(1.1) GL_INVALID_ENUM is generated if internalformat is not an accepted constant.

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_SIZE

Specify a two-dimensional texture subimage with pixels from the color buffer.

glCopyTexSubImage2D replaces a rectangular portion of a two-dimensional texture image with pixels from the color buffer.

The screen-aligned pixel rectangle with lower left corner at ( x, y) and with width width and height height replaces the portion of the texture array with x indices xoffset through xoffset + width - 1, inclusive, and y indices yoffset through yoffset + height - 1, inclusive, at the mipmap level specified by level.

The pixels in the rectangle are processed the same way as with glCopyTexImage2D.

glCopyTexSubImage2D requires that the internal format of the currently bound texture is such that color buffer components can be dropped during conversion to the internal format, but new components cannot be added. For example, an RGB color buffer can be used to create LUMINANCE or RGB textures, but not ALPHA, LUMINANCE_ALPHA or RGBA textures.

The destination rectangle in the texture array may not include any texels outside the texture array as it was originally specified. It is not an error to specify a subtexture with zero width or height, but such a specification has no effect.

If any of the pixels within the specified rectangle of the current color buffer are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined.

No change is made to the internalformat, width, height, or border parameters of the specified texture array or to texel values outside the specified subregion.

Errors

GL_INVALID_ENUM is generated if target is not GL_TEXTURE_2D.

GL_INVALID_OPERATION is generated if the texture array has not been defined by a previous glTexImage2D or glCopyTexImage2D operation or if the internal format of the currently bound texture is not compatible with the color buffer format.

GL_INVALID_VALUE is generated if level is less than 0.

GL_INVALID_VALUE may be generated if level is greater than log_2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.

GL_INVALID_VALUE is generated if x < -b, or y < -b, where b is the border of the texture being modified.

GL_INVALID_VALUE is generated if xoffset < -b, xoffset + width > (w - b) , yoffset < -b, or yoffset + height > (h - b) , where w is the texture width, h is the texture height, and b is the border of the texture image being modified. Note that w and h include twice the border width.

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_SIZE

Specify whether front- or back-facing polygons are culled.

glCullFace specifies whether front- or back-facing polygons are culled (as specified by mode) when culling is enabled. To enable and disable culling, call glEnable and glDisable with argument GL_CULL_FACE. Culling is initially disabled.

glFrontFace specifies which of the clockwise and counterclockwise polygons are front-facing and back-facing.

Notes

If mode is GL_FRONT_AND_BACK, no polygons are drawn, but other primitives such as points and lines are drawn.

Errors

GL_INVALID_ENUM is generated if mode is not an accepted value.

Integer Buffer version of glDeleteTextures.

Delete named textures.

glDeleteTextures deletes n textures named by the elements of the array textures. After a texture is deleted, it has no contents or dimensionality, and its name is free for reuse (for example by glGenTextures). If a texture that is currently bound is deleted, the binding reverts to 0 (the default texture).

glDeleteTextures silently ignores 0's and names that do not correspond to existing textures.

Errors

GL_INVALID_VALUE is generated if n is negative.

Specify the value used for depth buffer comparisons.

glDepthFunc specifies the function used to compare each incoming pixel depth value with the depth value present in the depth buffer. The comparison is performed only if depth testing is enabled. To enable and disable depth testing, call glEnable and glDisable with argument GL_DEPTH_TEST. Depth testing is initially disabled.

func specifies the conditions under which the pixel will be drawn. The comparison functions are as follows:

• GL_NEVER
Never passes.
• GL_LESS
Passes if the incoming depth value is less than the stored depth value.
• GL_EQUAL
Passes if the incoming depth value is equal to the stored depth value.
• GL_LEQUAL
Passes if the incoming depth value is less than or equal to the stored depth value.
• GL_GREATER
Passes if the incoming depth value is greater than the stored depth value.
• GL_NOTEQUAL
Passes if the incoming depth value is not equal to the stored depth value.
• GL_GEQUAL
Passes if the incoming depth value is greater than or equal to the stored depth value.
• GL_ALWAYS
Always passes.

The initial value of func is GL_LESS. Initially, depth testing is disabled. Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled.

Errors

GL_INVALID_ENUM is generated if func is not an accepted value.

Enable or disable writing into the depth buffer.

glDepthMask specifies whether the depth buffer is enabled for writing. If flag is false, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled.

1.0 Notes

glDepthMask does not affect glClear.

Specify mapping of depth values from normalized device coordinates to window coordinates.

After clipping and division by w, depth coordinates range from -1 to 1, corresponding to the near and far clipping planes. glDepthRange specifies a linear mapping of the normalized depth coordinates in this range to window depth coordinates. Regardless of the actual depth buffer implementation, window coordinate depth values are treated as though they range from 0 through 1 (like color components). Thus, the values accepted by glDepthRange are both clamped to this range before they are accepted.

The setting of (0, 1) maps the near plane to 0 and the far plane to 1. With this mapping, the depth buffer range is fully utilized.

Notes

It is not necessary that near be less than far. Reverse mappings such as near = 1, and far = 0 are acceptable.

Fixed-point version of glDepthRange.

Disable server-side GL capabilities.

Disable client-side capability.

Render primitives from array data.

glDrawArrays specifies multiple geometric primitives with very few subroutine calls. You can prespecify separate arrays of vertices, normals, colors, and texture coordinates and use them to construct a sequence of primitives with a single call to glDrawArrays.

When glDrawArrays is called, it uses count sequential elements from each enabled array to construct a sequence of geometric primitives, beginning with element first. mode specifies what kind of primitives are constructed, and how the array elements construct those primitives. If GL_VERTEX_ARRAY is not enabled, no geometric primitives are generated.

Vertex attributes that are modified by glDrawArrays have an unspecified value after glDrawArrays returns. For example, if GL_COLOR_ARRAY is enabled, the value of the current color is undefined after glDrawArrays executes. Attributes that aren't modified remain well defined.

Errors

GL_INVALID_ENUM is generated if mode is not an accepted value.

GL_INVALID_VALUE is generated if count is negative.

Render primitives from array data.

glDrawElements specifies multiple geometric primitives with very few subroutine calls. You can prespecify separate arrays of vertices, normals, colors, and texture coordinates and use them to construct a sequence of primitives with a single call to glDrawElements.

When glDrawElements is called, it uses count sequential indices from indices to lookup elements in enabled arrays to construct a sequence of geometric primitives. mode specifies what kind of primitives are constructed, and how the array elements construct these primitives. If GL_VERTEX_ARRAY is not enabled, no geometric primitives are constructed.

Vertex attributes that are modified by glDrawElements have an unspecified value after glDrawElements returns. For example, if GL_COLOR_ARRAY is enabled, the value of the current color is undefined after glDrawElements executes. Attributes that aren't modified maintain their previous values.

Errors

GL_INVALID_ENUM is generated if mode is not an accepted value.

GL_INVALID_ENUM is generated if type is not an accepted value.

GL_INVALID_VALUE is generated if count is negative.

Enable server-side GL capabilities.

glEnable and glDisable enable and disable various capabilities. The initial value for each capability with the exception of GL_DITHER and GL_MULTISAMPLE is GL_FALSE. The initial value for GL_DITHER and GL_MULTISAMPLE is GL_TRUE.

Both glEnable and glDisable take a single argument, cap, which can assume one of the following values:

• GL_ALPHA_TEST

If enabled, do alpha testing. See glAlphaFunc.

• GL_BLEND

If enabled, blend the incoming color values with the values in the color buffers. See glBlendFunc.

• GL_COLOR_LOGIC_OP

If enabled, apply the currently selected logical operation to the incoming color and color buffer values. See glLogicOp.

• GL_COLOR_MATERIAL

If enabled, have ambient and diffuse material parameters track the current color.

• GL_CULL_FACE

If enabled, cull polygons based on their winding in window coordinates. See glCullFace.

• GL_DEPTH_TEST

If enabled, do depth comparisons and update the depth buffer. Note that even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. See glDepthFunc, glDepthMask, and glDepthRange.

• GL_DITHER

If enabled, dither color components or indices before they are written to the color buffer.

• GL_FOG

If enabled, blend a fog color into the posttexturing color. See glFog.

• GL_LIGHTi

If enabled, include light i in the evaluation of the lighting equation. See glLightModel and glLight.

• GL_LIGHTING

If enabled, use the current lighting parameters to compute the vertex color. Otherwise, simply associate the current color with each vertex. See glMaterial, glLightModel, and glLight.

• GL_LINE_SMOOTH

If enabled, draw lines with correct filtering. Otherwise, draw aliased lines. See glLineWidth.

• GL_MULTISAMPLE

If enabled, perform multisampling of fragments for single-pass antialiasing and other effects. See glSampleCoverage.

• GL_NORMALIZE

If enabled, normal vectors are scaled to unit length after transformation. See glNormal and glNormalPointer.

• GL_POINT_SMOOTH

If enabled, draw points with proper filtering. Otherwise, draw aliased points. See glPointSize.

• GL_POLYGON_OFFSET_FILL

If enabled, an offset is added to depth values of a polygon's fragments before the depth comparison is performed. See glPolygonOffset.

• GL_RESCALE_NORMAL

If enabled, normal vectors are scaled by a factor derived from the modelview matrix. See glNormal and glNormalPointer.

• GL_SAMPLE_ALPHA_TO_MASK (1.0 only)

If enabled, convert fragment alpha values to multisample coverage modification masks. See glSampleCoverage.

• GL_SAMPLE_ALPHA_TO_COVERAGE (1.1 only)

If enabled, a temporary coverage value is generated where each bit is determined by the alpha value at the corresponding sample location. The temporary coverage value is then ANDed with the fragment coverage value. Otherwise the fragment coverage value is unchanged at this point. See glSampleCoverage.

• GL_SAMPLE_ALPHA_TO_ONE

If enabled, set fragment alpha to the maximum permissible value after computing multisample coverage modification masks. See glSampleCoverage.

• GL_SAMPLE_MASK (1.0 only)

If enabled, apply a mask to modify fragment coverage during multisampling. See glSampleCoverage.

• GL_SAMPLE_COVERAGE (1.1 only)

If enabled, the fragment coverage is ANDed with another temporary coverage. This temporary coverage is generated in the same manner as for GL_SAMPLE_ALPHA_TO_COVERAGE described above, but as a function of the value of GL_SAMPLE_COVERAGE_VALUE. If GL_SAMPLE_COVERAGE_INVERT is GL_TRUE, the temporary coverage is inverted (all bit values are inverted) before it is ANDed with the fragment coverage. See glSampleCoverage.

• GL_SCISSOR_TEST

If enabled, discard fragments that are outside the scissor rectangle. See glScissor.

• GL_STENCIL_TEST

If enabled, do stencil testing and update the stencil buffer. See glStencilFunc, glStencilMask, and glStencilOp.

• GL_TEXTURE_2D

If enabled, two-dimensional texturing is performed for the active texture unit. See glActiveTexture, glTexImage2D, glCompressedTexImage2D, and glCopyTexImage2D.

• GL_CLIP_PLANEi (1.1 only)

If enabled, clipping plane i is enabled. See glClipPlane.

• GL_POINT_SPRITE_OES (1.1 + OES_point_sprite extension)

If enabled, point sprites are enabled. See glPointSize and glTexEnv.

Errors

GL_INVALID_ENUM is generated if cap is not one of the values listed previously.

Enable client-side capability.

glEnableClientState and glDisableClientState enable or disable individual client-side capabilities. By default, all client-side capabilities are disabled. Both glEnableClientState and glDisableClientState take a single argument, array, which can assume one of the following values:

• GL_COLOR_ARRAY

If enabled, the color array is enabled for writing and used during rendering when glDrawArrays, or glDrawElements is called. See glColorPointer.

• GL_NORMAL_ARRAY

If enabled, the normal array is enabled for writing and used during rendering when glDrawArrays, or glDrawElements is called. See glNormalPointer.

• GL_TEXTURE_COORD_ARRAY

If enabled, the texture coordinate array is enabled for writing and used during rendering when glDrawArrays, or glDrawElements is called. See glTexCoordPointer.

• GL_VERTEX_ARRAY

If enabled, the vertex array is enabled for writing and used during rendering when glDrawArrays, or glDrawElements is called. See glVertexPointer.

• GL_POINT_SIZE_ARRAY_OES ( OES_point_size_array extension)

If enabled, the point size array controls the sizes used to render points and point sprites. In this case the point size defined by glPointSize is ignored. The point sizes supplied in the point size arrays will be the sizes used to render both points and point sprites. See glPointSize.

Notes

Enabling and disabling GL_TEXTURE_COORD_ARRAY affects the active client texture unit. The active client texture unit is controlled with glClientActiveTexture.

Errors

GL_INVALID_ENUM is generated if array is not an accepted value.

Block until all GL execution is complete.

glFinish does not return until the effects of all previously called GL commands are complete. Such effects include all changes to GL state, all changes to connection state, and all changes to the frame buffer contents.

Notes

glFinish requires a round trip to the server.

Force execution of GL commands in finite time.

Different GL implementations buffer commands in several different locations, including network buffers and the graphics accelerator itself. glFlush empties all of these buffers, causing all issued commands to be executed as quickly as they are accepted by the actual rendering engine. Though this execution may not be completed in any particular time period, it does complete in finite time.

Because any GL program might be executed over a network, or on an accelerator that buffers commands, all programs should call glFlush whenever they count on having all of their previously issued commands completed. For example, call glFlush before waiting for user input that depends on the generated image.

Notes

glFlush can return at any time. It does not wait until the execution of all previously issued GL commands is complete.

Specify fog parameters.

If fog is enabled, fog affects rasterized geometry, bitmaps, and pixel blocks, but not buffer clear operations. To enable and disable fog, call glEnable and glDisable with argument GL_FOG. Fog is initially disabled.

glFog assigns the value in param to the fog parameter specified by pname. The following values are accepted for pname:

• GL_FOG_MODE

param is a single value that specifies the equation to be used to compute the fog blend factor f. Three symbolic constants are accepted: GL_LINEAR, GL_EXP, and GL_EXP2. The equations corresponding to these symbolic constants are defined below. The initial fog mode is GL_EXP.

• GL_FOG_DENSITY

param is a single value that specifies density, the fog density used in both exponential fog equations. Only nonnegative densities are accepted. The initial fog density is 1.

• GL_FOG_START

param is a single value that specifies start, the near distance used in the linear fog equation. The initial near distance is 0.

• GL_FOG_END

param is a single value that specifies end, the far distance used in the linear fog equation. The initial far distance is 1.

Errors

GL_INVALID_ENUM is generated if pname is not an accepted value, or if pname is GL_FOG_MODE and param is not an accepted value.

GL_INVALID_VALUE is generated if pname is GL_FOG_DENSITY, and param is negative.

Floating-point Buffer version of glFog.

Specify fog parameters (array version).

If fog is enabled, fog affects rasterized geometry, bitmaps, and pixel blocks, but not buffer clear operations. To enable and disable fog, call glEnable and glDisable with argument GL_FOG. Fog is initially disabled.

glFog assigns the value or values in params to the fog parameter specified by pname. The following values are accepted for pname:

• GL_FOG_MODE

params contains a single value that specifies the equation to be used to compute the fog blend factor f. Three symbolic constants are accepted: GL_LINEAR, GL_EXP, and GL_EXP2. The equations corresponding to these symbolic constants are defined below. The initial fog mode is GL_EXP.

• GL_FOG_DENSITY

params contains a single value that specifies density, the fog density used in both exponential fog equations. Only nonnegative densities are accepted. The initial fog density is 1.

• GL_FOG_START

params contains a single value that specifies start, the near distance used in the linear fog equation. The initial near distance is 0.

• GL_FOG_END

params contains a single value that specifies end, the far distance used in the linear fog equation. The initial far distance is 1.

• GL_FOG_COLOR

params contains four values that specify Cf, the fog color. Both fixed-point and floating-point values are mapped directly. After conversion, all color components are clamped to the range [0, 1]. The initial fog color is (0, 0, 0, 0).

Fog blends a fog color with each rasterized pixel fragment's posttexturing color using a blending factor f. Factor f is computed in one of three ways, depending on the fog mode. Let z be the distance in eye coordinates from the origin to the fragment being fogged. The equation for GL_LINEAR fog is

 f = (end - z) / (end - start)
 

The equation for GL_EXP fog is

 f = e - (density - z)
 

The equation for GL_EXP2 fog is

 f = e -(density - z)2
 

Regardless of the fog mode, f is clamped to the range [0, 1] after it is computed. Then, the fragment's red, green, and blue colors, represented by Cr, are replaced by:

 C'r = f Cr + (1 - f) Cf
 

Fog does not affect a fragment's alpha component.

Errors

GL_INVALID_ENUM is generated if pname is not an accepted value, or if pname is GL_FOG_MODE and params is not an accepted value.

GL_INVALID_VALUE is generated if pname is GL_FOG_DENSITY, and the first value in params is negative.

Fixed-point version of glFog.

Fixed-point array version of glFog.

Fixed-point Buffer version of glFog.

Define front- and back-facing polygons.

In a scene composed entirely of opaque closed surfaces, back-facing polygons are never visible. Eliminating (culling) these invisible polygons has the obvious benefit of speeding up the rendering of the image. To enable and disable culling, call glEnable and glDisable with argument GL_CULL_FACE. Culling is initially disabled.

The projection of a polygon to window coordinates is said to have clockwise winding if an imaginary object following the path from its first vertex, its second vertex, and so on, to its last vertex, and finally back to its first vertex, moves in a clockwise direction about the interior of the polygon. The polygon's winding is said to be counterclockwise if the imaginary object following the same path moves in a counterclockwise direction about the interior of the polygon. glFrontFace specifies whether polygons with clockwise winding in window coordinates, or counterclockwise winding in window coordinates, are taken to be front-facing. Passing GL_CCW to mode selects counterclockwise polygons as front-facing. GL_CW selects clockwise polygons as front-facing. By default, counterclockwise polygons are taken to be front-facing.

Errors

GL_INVALID_ENUM is generated if mode is not an accepted value.

Multiply the current matrix by a perspective matrix.

glFrustum describes a perspective matrix that produces a perspective projection. The current matrix (see glMatrixMode ) is multiplied by this matrix and the result replaces the current matrix, as if glMultMatrix were called with the following matrix as its argument:

 ( 2/(right - left)        0            A        0 )
 ( 0                2/(top - bottom)    B        0 )
 ( 0                       0            C        D )
 ( 0                       0           -1        0 )
 

where

 A = - (right + left)/(right - left)
 B = - (top + bottom)/(top - bottom)
 C = - (far + near)/(far - near)
 D = - 2farnear/(far - near)
 

Typically, the matrix mode is GL_PROJECTION, and ( left, bottom, -near) and ( right, top, -near) specify the points on the near clipping plane that are mapped to the lower left and upper right corners of the window, assuming that the eye is located at (0, 0, 0). -far specifies the location of the far clipping plane. Both near and far must be positive.

Use glPushMatrix and glPopMatrix to save and restore the current matrix stack.

Notes

Depth buffer precision is affected by the values specified for near and far. The greater the ratio of far to near is, the less effective the depth buffer will be at distinguishing between surfaces that are near each other. If

 r = far / near
 

Errors

GL_INVALID_VALUE is generated if near or far is not positive, or if left = right, or bottom = top.

Fixed-point version of glFrustum.

Integer Buffer version of glGenTextures.

Generate texture names.

glGenTextures returns n texture names in textures. There is no guarantee that the names form a contiguous set of integers. However, it is guaranteed that none of the returned names was in use immediately before the call to glGenTextures.

The generated textures have no dimensionality; they assume the dimensionality of the texture target to which they are first bound (see glBindTexture).

Texture names returned by a call to glGenTextures are not returned by subsequent calls, unless they are first deleted with glDeleteTextures.

Errors

GL_INVALID_VALUE is generated if n is negative.

Return error information.

glGetError returns the value of the error flag. Each detectable error is assigned a numeric code and symbolic name. When an error occurs, the error flag is set to the appropriate error code value. No other errors are recorded until glGetError is called, the error code is returned, and the flag is reset to GL_NO_ERROR . If a call to glGetError returns GL_NO_ERROR, there has been no detectable error since the last call to glGetError, or since the GL was initialized.

To allow for distributed implementations, there may be several error flags. If any single error flag has recorded an error, the value of that flag is returned and that flag is reset to GL_NO_ERROR when glGetError is called. If more than one flag has recorded an error, glGetError returns and clears an arbitrary error flag value. Thus, glGetError should always be called in a loop, until it returns GL_NO_ERROR, if all error flags are to be reset.

Initially, all error flags are set to GL_NO_ERROR.

The following errors are currently defined:

• GL_NO_ERROR

No error has been recorded. The value of this symbolic constant is guaranteed to be 0.

• GL_INVALID_ENUM

An unacceptable value is specified for an enumerated argument. The offending command is ignored, and has no other side effect than to set the error flag.

• GL_INVALID_VALUE

A numeric argument is out of range. The offending command is ignored, and has no other side effect than to set the error flag.

• GL_INVALID_OPERATION

The specified operation is not allowed in the current state. The offending command is ignored, and has no other side effect than to set the error flag.

• GL_STACK_OVERFLOW

This command would cause a stack overflow. The offending command is ignored, and has no other side effect than to set the error flag.

• GL_STACK_UNDERFLOW

This command would cause a stack underflow. The offending command is ignored, and has no other side effect than to set the error flag.

• GL_OUT_OF_MEMORY

There is not enough memory left to execute the command. The state of the GL is undefined, except for the state of the error flags, after this error is recorded.

When an error flag is set, results of a GL operation are undefined only if GL_OUT_OF_MEMORY has occurred. In all other cases, the command generating the error is ignored and has no effect on the GL state or frame buffer contents. If the generating command returns a value, it returns 0. If glGetError itself generates an error, it returns 0.

Return the value or values of a selected parameter.

glGet returns values for static state variables in GL. pname is a symbolic constant indicating the static state variable to be returned, and params is an array of integers in which to place the returned data.

A boolean value is interpreted as either 1 or 0, and a floating-point value is rounded to the nearest integer, unless the value is an RGBA color component, a DepthRange value, a depth buffer clear value, or a normal coordinate. In these cases, the glGet command does a linear mapping that maps 1.0 to the most positive representable integer value, and -1.0 to the most negative representable integer value.

In OpenGL ES 1.0, on glGetIntegerv is provided. OpenGL ES 1.1 additionally provides glGetBooleanv, glGetFixedv, and glGetFloatv.

The following symbolic constants are accepted by pname:

• GL_ALIASED_POINT_SIZE_RANGE

params returns two values, the smallest and largest supported sizes for aliased points. The range must include 1. See glPointSize.

• GL_ALIASED_LINE_WIDTH_RANGE

params returns two values, the smallest and largest supported widths for aliased lines. The range must include 1. See glLineWidth.

• GL_ALPHA_BITS

params returns one value, the number of alpha bitplanes in the color buffer.

• GL_ALPHA_TEST_FUNC (1.1 only)

params returns one value, the symbolic name of the alpha test function. See glAlphaFunc.

• GL_ALPHA_TEST_REF (1.1 only)

params returns one value, the reference value for the alpha test. An integer value, if requested, is linearly mapped from the internal floating-point representation such that 1.0 returns the most positive representable integer value, and -1.0 returns the most negative representable integer value. See glAlphaFunc.

• GL_BLEND_DST (1.1 only)

params returns one value, the symbolic constant identifying the destination blend function set by glBlendFunc, or the destination RGB blend function set by glBlendFuncSeparate. See glBlendFunc and glBlendFuncSeparate.

• GL_BLUE_BITS

params returns one value, the number of blue bitplanes in the color buffer.

• GL_COLOR_ARRAY_BUFFER_BINDING (1.1 only)

params returns one value, the color array buffer binding. See glColorPointer.

• GL_COLOR_ARRAY_SIZE (1.1 only)

params returns one value, the number of components per color in the color array. See glColorPointer.

• GL_COLOR_ARRAY_STRIDE (1.1 only)

params returns one value, the byte offset between consecutive colors in the color array. See glColorPointer.

• GL_COLOR_ARRAY_TYPE (1.1 only)

params returns one value, returns the data type of each component in the color array. See glColorPointer.

• GL_COLOR_CLEAR_VALUE (1.1 only)

params returns four values: the red, green, blue, and alpha values used to clear the color buffers. See glClearColor

• GL_COLOR_WRITEMASK (1.1 only)

params returns four boolean values: the red, green, blue, and alpha write enables for the color buffers. See glColorMask.

• GL_COMPRESSED_TEXTURE_FORMATS

params returns GL_NUM_COMPRESSED_TEXTURE_FORMATS values, the supported compressed texture formats. See glCompressedTexImage2D and glCompressedTexSubImage2D.

• GL_CULL_FACE (1.1 only)

params returns one value, a symbolic constant indicating which polygon faces are to be culled. See glCullFace.

• GL_DEPTH_BITS

params returns one value, the number of bitplanes in the depth buffer.

• GL_DEPTH_CLEAR_VALUE (1.1 only)

params returns one value, the value that is used to clear the depth buffer. See glClearDepth.

• GL_DEPTH_FUNC (1.1 only)

params returns one value, the symbolic name of the depth comparision function. See glDepthFunc.

• GL_DEPTH_RANGE (1.1 only)

params returns two values: the near and far mapping limits for the depth buffer. See glDepthRange.

• GL_DEPTH_WRITEMASK (1.1 only)

params returns a single boolean value indicating if the depth buffer is enabled for writing. See glDepthMask.

• GL_FOG_COLOR (1.1 only)

params returns four values: the red, green, blue, and alpha components of the fog color. See glFog.

• GL_FOG_DENSITY (1.1 only)

params returns one value, the fog density parameter. See glFog.

• GL_FOG_END (1.1 only)

params returns one value, the end factor for the linear fog equation. See glFog.

• GL_FOG_HINT (1.1 only)

params returns one value, a symbolic constant indicating the mode of the fog hint. See glHint.

• GL_FOG_MODE (1.1 only)

params returns one value, a symbolic constant indicating which fog equation is selected. See glFog.

• GL_FOG_START (1.1 only)

params returns one value, the start factor for the linear fog equation. See glFog.

• GL_FRONT_FACE (1.1 only)

params returns one value, a symbolic constant indicating whether clockwise or counterclockwise polygon winding is treated as front-facing. See glFrontFace.

• GL_GREEN_BITS

params returns one value, the number of green bitplanes in the color buffer.

• GL_IMPLEMENTATION_COLOR_READ_FORMAT_OES ( OES_read_format extension)

params returns one value, the preferred format for pixel read back. See glReadPixels.

• GL_IMPLEMENTATION_COLOR_READ_TYPE_OES ( ( OES_read_format extension)

params returns one value, the preferred type for pixel read back. See glReadPixels.

• GL_LIGHT_MODEL_AMBIENT (1.1 only)

params returns four values: the red, green, blue, and alpha components of the ambient intensity of the entire scene. See glLightModel.

• GL_LIGHT_MODEL_TWO_SIDE (1.1 only)

params returns a single boolean value indicating whether separate materials are used to compute lighting for front and back facing polygons. See glLightModel.

• GL_LINE_SMOOTH_HINT (1.1 only)

params returns one value, a symbolic constant indicating the mode of the line antialiasing hint. See glHint.

• GL_LINE_WIDTH (1.1 only)

params returns one value, the line width as specified with glLineWidth.

• GL_LOGIC_OP_MODE (1.1 only)

params returns one value, a symbolic constant indicating the selected logic operation mode. See glLogicOp.

• GL_MATRIX_INDEX_ARRAY_BUFFER_BINDING_OES ( OES_matrix_palette extension)

params returns one value, the matrix index array buffer binding. See glMatrixIndexPointer.

• GL_MATRIX_INDEX_ARRAY_SIZE_OES ( OES_matrix_palette extension)

params returns one value, the number of matrix indices per vertex. See glMatrixIndexPointer.

• GL_MATRIX_INDEX_ARRAY_STRIDE_OES ( OES_matrix_palette extension)

params returns one value, the byte offset between matrix indices. See glMatrixIndexPointer.

• GL_MATRIX_INDEX_ARRAY_TYPE_OES ( OES_matrix_palette extension)

params returns one value, the data type of each matrix index in the matrix indices array. See glMatrixIndexPointer.

• GL_MATRIX_MODE (1.1 only)

params returns one value, a symbolic constant indicating which matrix stack is currently the target of all matrix operations. See glMatrixMode.

• GL_MAX_CLIP_PLANES (1.1 only)

params returns one value, the maximum number of application defined clipping planes. The value must be at least 6. See glClipPlane.

• GL_MAX_ELEMENTS_INDICES

params returns one value, the recommended maximum number of vertex array indices. See glDrawElements.

• GL_MAX_ELEMENTS_VERTICES

params returns one value, the recommended maximum number of vertex array vertices. See glDrawArrays and glDrawElements.

• GL_MAX_LIGHTS

params returns one value, the maximum number of lights. The value must be at least 8. See glLight.

• GL_MAX_MODELVIEW_STACK_DEPTH

params returns one value, the maximum supported depth of the modelview matrix stack. The value must be at least 16. See glPushMatrix.

• GL_MAX_PALETTE_MATRICES_OES ( OES_matrix_palette extension)

params returns the size of the matrix palette. The initial value is 9.

• GL_MAX_PROJECTION_STACK_DEPTH

params returns one value, the maximum supported depth of the projection matrix stack. The value must be at least 2. See glPushMatrix.

• GL_MAX_TEXTURE_SIZE

params returns one value. The value gives a rough estimate of the largest texture that the GL can handle. The value must be at least 64. See glTexImage2D, glCompressedTexImage2D, and glCopyTexImage2D.

• GL_MAX_TEXTURE_STACK_DEPTH

params returns one value, the maximum supported depth of the texture matrix stack. The value must be at least 2. See glPushMatrix.

• GL_MAX_TEXTURE_UNITS

params returns a single value indicating the number of texture units supported. The value must be at least 1. See glActiveTexture, glClientActiveTexture and glMultiTexCoord.

• GL_MAX_VERTEX_UNITS_OES

  params returns the number of matrices per vertex. The initial value is 3.

• GL_MAX_VIEWPORT_DIMS

params returns two values: the maximum supported width and height of the viewport. These must be at least as large as the visible dimensions of the display being rendered to. See glViewport.

• GL_MODELVIEW_MATRIX (1.1 only)

params returns sixteen values: the modelview matrix on the top of the modelview matrix stack. See glPushMatrix.

• GL_MODELVIEW_MATRIX_FLOAT_AS_INT_BITS_OES ( OES_matrix_get extension)

params returns a representation of the floating point Model View matrix elements as as an array of integers, according to the IEEE 754 floating point "single format" bit layout. See glMatrixMode.

• GL_MODELVIEW_STACK_DEPTH (1.1 only)

params returns one value, the number of matrices on the modelview matrix stack. See glPushMatrix.

• GL_NORMAL_ARRAY_BUFFER_BINDING (1.1 only)

params returns one value, the normal array buffer binding. See glNormalPointer.

• GL_NORMAL_ARRAY_STRIDE (1.1 only)

params returns one value, the byte offset between consective normals in the normal array. See glNormalPointer.

• GL_NORMAL_ARRAY_TYPE (1.1 only)

params returns one value, the data type of each normal in the normal array. See glNormalPointer.

• GL_NUM_COMPRESSED_TEXTURE_FORMATS

params returns one value, the number of supported compressed texture formats. The value must be at least 10. See glCompressedTexImage2D and glCompressedTexSubImage2D.

• GL_PACK_ALIGNMENT (1.1 only)

params returns one value, the byte alignment used for writing pixel data to memory. See glPixelStore.

• GL_PERSPECTIVE_CORRECTION_HINT (1.1 only)

params returns one value, a symbolic constant indicating the mode of the perspective correction hint. See glHint.

• GL_POINT_SIZE (1.1 only)

params returns one value, the point size as specified by glPointSize.

• GL_POINT_SIZE_ARRAY_BUFFER_BINDING_OES ( OES_point_size_array extension)

params returns one value, the point size array buffer binding. See glPointSizePointer.

• GL_POINT_SIZE_ARRAY_STRIDE_OES ( OES_point_size_array extension)

params returns one value, the byte offset between consecutive point sizes in the point size array. See glPointSizePointer.

• GL_POINT_SIZE_ARRAY_TYPE_OES ( OES_point_size_array extension)

params returns one value, the data type of each point size in the point array. See glPointSizePointer.

• GL_POINT_SMOOTH_HINT (1.1 only)

params returns one value, a symbolic constant indicating the mode of the point antialiasing hint. See glHint.

• GL_POLYGON_OFFSET_FACTOR (1.1 only)

params returns one value, the scaling factor used to determine the variable offset that is added to the depth value of each fragment generated when a polygon is rasterized. See glPolygonOffset.

• GL_POLYGON_OFFSET_UNITS (1.1 only)

params returns one value. This value is multiplied by an implementation-specific value and then added to the depth value of each fragment generated when a polygon is rasterized. See glPolygonOffset.

• GL_PROJECTION_MATRIX (1.1 only)

params returns sixteen values: the projection matrix on the top of the projection matrix stack. See glPushMatrix.

• GL_PROJECTION_MATRIX_FLOAT_AS_INT_BITS_OES ( OES_matrix_get extension)

params returns a representation of the floating point Projection matrix elements as as an array of integers, according to the IEEE 754 floating point "single format" bit layout. See glMatrixMode.

• GL_PROJECTION_STACK_DEPTH (1.1 only)

params returns one value, the number of matrices on the projection matrix stack. See glPushMatrix.

• GL_RED_BITS

params returns one value, the number of red bitplanes in each color buffer.

• GL_SCISSOR_BOX (1.1 only)

params returns four values: the x and y window coordinates of the scissor box, followed by its width and height. See glScissor.

• GL_SHADE_MODEL (1.1 only)

params returns one value, a symbolic constant indicating whether the shading mode is flat or smooth. See glShadeModel.

• GL_SMOOTH_LINE_WIDTH_RANGE

params returns two values, the smallest and largest supported widths for antialiased lines. The range must include 1. See glLineWidth.

• GL_SMOOTH_POINT_SIZE_RANGE

params returns two values, the smallest and largest supported widths for antialiased points. The range must include 1. See glPointSize.

• GL_STENCIL_BITS

params returns one value, the number of bitplanes in the stencil buffer.

• GL_STENCIL_CLEAR_VALUE (1.1 only)

params returns one value, the index to which the stencil bitplanes are cleared. See glClearStencil.

• GL_STENCIL_FAIL (1.1 only)

params returns one value, a symbolic constant indicating what action is taken when the stencil test fails. See glStencilOp.

• GL_STENCIL_FUNC (1.1 only)

params returns one value, a symbolic constant indicating what function is used to compare the stencil reference value with the stencil buffer value. See glStencilFunc.

• GL_STENCIL_PASS_DEPTH_FAIL (1.1 only)

params returns one value, a symbolic constant indicating what action is taken when the stencil test passes, but the depth test fails. See glStencilOp.

• GL_STENCIL_PASS_DEPTH_PASS (1.1 only)

params returns one value, a symbolic constant indicating what action is taken when the stencil test passes, and the depth test passes. See glStencilOp.

• GL_STENCIL_REF (1.1 only)

params returns one value, the reference value that is compared with the contents of the stencil buffer. See glStencilFunc.

• GL_STENCIL_VALUE_MASK (1.1 only)

params returns one value, the mask that is used to mask both the stencil reference value and the stencil buffer value before they are compared. See glStencilFunc.

• GL_STENCIL_WRITEMASK (1.1 only)

params returns one value, the mask that controls writing of the stencil bitplanes. See glStencilMask.

• GL_SUBPIXEL_BITS

params returns one value, an estimate of the number of bits of subpixel resolution that are used to position rasterized geometry in window coordinates. The value must be at least 4.

• GL_TEXTURE_BINDING_2D (1.1 only)

params returns one value, the name of the texture currently bound to the target GL_TEXTURE_2D. See glBindTexture.

• GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING (1.1 only)

params returns one value, the texture coordinate array buffer binding. See glTexCoordPointer.

• GL_TEXTURE_COORD_ARRAY_SIZE (1.1 only)

params returns one value, the number of coordinates per element in the texture coordinate array. See glTexCoordPointer.

• GL_TEXTURE_COORD_ARRAY_STRIDE (1.1 only)

params returns one value, the byte offset between consecutive elements in the texture coordinate array. See glTexCoordPointer.

• GL_TEXTURE_COORD_ARRAY_TYPE (1.1 only)

params returns one value, returns the data type of each coordinate in the texture coordinate array. See glTexCoordPointer.

• GL_TEXTURE_MATRIX (1.1 only)

params returns sixteen values: the texture matrix on the top of the texture matrix stack. See glPushMatrix.

• GL_TEXTURE_MATRIX_FLOAT_AS_INT_BITS_OES ( OES_matrix_get extension)

params returns a representation of the floating point Texture matrix elements as as an array of integers, according to the IEEE 754 floating point "single format" bit layout. See glMatrixMode.

• GL_TEXTURE_STACK_DEPTH (1.1 only)

params returns one value, the number of matrices on the texture matrix stack. See glBindTexture.

• GL_UNPACK_ALIGNMENT (1.1 only)

params returns one value, the byte alignment used for reading pixel data from memory. See glPixelStore.

• GL_VIEWPORT (1.1 only)

params returns four values:, the x and y window coordinates of the viewport, followed by its width and height. See glViewport.

• GL_VERTEX_ARRAY_BUFFER_BINDING (1.1 only)

params returns one value, the vertex array buffer binding. See glVertexPointer.

• GL_VERTEX_ARRAY_SIZE (1.1 only)

params returns one value, number of coordinates per vertex in the vertex array. See glVertexPointer.

• GL_VERTEX_ARRAY_STRIDE (1.1 only)

params returns one value, the byte offset between consecutive vertexes in the vertex array. See glVertexPointer.

• GL_VERTEX_ARRAY_TYPE (1.1 only)

params returns one value, returns the data type of each coordinate in the vertex array. See glVertexPointer.

• GL_WEIGHT_ARRAY_BUFFER_BINDING_OES ( OES_matrix_palette extension)

params returns one value, the weight array buffer binding. See glWeightPointer.

• GL_WEIGHT_ARRAY_SIZE_OES ( OES_matrix_palette extension)

params returns one value, the number of weights per vertex. See glWeightPointer.

• GL_WEIGHT_ARRAY_STRIDE_OES ( OES_matrix_palette extension)

params returns one value, the byte offset between weights per vertex. See glWeightPointer.

• GL_WEIGHT_ARRAY_TYPE_OES ( OES_matrix_palette extension)

params returns one value, the data type of each weight in the weight array. See glWeightPointer.

Errors

GL_INVALID_ENUM is generated if pname is not an accepted value.

Integer Buffer version of glGetIntegerv.

Return a string describing the underlying GL implementation. The GL string is converted to UTF8 format to produce a standard Java String object.

glGetString returns a String describing some aspect of the current GL implementation. name can be one of the following:

• GL_VENDOR

Returns the company responsible for this GL implementation. This name does not change from release to release.

• GL_RENDERER

Returns the name of the renderer. This name is typically specific to a particular configuration of a hardware platform. It does not change from release to release.

• GL_VERSION

Returns the particular OpenGL ES profile as well as the version of that profile.

• GL_EXTENSIONS

Returns a space-separated list of supported extensions to GL.

Because the GL does not include queries for the performance characteristics of an implementation, some applications are written to recognize known platforms and modify their GL usage based on known performance characteristics of these platforms. Strings GL_VENDOR and GL_RENDERER together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms.

Some applications want to make use of features that are not part of the standard GL. These features may be implemented as extensions to the standard GL. The GL_EXTENSIONS string is a space-separated list of supported GL extensions. (Extension names never contain a space character.)

The GL_VERSION string begins with a version number. The version number uses one of these forms:

major_number.minor_number (1.0 only)

major_number.minor_number.release_number (1.0 only)

OpenGL ES-CM followed by major_number.minor_number for the common profile (1.1 only).

OpenGL ES-CL followed by major_number.minor_number for the common-lite profile (1.1 only).

On 1.0 implementations, vendor-specific information may follow the version number. A space always separates the version number and the vendor-specific information.

Notes

If an error is generated, glGetString returns NULL.

The client and server may support different versions or extensions. glGetString always returns a compatible version number or list of extensions. The release number always describes the server.

Errors

GL_INVALID_ENUM is generated if name is not an accepted value.

Specify implementation-specific hints.

Certain aspects of GL behavior, when there is room for interpretation, can be controlled with hints. A hint is specified with two arguments. target is a symbolic constant indicating the behavior to be controlled, and mode is another symbolic constant indicating the desired behavior. The initial value for each target is GL_DONT_CARE. mode can be one of the following:

• GL_FASTEST

The most efficient option should be chosen.

• GL_NICEST

The most correct, or highest quality, option should be chosen.

• GL_DONT_CARE

No preference.

Though the implementation aspects that can be hinted are well defined, the interpretation of the hints depends on the implementation. The hint aspects that can be specified with target, along with suggested semantics, are as follows:

• GL_FOG_HINT

Indicates the accuracy of fog calculation. If per-pixel fog calculation is not efficiently supported by the GL implementation, hinting GL_DONT_CARE or GL_FASTEST can result in per-vertex calculation of fog effects.

• GL_LINE_SMOOTH_HINT

Indicates the sampling quality of antialiased lines. If a larger filter function is applied, hinting GL_NICEST can result in more pixel fragments being generated during rasterization,

• GL_PERSPECTIVE_CORRECTION_HINT

Indicates the quality of color and texture coordinate interpolation. If perspective-corrected parameter interpolation is not efficiently supported by the GL implementation, hinting GL_DONT_CARE or GL_FASTEST can result in simple linear interpolation of colors and/or texture coordinates.

• GL_POINT_SMOOTH_HINT

Indicates the sampling quality of antialiased points. If a larger filter function is applied, hinting GL_NICEST can result in more pixel fragments being generated during rasterization.

• GL_GENERATE_MIPMAP_HINT (1.1 only)

Indicates the desired quality and performance of automatic mipmap level generation.