Package org.lwjgl.opengl

Class EXTDebugLabel

java.lang.Object

org.lwjgl.opengl.EXTDebugLabel

public class EXTDebugLabel
extends java.lang.Object

Native bindings to the EXT_debug_label extension.

This extension defines a mechanism for OpenGL and OpenGL ES applications to label their objects (textures, buffers, shaders, etc.) with a descriptive string.

When profiling or debugging such an application within a debugger or profiler it is difficult to identify resources from their object names. Even when the resource itself is viewed it can be problematic to differentiate between similar resources. Attaching a label to an object helps obviate this difficulty.

The intended purpose of this is purely to improve the user experience within OpenGL and OpenGL ES development tools.

Field Summary

Fields

Modifier and Type	Field and Description
static int	GL_BUFFER_OBJECT_EXT GL_PROGRAM_OBJECT_EXT GL_PROGRAM_PIPELINE_OBJECT_EXT GL_QUERY_OBJECT_EXT GL_SHADER_OBJECT_EXT GL_VERTEX_ARRAY_OBJECT_EXT Accepted by the type parameter of LabelObjectEXT and GetObjectLabelEXT.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	glGetObjectLabelEXT(int type, int object, int bufSize)
static void	glGetObjectLabelEXT(int type, int object, int[] length, java.nio.ByteBuffer label) Array version of: GetObjectLabelEXT
static void	glGetObjectLabelEXT(int type, int object, java.nio.IntBuffer length, java.nio.ByteBuffer label)
static void	glLabelObjectEXT(int type, int object, java.nio.ByteBuffer label)
static void	glLabelObjectEXT(int type, int object, java.lang.CharSequence label)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GL_BUFFER_OBJECT_EXT, GL_SHADER_OBJECT_EXT, GL_PROGRAM_OBJECT_EXT, GL_VERTEX_ARRAY_OBJECT_EXT, GL_QUERY_OBJECT_EXT, GL_PROGRAM_PIPELINE_OBJECT_EXT

Accepted by the type parameter of LabelObjectEXT and GetObjectLabelEXT.

Method Detail

glLabelObjectEXT

public static void glLabelObjectEXT(int type,
                                    int object,
                                    java.nio.ByteBuffer label)

glLabelObjectEXT

public static void glLabelObjectEXT(int type,
                                    int object,
                                    java.lang.CharSequence label)

glGetObjectLabelEXT

public static void glGetObjectLabelEXT(int type,
                                       int object,
                                       java.nio.IntBuffer length,
                                       java.nio.ByteBuffer label)

glGetObjectLabelEXT

public static java.lang.String glGetObjectLabelEXT(int type,
                                                   int object,
                                                   int bufSize)

glGetObjectLabelEXT

public static void glGetObjectLabelEXT(int type,
                                       int object,
                                       int[] length,
                                       java.nio.ByteBuffer label)

Array version of: GetObjectLabelEXT