Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2007 Sun Microsystems, Inc. All rights reserved.

The Java™ Binding for the OpenGL® ES API

javax.microedition.khronos.opengles
Interface GL11Ext

All Superinterfaces:
GL

public interface GL11Ext
extends GL

The GL11Ext interface contains the Java(TM) programming language bindings for all optional profile extensions to OpenGL(R) ES 1.1.

This interface contains constants and methods associated with the optional profile extensions for OpenGL ES 1.1. The runtime OpenGL ES engine may or may not implement any particular extensions defined in the extension pack. Functions that require a particular extension will throw an UnsupportedOperationException if the extension is not available at runtime.

The OpenGL ES 1.1 optional profile extensions comprise the following:

The documentation in this class is normative with respect to instance variable names and values, method names and signatures, and exception behavior. The remaining documentation is placed here for convenience and does not replace the normative documentation found in the OpenGL ES 1.1 specification and the OpenGL specification versions it references.


Field Summary
static int GL_MATRIX_INDEX_ARRAY_BUFFER_BINDING_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_MATRIX_INDEX_ARRAY_OES
          Constant for use with glEnableClientState and glDisableClientState (OES_matrix_palette extension).
static int GL_MATRIX_INDEX_ARRAY_POINTER_OES
          Constant for use with glGetPointer (OES_matrix_palette extension).
static int GL_MATRIX_INDEX_ARRAY_SIZE_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_MATRIX_INDEX_ARRAY_STRIDE_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_MATRIX_INDEX_ARRAY_TYPE_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_MATRIX_PALETTE_OES
          Constant for use with glMatrixMode (OES_matrix_palette extension).
static int GL_MAX_PALETTE_MATRICES_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_MAX_VERTEX_UNITS_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_TEXTURE_CROP_RECT_OES
          Constant for use with glTexParameter (OES_draw_texture extension).
static int GL_WEIGHT_ARRAY_BUFFER_BINDING_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_WEIGHT_ARRAY_OES
          Constant for use with glEnableClientState and glDisableClientState (OES_matrix_palette extension).
static int GL_WEIGHT_ARRAY_POINTER_OES
          Constant for use with glGetPointer (OES_matrix_palette extension).
static int GL_WEIGHT_ARRAY_SIZE_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_WEIGHT_ARRAY_STRIDE_OES
          Constant for use with glGet (OES_matrix_palette extension).
static int GL_WEIGHT_ARRAY_TYPE_OES
          Constant for use with glGet (OES_matrix_palette extension).
 
