Java Doc for GL10.java in  » 6.0-JDK-Modules » j2me » javax » microedition » khronos » opengles » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The OES_byte_coordinates, OES_single_precision, OES_fixed_point, OES_read_format, and OES_compressed_paletted_texture extensions are included as part of this interface.

Methods with an x or xv suffix belong to the OES_fixed_point extension and take one or more fixed-point arguments. Fixed-point arguments may be derived from floating-point values by multiplying by 65536 (2^16) and rounding to the nearest integer.

For ease of use, this interface documents method behavior for all versions of OpenGL ES including version 1.1 and extensions. When running on an OpenGL ES 1.0 implementation, sections marked "(1.1 only)" should be disregarded.

See the GL interface for a description of how to obtain an instance of this interface.

glActiveTexture selects which texture unit subsequent texture state calls will affect.

The alpha test discards fragments depending on the outcome of a comparison between an incoming fragment's alpha value and a constant reference value.

glBindTexture lets you create or use a named texture.

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).

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.

glClearColor specifies the red, green, blue, and alpha values used by glClear to clear the color buffer.

glClearDepth specifies the depth value used by glClear to clear the depth buffer.

glClearStencil specifies the index used by glClear to clear the stencil buffer.

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
Parameters:
  texture - Specifies which texture unit to make active.

The GL stores a current four-valued RGBA color.

glColorMask specifies whether the individual components in the color buffer can or cannot be written.

glColorPointer specifies an array of color components to use when rendering.

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

The supported compressed formats are paletted textures.

glCompressedTexSubImage2D redefines a contiguous subregion of an existing two-dimensional compressed texture image.

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.

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.

glCullFace specifies whether front- or back-facing polygons are culled (as specified by mode) when culling is enabled.

glDeleteTextures deletes n textures named by the elements of the array textures.

glDepthFunc specifies the function used to compare each incoming pixel depth value with the depth value present in the depth buffer.

glDepthMask specifies whether the depth buffer is enabled for writing.

After clipping and division by w, depth coordinates range from -1 to 1, corresponding to the near and far clipping planes.

glDrawArrays specifies multiple geometric primitives with very few subroutine calls.

glDrawElements specifies multiple geometric primitives with very few subroutine calls.

glEnable and glDisable enable and disable various capabilities.

glEnableClientState and glDisableClientState enable or disable individual client-side capabilities.

glFinish does not return until the effects of all previously called GL commands are complete.

Different GL implementations buffer commands in several different locations, including network buffers and the graphics accelerator itself.

If fog is enabled, fog affects rasterized geometry, bitmaps, and pixel blocks, but not buffer clear operations.

If fog is enabled, fog affects rasterized geometry, bitmaps, and pixel blocks, but not buffer clear operations.

In a scene composed entirely of opaque closed surfaces, back-facing polygons are never visible.

glFrustum describes a perspective matrix that produces a perspective projection.

glGenTextures returns n texture names in textures.

glGetError returns the value of the error flag.

glGet returns values for static state variables in GL.

Certain aspects of GL behavior, when there is room for interpretation, can be controlled with hints.

glLightModel sets the lighting model parameter.

glLightModel sets the lighting model parameter.

glLight sets the values of individual light source parameters.

glLight sets the values of individual light source parameters.

glLineWidth specifies the rasterized width of both aliased and antialiased lines.

glLoadIdentity replaces the current matrix with the identity matrix.

glLoadMatrix replaces the current matrix with the one whose elements are specified by m.

glLogicOp specifies a logical operation that, when enabled, is applied between the incoming color and the color at the corresponding location in the frame buffer.

glMaterial assigns values to material parameters.

glMaterial assigns values to material parameters.

glMatrixMode sets the current matrix mode.

glMultMatrix multiplies the current matrix with the one specified using m, and replaces the current matrix with the product.

The current matrix is determined by the current matrix mode (see glMatrixMode).

glMultiTexCoord specifies the four texture coordinates as (s, t, r, q).

The current texture coordinates are part of the data that is associated with each vertex.

Notes

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

Associated Gets

glGetIntegerv with argument GL_MAX_TEXTURE_UNITS.
Parameters:
  target - Specifies texture unit whose coordinates should bemodified.

The current normal is set to the given coordinates whenever glNormal is issued.

glNormalPointer specifies the location and data of an array of normals to use when rendering.

glOrtho describes a transformation that produces a parallel projection.

glPixelStore sets pixel storage modes that affect the operation of subsequent glReadPixels as well as the unpacking of glTexImage2D, and glTexSubImage2D.

