Top Description Fields Constructors Methods
org.lwjgl.opengles

public Class KHRRobustness

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.system.*
Native bindings to the KHR_robustness extension.

Several recent trends in how OpenGL ES integrates into modern computer systems have created new requirements for robustness and security for GL rendering contexts.

Additionally GPU architectures now support hardware fault detection; for example, video memory supporting ECC (error correcting codes) and error detection. GL contexts should be capable of recovering from hardware faults such as uncorrectable memory errors. Along with recovery from such hardware faults, the recovery mechanism can also allow recovery from video memory access exceptions and system software failures. System software failures can be due to device changes or driver failures.

GL queries that return (write) some number of bytes to a buffer indicated by a pointer parameter introduce risk of buffer overflows that might be exploitable by malware. To address this, queries with return value sizes that are not expressed directly by the parameters to the query itself are given additional API functions with an additional parameter that specifies the number of bytes in the buffer and never writing bytes beyond that limit. This is particularly useful for multi-threaded usage of GL contexts in a "share group" where one context can change objects in ways that can cause buffer overflows for another context's GL queries.

The original ARB_vertex_buffer_object extension includes an issue that explicitly states program termination is allowed when out-of-bounds vertex buffer object fetches occur. Modern graphics hardware is capable of well-defined behavior in the case of out-of- bounds vertex buffer object fetches. Older hardware may require extra checks to enforce well-defined (and termination free) behavior, but this expense is warranted when processing potentially untrusted content.

The intent of this extension is to address some specific robustness goals:

Requires GLES 2.0.

Field Summary

Modifier and TypeField and Description
public static final int
GL_CONTEXT_LOST_KHR

Returned by GetError.

public static final int
GL_CONTEXT_ROBUST_ACCESS_KHR

Accepted by the value parameter of GetBooleanv, GetIntegerv, and GetFloatv.

public static final int
GL_GUILTY_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

public static final int
GL_INNOCENT_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

public static final int
GL_LOSE_CONTEXT_ON_RESET_KHR

Returned by GetIntegerv and related simple queries when value is RESET_NOTIFICATION_STRATEGY_KHR.

public static final int
GL_NO_RESET_NOTIFICATION_KHR

Returned by GetIntegerv and related simple queries when value is RESET_NOTIFICATION_STRATEGY_KHR.

public static final int
GL_RESET_NOTIFICATION_STRATEGY_KHR

Accepted by the value parameter of GetBooleanv, GetIntegerv, and GetFloatv.

public static final int
GL_UNKNOWN_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

Constructor Summary

AccessConstructor and Description
protected
KHRRobustness()

Method Summary

Modifier and TypeMethod and Description
public static native int
glGetGraphicsResetStatusKHR()

Indicates if the GL context has been in a reset state at any point since the last call to GetGraphicsResetStatus:

public static float
glGetnUniformfKHR(int
the program object
program, int
the uniform location
location)

Returns the value or values of a uniform of the default uniform block.

public static void
glGetnUniformfvKHR(int
the program object
program, int
the uniform location
location, FloatBuffer
the buffer in which to place the returned data
params)

Returns the value or values of a uniform of the default uniform block.

public static void
glGetnUniformfvKHR(int program, int location, float[] params)

Array version of: GetnUniformfvKHR

public static float
glGetnUniformiKHR(int
the program object
program, int
the uniform location
location)

Integer version of GetnUniformfvKHR.

public static void
glGetnUniformivKHR(int
the program object
program, int
the uniform location
location, FloatBuffer
the buffer in which to place the returned data
params)

Integer version of GetnUniformfvKHR.

public static void
glGetnUniformivKHR(int program, int location, float[] params)

Array version of: GetnUniformivKHR

public static float
glGetnUniformuiKHR(int
the program object
program, int
the uniform location
location)

Unsigned version of GetnUniformivKHR.

public static void
glGetnUniformuivKHR(int
the program object
program, int
the uniform location
location, FloatBuffer
the buffer in which to place the returned data
params)

Unsigned version of GetnUniformivKHR.

public static void
glGetnUniformuivKHR(int program, int location, float[] params)

Array version of: GetnUniformuivKHR