Method Summary
 void glCurrentPaletteMatrixOES(int matrixpaletteindex)
          (OES_matrix_palette extension) Defines which of the palette’s matrices is affected by subsequent matrix operations.
 void glDrawTexfOES(float x, float y, float z, float width, float height)
          (OES_draw_texture extension) glDrawTexOES draws a texture rectangle to the screen.
 void glDrawTexfvOES(float[] coords, int offset)
          (OES_draw_texture extension) Floating-point array version of glDrawTexOES.
 void glDrawTexfvOES(FloatBuffer coords)
          (OES_draw_texture extension) Floating-point Buffer version of glDrawTexOES.
 void glDrawTexiOES(int x, int y, int z, int width, int height)
          (OES_draw_texture extension) Integer version of glDrawTexOES.
 void glDrawTexivOES(int[] coords, int offset)
          (OES_draw_texture extension) Integer array version of glDrawTexOES.
 void glDrawTexivOES(IntBuffer coords)
          (OES_draw_texture extension) Integer Buffer version of glDrawTexOES.
 void glDrawTexsOES(short x, short y, short z, short width, short height)
          (OES_draw_texture extension) Short integer version of glDrawTexOES.
 void glDrawTexsvOES(short[] coords, int offset)
          (OES_draw_texture extension) Short integer array version of glDrawTexOES.
 void glDrawTexsvOES(ShortBuffer coords)
          (OES_draw_texture extension) Short integer Buffer version of glDrawTexOES.
 void glDrawTexxOES(int x, int y, int z, int width, int height)
          (OES_draw_texture extension) Fixed-point version of glDrawTexOES.
 void glDrawTexxvOES(int[] coords, int offset)
          (OES_draw_texture extension) Fixed-point array version of glDrawTexOES.
 void glDrawTexxvOES(IntBuffer coords)
          (OES_draw_texture extension) Fixed-point Buffer version of glDrawTexOES.
 void glEnable(int cap)
          (1.1 + OES_matrix_palette extension) Enable server-side GL capabilities.
 void glEnableClientState(int array)
          (OES_matrix_palette extension) Enable client-side capability.
 void glLoadPaletteFromModelViewMatrixOES()
          (OES_matrix_palette extension) Copies the current model view matrix to a matrix in the current matrix palette.
 void glMatrixIndexPointerOES(int size, int type, int stride, Buffer pointer)
          (OES_matrix_palette extension) Define an array of matrix indices.
 void glMatrixIndexPointerOES(int size, int type, int stride, int offset)
          VBO version of glMatrixIndexPointerOES.
 void glTexParameterfv(int target, int pname, float[] params, int offset)
          (OES_draw_texture extension) Set texture parameters.
 void glWeightPointerOES(int size, int type, int stride, Buffer pointer)
          (OES_matrix_palette extension) Define an array of weights.
 void glWeightPointerOES(int size, int type, int stride, int offset)
          (OES_matrix_palette extension) VBO version of glWeightPointerOES.
 

Field Detail

GL_TEXTURE_CROP_RECT_OES

public static final int GL_TEXTURE_CROP_RECT_OES
Constant for use with glTexParameter (OES_draw_texture extension).

See Also:
Constant Field Values

GL_MAX_VERTEX_UNITS_OES

public static final int GL_MAX_VERTEX_UNITS_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MAX_PALETTE_MATRICES_OES

public static final int GL_MAX_PALETTE_MATRICES_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_PALETTE_OES