pname is a symbolic constant indicating the parameter to be set, and param is the new value.

glPointSize specifies the rasterized diameter of both aliased and antialiased points.

When GL_POLYGON_OFFSET_FILL is enabled, each fragment's depth value will be offset after it is interpolated from the depth values of the appropriate vertices.

There is a stack of matrices for each of the matrix modes.

glReadPixels returns pixel data from the color buffer, starting with the pixel whose lower left corner is at location (x, y), into client memory starting at location pixels.

glRotate produces a rotation of angle degrees around the vector (x, y, z) .

glSampleCoverage defines a mask to modify the coverage of multisampled pixel fragments.

glScale produces a nonuniform scaling along the x, y, and z axes.

glScissor defines a rectangle, called the scissor box, in window coordinates.

GL primitives can have either flat or smooth shading.

Stenciling, like depth-buffering, enables and disables drawing on a per-pixel basis.

glStencilMask controls the writing of individual bits in the stencil planes.

Stenciling, like depth-buffering, enables and disables drawing on a per-pixel basis.

glTexCoordPointer specifies the location and data of an array of texture coordinates to use when rendering.

If target is GL_TEXTURE_ENV, then the following applies:

A texture environment specifies how texture values are interpreted when a fragment is textured.

A texture environment specifies how texture values are interpreted when a fragment is textured.

Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled.

Texture mapping is a technique that applies an image onto an object's surface as if the image were a decal or cellophane shrink-wrap.

Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled.

glVertexPointer specifies the location and data of an array of vertex coordinates to use when rendering.

glViewport specifies the affine transformation of x and y from normalized device coordinates to window coordinates.

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.
Parameters:
  texture - Specifies which texture unit to make active. Thenumber of texture units is implementation dependent, but must beat least one (for 1.0) or two (for 1.1). texturemust be one of GL_TEXTUREi, where 0 <=i < GL_MAX_TEXTURE_UNITS, which is animplementation-dependent value. The intial value isGL_TEXTURE0.

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.
Parameters:
  func - Specifies the alpha comparison function. Symbolicconstants GL_NEVER, GL_LESS,GL_EQUAL, GL_LEQUAL,GL_GREATER, GL_NOTEQUAL,GL_GEQUAL, and GL_ALWAYS are accepted. Theinitial value is GL_ALWAYS.
Parameters:
  ref - Specifies the reference value that incoming alphavalues are compared to. This value is clamped to the range[0, 1], where 0 represents the lowest possible alphavalue and 1 the highest possible value. The initial referencevalue is 0.

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.
Parameters:
  target - Specifies the target to which the texture isbound. Must be GL_TEXTURE_2D.
Parameters:
  texture - Specifies the name of a texture.

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.
Parameters:
  sfactor - Specifies how the red, green, blue, and alphasource blending factors are computed. The following symbolicconstants are accepted: GL_ZERO,GL_ONE, GL_SRC_COLOR (1.1 only),GL_ONE_MINUS_SRC_COLOR (1.1 only),GL_DST_COLOR, GL_ONE_MINUS_DST_COLOR,GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA,GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA,and GL_SRC_ALPHA_SATURATE. The initial value isGL_ONE.
Parameters:
  dfactor - Specifies how the red, green, blue, and alphadestination blending factors are computed. The following symbolicconstants are accepted: GL_ZERO,GL_ONE, GL_SRC_COLOR,GL_ONE_MINUS_SRC_COLOR, GL_DST_COLOR(1.1 only), GL_ONE_MINUS_DST_COLOR (1.1 only),GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA,GL_DST_ALPHA, andGL_ONE_MINUS_DST_ALPHA. The initial value isGL_ZERO.

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.
Parameters:
  mask - Bitwise OR of masks that indicate the buffers to becleared. Valid masks are GL_COLOR_BUFFER_BIT,GL_DEPTH_BUFFER_BIT, and GL_STENCIL_BUFFER_BIT.

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].
Parameters:
  red - Specifies the red value used when the color buffer iscleared. The initial value is 0.
Parameters:
  green - Specifies the green value used when the color bufferis cleared. The initial value is 0.
Parameters:
  blue - Specifies the blue value used when the color buffer iscleared. The initial value is 0.
Parameters:
  alpha - Specifies the alpha value used when the color bufferis cleared. The initial value is 0.