public static void
glReadnPixelsKHR(int
the left pixel coordinate
x, int
the lower pixel coordinate
y, int
the number of pixels to read in the x-dimension
width, int
the number of pixels to read in the y-dimension
height, int
the pixel format
format, int
the pixel type
type, int
the maximum number of bytes to write into data
bufSize, long
a buffer in which to place the returned pixel data
pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

public static void
glReadnPixelsKHR(int
the left pixel coordinate
x, int
the lower pixel coordinate
y, int
the number of pixels to read in the x-dimension
width, int
the number of pixels to read in the y-dimension
height, int
the pixel format
format, int
the pixel type
type, ByteBuffer
a buffer in which to place the returned pixel data
pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

public static void
glReadnPixelsKHR(int
the left pixel coordinate
x, int
the lower pixel coordinate
y, int
the number of pixels to read in the x-dimension
width, int
the number of pixels to read in the y-dimension
height, int
the pixel format
format, int
the pixel type
type, ShortBuffer
a buffer in which to place the returned pixel data
pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

public static void
glReadnPixelsKHR(int
the left pixel coordinate
x, int
the lower pixel coordinate
y, int
the number of pixels to read in the x-dimension
width, int
the number of pixels to read in the y-dimension
height, int
the pixel format
format, int
the pixel type
type, IntBuffer
a buffer in which to place the returned pixel data
pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

public static void
glReadnPixelsKHR(int
the left pixel coordinate
x, int
the lower pixel coordinate
y, int
the number of pixels to read in the x-dimension
width, int
the number of pixels to read in the y-dimension
height, int
the pixel format
format, int
the pixel type
type, FloatBuffer
a buffer in which to place the returned pixel data
pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

public static void
glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, short[] pixels)

Array version of: ReadnPixelsKHR

public static void
glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, int[] pixels)

Array version of: ReadnPixelsKHR

public static void
glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, float[] pixels)

Array version of: ReadnPixelsKHR

public static native void
nglGetnUniformfvKHR(int program, int location, int
the maximum number of bytes to write to params
bufSize, long params)

Unsafe version of: GetnUniformfvKHR

public static native void
nglGetnUniformivKHR(int program, int location, int
the maximum number of bytes to write to params
bufSize, long params)

Unsafe version of: GetnUniformivKHR

public static native void
nglGetnUniformuivKHR(int program, int location, int
the maximum number of bytes to write to params
bufSize, long params)

Unsafe version of: GetnUniformuivKHR

public static native void
nglReadnPixelsKHR(int x, int y, int width, int height, int format, int type, int
the maximum number of bytes to write into data
bufSize, long pixels)

Unsafe version of: ReadnPixelsKHR

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

GL_CONTEXT_LOST_KHRback to summary
public static final int GL_CONTEXT_LOST_KHR

Returned by GetError.

GL_CONTEXT_ROBUST_ACCESS_KHRback to summary
public static final int GL_CONTEXT_ROBUST_ACCESS_KHR

Accepted by the value parameter of GetBooleanv, GetIntegerv, and GetFloatv.

GL_GUILTY_CONTEXT_RESET_KHRback to summary
public static final int GL_GUILTY_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

GL_INNOCENT_CONTEXT_RESET_KHRback to summary
public static final int GL_INNOCENT_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

GL_LOSE_CONTEXT_ON_RESET_KHRback to summary
public static final int GL_LOSE_CONTEXT_ON_RESET_KHR

Returned by GetIntegerv and related simple queries when value is RESET_NOTIFICATION_STRATEGY_KHR.

GL_NO_RESET_NOTIFICATION_KHRback to summary
public static final int GL_NO_RESET_NOTIFICATION_KHR

Returned by GetIntegerv and related simple queries when value is RESET_NOTIFICATION_STRATEGY_KHR.

GL_RESET_NOTIFICATION_STRATEGY_KHRback to summary
public static final int GL_RESET_NOTIFICATION_STRATEGY_KHR

Accepted by the value parameter of GetBooleanv, GetIntegerv, and GetFloatv.

GL_UNKNOWN_CONTEXT_RESET_KHRback to summary
public static final int GL_UNKNOWN_CONTEXT_RESET_KHR

Returned by GetGraphicsResetStatusKHR.

Constructor Detail

KHRRobustnessback to summary
protected KHRRobustness()

Method Detail

glGetGraphicsResetStatusKHRback to summary
public static native int glGetGraphicsResetStatusKHR()

Indicates if the GL context has been in a reset state at any point since the last call to GetGraphicsResetStatus:

If a reset status other than NO_ERROR is returned and subsequent calls return NO_ERROR, the context reset was encountered and completed. If a reset status is repeatedly returned, the context may be in the process of resetting.

Reset notification behavior is determined at context creation time, and may be queried by calling GetIntegerv with the symbolic constant RESET_NOTIFICATION_STRATEGY_KHR.

If the reset notification behavior is NO_RESET_NOTIFICATION_KHR, then the implementation will never deliver notification of reset events, and GetGraphicsResetStatus will always return NO_ERROR.

If the behavior is LOSE_CONTEXT_ON_RESET_KHR, a graphics reset will result in a lost context and require creating a new context as described above. In this case GetGraphicsResetStatus will return an appropriate value from those described above.

If a graphics reset notification occurs in a context, a notification must also occur in all other contexts which share objects with that context.

After a graphics reset has occurred on a context, subsequent GL commands on that context (or any context which shares with that context) will generate a CONTEXT_LOST_KHR error. Such commands will not have side effects (in particular, they will not modify memory passed by pointer for query results, and may not block indefinitely or cause termination of the application. Exceptions to this behavior include:

  • GetError and GetGraphicsResetStatusKHR behave normally following a graphics reset, so that the application can determine a reset has occurred, and when it is safe to destroy and recreate the context.
  • Any commands which might cause a polling application to block indefinitely will generate a CONTEXT_LOST_KHR error, but will also return a value indicating completion to the application.
Annotations
@NativeType:GLenum
glGetnUniformfKHRback to summary
public static float glGetnUniformfKHR(int program, int location)

Returns the value or values of a uniform of the default uniform block.

Parameters
program:int

the program object

location:int

the uniform location

Annotations
@NativeType:void
glGetnUniformfvKHRback to summary
public static void glGetnUniformfvKHR(int program, int location, FloatBuffer params)

Returns the value or values of a uniform of the default uniform block.

Parameters
program:int

the program object

location:int

the uniform location

params:FloatBuffer

the buffer in which to place the returned data

glGetnUniformfvKHRback to summary
public static void glGetnUniformfvKHR(int program, int location, float[] params)

Array version of: GetnUniformfvKHR

glGetnUniformiKHRback to summary
public static float glGetnUniformiKHR(int program, int location)

Integer version of GetnUniformfvKHR.

Parameters
program:int

the program object

location:int

the uniform location

Annotations
@NativeType:void
glGetnUniformivKHRback to summary
public static void glGetnUniformivKHR(int program, int location, FloatBuffer params)

Integer version of GetnUniformfvKHR.

Parameters
program:int

the program object

location:int

the uniform location

params:FloatBuffer

the buffer in which to place the returned data

glGetnUniformivKHRback to summary
public static void glGetnUniformivKHR(int program, int location, float[] params)

Array version of: GetnUniformivKHR

glGetnUniformuiKHRback to summary
public static float glGetnUniformuiKHR(int program, int location)

Unsigned version of GetnUniformivKHR.

Parameters
program:int

the program object

location:int

the uniform location

Annotations
@NativeType:void
glGetnUniformuivKHRback to summary
public static void glGetnUniformuivKHR(int program, int location, FloatBuffer params)

Unsigned version of GetnUniformivKHR.

Parameters
program:int

the program object

location:int

the uniform location

params:FloatBuffer

the buffer in which to place the returned data

glGetnUniformuivKHRback to summary
public static void glGetnUniformuivKHR(int program, int location, float[] params)

Array version of: GetnUniformuivKHR

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, int bufSize, long pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

Parameters
x:int

the left pixel coordinate

y:int

the lower pixel coordinate

width:int

the number of pixels to read in the x-dimension

height:int

the number of pixels to read in the y-dimension

format:int

the pixel format

type:int

the pixel type

bufSize:int

the maximum number of bytes to write into data

pixels:long

a buffer in which to place the returned pixel data

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, ByteBuffer pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

Parameters
x:int

the left pixel coordinate

y:int

the lower pixel coordinate

width:int

the number of pixels to read in the x-dimension

height:int

the number of pixels to read in the y-dimension

format:int

the pixel format

type:int

the pixel type

pixels:ByteBuffer

a buffer in which to place the returned pixel data

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, ShortBuffer pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

Parameters
x:int

the left pixel coordinate

y:int

the lower pixel coordinate

width:int

the number of pixels to read in the x-dimension

height:int

the number of pixels to read in the y-dimension

format:int

the pixel format

type:int

the pixel type

pixels:ShortBuffer

a buffer in which to place the returned pixel data

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, IntBuffer pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

Parameters
x:int

the left pixel coordinate

y:int

the lower pixel coordinate

width:int

the number of pixels to read in the x-dimension

height:int

the number of pixels to read in the y-dimension

format:int

the pixel format

type:int

the pixel type

pixels:IntBuffer

a buffer in which to place the returned pixel data

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, FloatBuffer pixels)

Behaves identically to ReadPixels except that it does not write more than bufSize bytes into data

Parameters
x:int

the left pixel coordinate

y:int

the lower pixel coordinate

width:int

the number of pixels to read in the x-dimension

height:int

the number of pixels to read in the y-dimension

format:int

the pixel format

type:int

the pixel type

pixels:FloatBuffer

a buffer in which to place the returned pixel data

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, short[] pixels)

Array version of: ReadnPixelsKHR

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, int[] pixels)

Array version of: ReadnPixelsKHR

glReadnPixelsKHRback to summary
public static void glReadnPixelsKHR(int x, int y, int width, int height, int format, int type, float[] pixels)

Array version of: ReadnPixelsKHR

nglGetnUniformfvKHRback to summary
public static native void nglGetnUniformfvKHR(int program, int location, int bufSize, long params)

Unsafe version of: GetnUniformfvKHR

Parameters
bufSize:int

the maximum number of bytes to write to params

nglGetnUniformivKHRback to summary
public static native void nglGetnUniformivKHR(int program, int location, int bufSize, long params)

Unsafe version of: GetnUniformivKHR

Parameters
bufSize:int

the maximum number of bytes to write to params

nglGetnUniformuivKHRback to summary
public static native void nglGetnUniformuivKHR(int program, int location, int bufSize, long params)

Unsafe version of: GetnUniformuivKHR

Parameters
bufSize:int

the maximum number of bytes to write to params

nglReadnPixelsKHRback to summary
public static native void nglReadnPixelsKHR(int x, int y, int width, int height, int format, int type, int bufSize, long pixels)

Unsafe version of: ReadnPixelsKHR

Parameters
bufSize:int

the maximum number of bytes to write into data