public static final int GL_MATRIX_PALETTE_OES
Constant for use with glMatrixMode (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_OES

public static final int GL_MATRIX_INDEX_ARRAY_OES
Constant for use with glEnableClientState and glDisableClientState (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_OES

public static final int GL_WEIGHT_ARRAY_OES
Constant for use with glEnableClientState and glDisableClientState (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_SIZE_OES

public static final int GL_MATRIX_INDEX_ARRAY_SIZE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_TYPE_OES

public static final int GL_MATRIX_INDEX_ARRAY_TYPE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_STRIDE_OES

public static final int GL_MATRIX_INDEX_ARRAY_STRIDE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_POINTER_OES

public static final int GL_MATRIX_INDEX_ARRAY_POINTER_OES
Constant for use with glGetPointer (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_MATRIX_INDEX_ARRAY_BUFFER_BINDING_OES

public static final int GL_MATRIX_INDEX_ARRAY_BUFFER_BINDING_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_SIZE_OES

public static final int GL_WEIGHT_ARRAY_SIZE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_TYPE_OES

public static final int GL_WEIGHT_ARRAY_TYPE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_STRIDE_OES

public static final int GL_WEIGHT_ARRAY_STRIDE_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_POINTER_OES

public static final int GL_WEIGHT_ARRAY_POINTER_OES
Constant for use with glGetPointer (OES_matrix_palette extension).

See Also:
Constant Field Values

GL_WEIGHT_ARRAY_BUFFER_BINDING_OES

public static final int GL_WEIGHT_ARRAY_BUFFER_BINDING_OES
Constant for use with glGet (OES_matrix_palette extension).

See Also:
Constant Field Values
Method Detail

glEnable

public void glEnable(int cap)
(1.1 + OES_matrix_palette extension) Enable server-side GL capabilities.

The matrix palette extension is enabled if cap assumes the value GL_MATRIX_PALETTE_OES. See glMatrixMode.

See Also:
GL10.glEnable(int cap)

glEnableClientState

public void glEnableClientState(int array)
(OES_matrix_palette extension) Enable client-side capability.

The OES_matrix_palette extension adds three additional values for array:

See Also:
GL10.glEnableClientState(int array)

glTexParameterfv

public void glTexParameterfv(int target,
                             int pname,
                             float[] params,
                             int offset)
(OES_draw_texture extension) Set texture parameters. The OES_draw_texture extension adds an additoanl value for pname, GL_TEXTURE_CROP_RECT_OES, which sets the texture cropping rectangle for use by glDrawTexOES.

See Also:
GL11.glTexParameterfv(int target, int pname, float[] params, int offset)

glDrawTexfOES

public void glDrawTexfOES(float x,
                          float y,
                          float z,
                          float width,
                          float height)
(OES_draw_texture extension) glDrawTexOES draws a texture rectangle to the screen.

x and y are given directly in window (viewport) coordinates.

z is mapped to window depth Zw as follows:

 If z <= 0 then Zw = n
 If z >= 1 then Zw = f
 Otherwise Zw = n + z * (f - n)
 
where n and f are the near and far values of GL_DEPTH_RANGE respectively.

width and height specify the width and height of the affected screen rectangle in pixels. These values may be positive or negative; however if either of these are negative, nothing is drawn.

Calling one of the DrawTex functions generates a fragment for each pixel that overlaps the screen rectangle bounded by (x, y) and (x + width), (y + height). For each generated fragment, the depth is given by Zw as defined above, and the color by the current color.

Texture coordinates for each texture unit are computed as follows:

Let X and Y be the screen x and y coordinates of each sample point associated with the fragment. Let Wt and Ht be the width and height in texels of the texture currently bound to the texture unit. (If the texture is a mipmap, let Wt and Ht be the dimensions of the level specified by GL_TEXTURE_BASE_LEVEL). Let Ucr, Vcr, Wcr and Hcr be (respectively) the four integers that make up the texture crop rectangle parameter for the currently bound texture. The fragment texture coordinates (s, t, r, q) are given by:

 s = (Ucr + (X - x) * (Wcr / width)) / Wt
 t = (Vcr + (Y - y) * (Hcr / height)) / Ht
 r = 0
 q = 1
 

Notes

In the specific case where X, Y, x and y are all integers, Wcr/width and Hcr/height are both equal to one, the base level is used for the texture read, and fragments are sampled at pixel centers, implementations are required to ensure that the resulting u, v texture indices are also integers. This results in a one-to-one mapping of texels to fragments.

Note that Wcr and/or Hcr can be negative. The formulas given above for s and t still apply in this case. The result is that if Wcr is negative, the source rectangle for glDrawTexOES operations lies to the left of the reference point (Ucr, Vcr) rather than to the right of it, and appears right-to-left reversed on the screen after a call to DrawTex. Similarly, if Hcr is negative, the source rectangle lies below the reference point (Ucr, Vcr) rather than above it, and appears upside-down on the screen.

Note also that s, t, r, and q are computed for each fragment as part of glDrawTexOES rendering. This implies that the texture matrix is ignored and has no effect on the rendered result.

glDrawTexOES is available only if the OES_draw_texture extension is supported by your implementation.

Parameters:
x - Specifies the x position of the affected screen rectangle.
y - Specifies the x position of the affected screen rectangle.
z - Specifies the x position of the affected screen rectangle.
width - Specifies the width of the affected screen rectangle in pixels.
height - Specifies the height of the affected screen rectangle in pixels.
Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.

glDrawTexsOES

public void glDrawTexsOES(short x,
                          short y,
                          short z,
                          short width,
                          short height)
(OES_draw_texture extension) Short integer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
See Also:
glDrawTexfOES(float x, float y, float z, float width, float height)

glDrawTexiOES

public void glDrawTexiOES(int x,
                          int y,
                          int z,
                          int width,
                          int height)
(OES_draw_texture extension) Integer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.

glDrawTexxOES

public void glDrawTexxOES(int x,
                          int y,
                          int z,
                          int width,
                          int height)
(OES_draw_texture extension) Fixed-point version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.

glDrawTexfvOES

public void glDrawTexfvOES(float[] coords,
                           int offset)
(OES_draw_texture extension) Floating-point array version of glDrawTexOES.

Parameters:
coords - An array of at least 5 elements containing the x, y, z, width and height values.
offset - the starting offset within the coords array.
Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if offset is less than 0.
java.lang.IllegalArgumentException - if coords is null or if coords.length - offset is less than 5.
See Also:
glDrawTexfOES(float x, float y, float z, float width, float height)

glDrawTexfvOES

public void glDrawTexfvOES(FloatBuffer coords)
(OES_draw_texture extension) Floating-point Buffer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if coords is null or if coords.remaining() is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexsvOES

public void glDrawTexsvOES(short[] coords,
                           int offset)
(OES_draw_texture extension) Short integer array version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if offset is less than 0.
java.lang.IllegalArgumentException - if coords is null or if coords.length - offset is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexsvOES

public void glDrawTexsvOES(ShortBuffer coords)
(OES_draw_texture extension) Short integer Buffer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if coords is null or if coords.remaining() is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexivOES

public void glDrawTexivOES(int[] coords,
                           int offset)
(OES_draw_texture extension) Integer array version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if offset is less than 0.
java.lang.IllegalArgumentException - if coords is null or if coords.length - offset is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexivOES

public void glDrawTexivOES(IntBuffer coords)
(OES_draw_texture extension) Integer Buffer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if coords is null or if coords.remaining() is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexxvOES

public void glDrawTexxvOES(int[] coords,
                           int offset)
(OES_draw_texture extension) Fixed-point array version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if offset is less than 0.
java.lang.IllegalArgumentException - if coords is null or if coords.length - offset is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glDrawTexxvOES

public void glDrawTexxvOES(IntBuffer coords)
(OES_draw_texture extension) Fixed-point Buffer version of glDrawTexOES.

Throws:
UnsupportedOperationException - if the OES_draw_texture extension is not available.
java.lang.IllegalArgumentException - if coords is null or if coords.remaining() is less than 5.
See Also:
glDrawTexfvOES(float[] coords, int offset)

glCurrentPaletteMatrixOES

public void glCurrentPaletteMatrixOES(int matrixpaletteindex)
(OES_matrix_palette extension) Defines which of the palette’s matrices is affected by subsequent matrix operations.

glCurrentPaletteMatrixOES defines which of the palette’s matrices is affected by subsequent matrix operations when the current matrix mode is GL_MATRIX_PALETTE_OES.

Errors

GL_INVALID_VALUE is generated if index is not between 0 and GL_MAX_PALETTE_MATRICES_OES - 1.

Parameters:
matrixpaletteindex - Specifies the index into the palette's matrices.
Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.

glLoadPaletteFromModelViewMatrixOES

public void glLoadPaletteFromModelViewMatrixOES()
(OES_matrix_palette extension) Copies the current model view matrix to a matrix in the current matrix palette.

glLoadPaletteFromModelViewMatrixOES copies the current model view matrix to a matrix in the current matrix palette, as specified by glCurrentPaletteMatrix.

Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.

glMatrixIndexPointerOES

public void glMatrixIndexPointerOES(int size,
                                    int type,
                                    int stride,
                                    Buffer pointer)
(OES_matrix_palette extension) Define an array of matrix indices.

glMatrixIndexPointer specifies the location and data of an array of matrix indices to use when rendering. size specifies the number of matrix indices per vertex and type the data type of the coordinates. stride specifies the byte stride from one matrix index 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.)

These matrices indices are used to blend corresponding matrices for a given vertex.

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

If the matrix index array is enabled, it is used when glDrawArrays, or glDrawElements is called. To enable and disable the vertex array, call glEnableClientState and glDisableClientState with the argument GL_MATRIX_INDEX_ARRAY_OES. The matrix index 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.

Notes

glMatrixIndexPointer is typically implemented on the client side.

Errors

GL_INVALID_VALUE is generated if size is greater than GL_MAX_VERTEX_UNITS_OES.

GL_INVALID_ENUM is generated if type is is not an accepted value.

GL_INVALID_VALUE is generated if stride is negative.

Parameters:
size - Specifies the number of matrix indices per vertex. Must be is less than or equal to GL_MAX_VERTEX_UNITS_OES. The initial value is 0.
type - Specifies the data type of each matrix index in the array. Symbolic constant GL_UNSIGNED_BYTE is accepted. The initial value is GL_UNSIGNED_BYTE.
stride - Specifies the byte offset between consecutive matrix indices. If stride is 0, the matrix indices are understood to be tightly packed in the array. The initial value is 0.
pointer - Specifies a buffer containing the first matrix index of the first vertex in the array. The initial value is 0.
Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.
java.lang.IllegalArgumentException - if pointer is null.
java.lang.IllegalStateException - if VBOs are enabled.

glMatrixIndexPointerOES

public void glMatrixIndexPointerOES(int size,
                                    int type,
                                    int stride,
                                    int offset)
VBO version of glMatrixIndexPointerOES.

Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.
java.lang.IllegalStateException - if VBOs are not enabled.
See Also:
glMatrixIndexPointerOES(int size, int type, int stride, Buffer pointer)

glWeightPointerOES

public void glWeightPointerOES(int size,
                               int type,
                               int stride,
                               Buffer pointer)
(OES_matrix_palette extension) Define an array of weights.

glWeightPointer specifies the location and data of an array of weights to use when rendering. size specifies the number of weights per vertex and type the data type of the coordinates. stride specifies the byte stride from one weight 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.)

These weights are used to blend corresponding matrices for a given vertex.

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

If the weight array is enabled, it is used when glDrawArrays, or glDrawElements is called. To enable and disable the vertex array, call glEnableClientState and glDisableClientState with the argument GL_WEIGHT_ARRAY_OES. The weight 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.

Notes

glWeightPointer is typically implemented on the client side.

Errors

GL_INVALID_VALUE is generated if size is greater than GL_MAX_VERTEX_UNITS_OES.

GL_INVALID_ENUM is generated if type is is not an accepted value.

GL_INVALID_VALUE is generated if stride is negative.

Parameters:
size - Specifies the number of weights per vertex. Must be is less than or equal to GL_MAX_VERTEX_UNITS_OES. The initial value is 0.
type - Specifies the data type of each weight in the array. Symbolic constant GL_FIXED is accepted. However, the common profile also accepts the symbolic constant GL_FLOAT as well. The initial value is GL_FIXED for the common lite profile, or GL_FLOAT for the common profile.
stride - Specifies the byte offset between consecutive weights. If stride is 0, the weights are understood to be tightly packed in the array. The initial value is 0.
pointer - Specifies a Buffer containing the weights of each vertex in the array. The initial value is 0.
Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.
java.lang.IllegalArgumentException - if pointer is null.
java.lang.IllegalStateException - if VBOs are enabled.

glWeightPointerOES

public void glWeightPointerOES(int size,
                               int type,
                               int stride,
                               int offset)
(OES_matrix_palette extension) VBO version of glWeightPointerOES.

Throws:
UnsupportedOperationException - if the underlying runtime engine does not support the OES_matrix_palette extension.
java.lang.IllegalStateException - if VBOs are not enabled.
See Also:
glWeightPointerOES(int size, int type, int stride, Buffer pointer)

Final Release, Oct 2006

This specification is protected under the JSPA version 2.6.
Copyright © 2006 Sun Microsystems, Inc. 4150 Network Circle, California, 95054, U.S.A.
All Rights Reserved. Use is subject to license terms.
Copyright © 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

For more information, please consult the JSR 239 specification.