glClearDepth specifies the depth value used by glClear to clear the depth buffer. Values specified by glClearDepth are clamped to the range [0, 1].
Parameters:
  depth - Specifies the depth value used when the depth bufferis cleared. The initial value is 1.

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
Parameters:
  s - Specifies the index used when the stencil buffer iscleared. The initial value is 0.

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
Parameters:
  texture - Specifies which texture unit to make active. Thenumber of texture units is implementation dependent, but must beat least one (for 1.0), or two (for 1.1). texturemust be one of GL_TEXTUREi, 0 <=i < GL_MAX_TEXTURE_UNITS, which is animplementation-dependent value. The initial value isGL_TEXTURE0.

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.
Parameters:
  red - Specifies a new red value for the current color. Theinitial value is 1.
Parameters:
  green - Specifies a new green value for the current color. Theinitial value is 1.
Parameters:
  blue - Specifies a new blue value for the current color. Theinitial value is 1.
Parameters:
  alpha - Specifies a new alpha value for the current color. Theinitial value is 1.

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.
Parameters:
  red - Specifies whether red can or cannot be written intothe color buffer. The initial value is true, indicatingthat the color component can be written.
Parameters:
  green - Specifies whether green can or cannot be written intothe color buffer. The initial value is true, indicatingthat the color component can be written.
Parameters:
  blue - Specifies whether blue can or cannot be written intothe color buffer. The initial value is true, indicatingthat the color component can be written.
Parameters:
  alpha - Specifies whether alpha can or cannot be writteninto the color buffer. The initial value is true,indicating that the color component can be written.

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.
Parameters:
  size - Specifies the number of components per color. Must be4. The initial value is 4.
Parameters:
  type - Specifies the data type of each color component inthe array. Symbolic constants GL_UNSIGNED_BYTE,GL_FIXED, and GL_FLOAT areaccepted. The initial value is GL_FLOAT.
Parameters:
  stride - Specifies the byte offset between consecutivecolors. If stride is 0, the colors are understood tobe tightly packed in the array. The initial value is 0.
Parameters:
  pointer - Specifies a Buffer containing thecolors.
exception:
  IllegalStateException - if OpenGL ES 1.1 is being used andVBOs are enabled.
exception:
  IllegalArgumentException - if pointer isnull.
exception:
  IllegalArgumentException - if pointer isnot direct.

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.
Parameters:
  target - Specifies the target texture. Must beGL_TEXTURE_2D.
Parameters:
  level - Specifies the level-of-detail number. Must be lessthan or equal to 0. Level 0 indicates a singlemip-level. Negative values indicate how many mip-levels aredescribed by data.
Parameters:
  internalformat - Specifies the color components in thetexture. The following symbolic constants are accepted:GL_PALETTE4_RGB8_OES,GL_PALETTE4_RGBA8_OES,GL_PALETTE4_R5_G6_B5_OES,GL_PALETTE4_RGBA4_OES,GL_PALETTE4_RGB5_A1_OES,GL_PALETTE8_RGB8_OES,GL_PALETTE8_RGBA8_OES,GL_PALETTE8_R5_G6_B5_OES,GL_PALETTE8_RGBA4_OES, andGL_PALETTE8_RGB5_A1_OES.
Parameters:
  width - Specifies the width of the texture image. Must be2^n + 2*border for some integer n. Allimplementations support texture images that are at least 64texels wide.
Parameters:
  height - Specifies the height of the texture image. Must be2^m + 2*border for some integer m. Allimplementations support texture images that are at least 64texels high.
Parameters:
  border - Specifies the width of the border. Must be 0.
Parameters:
  imageSize - Specifies the size of the compressed image datain bytes.
Parameters:
  data - Specifies a Buffer containing thecompressed image data.
exception:
  IllegalArgumentException - if data isnull.
exception:
  IllegalArgumentException - ifdata.remaining() is less thanimageSize.

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
Parameters:
  target - Specifies the target texture. Must beGL_TEXTURE_2D.
Parameters:
  level - Specifies the level-of-detail number.
Parameters:
  xoffset - Specifies a texel offset in the x direction withinthe texture array.
Parameters:
  yoffset - Specifies a texel offset in the y direction withinthe texture array.
Parameters:
  width - Specifies the width of the texture subimage.
Parameters:
  height - Specifies the height of the texture subimage.
Parameters:
  format - Specifies the format of the pixel data. Currently,there is no supported format.
Parameters:
  imageSize - Specifies the size of the compressed pixel data in bytes.
Parameters:
  data - Specifies a Buffer containing thecompressed image data.
exception:
  IllegalArgumentException - if data isnull.
exception:
  IllegalArgumentException - ifdata.remaining() is less thanimageSize.