Package org.lwjgl.opengl

Class NVBindlessTexture

java.lang.Object

org.lwjgl.opengl.NVBindlessTexture

public class NVBindlessTexture
extends java.lang.Object

Native bindings to the NV_bindless_texture extension.

This extension allows OpenGL applications to access texture objects in shaders without first binding each texture to one of a limited number of texture image units. Using this extension, an application can query a 64-bit unsigned integer texture handle for each texture that it wants to access and then use that handle directly in GLSL or assembly-based shaders. The ability to access textures without having to bind and/or re-bind them is similar to the capability provided by the NV_shader_buffer_load extension that allows shaders to access buffer objects without binding them. In both cases, these extensions significantly reduce the amount of API and internal GL driver overhead needed to manage resource bindings.

This extension also provides similar capability for the image load, store, and atomic functionality provided by OpenGL 4.2, OpenGL ES 3.1 and the ARB_shader_image_load_store and EXT_shader_image_load_store extensions, where a texture can be accessed without first binding it to an image unit. An image handle can be extracted from a texture object using an API with a set of parameters similar to those for BindImageTextureEXT.

This extension adds no new data types to GLSL. Instead, it uses existing sampler and image data types and allows them to be populated with texture and image handles. This extension does permit sampler and image data types to be used in more contexts than in unextended GLSL 4.00. In particular, sampler and image types may be used as shader inputs/outputs, temporary variables, and uniform block members, and may be assigned to by shader code. Constructors are provided to convert 64-bit unsigned integer values to and from sampler and image data types. Additionally, new APIs are provided to load values for sampler and image uniforms with 64-bit handle inputs. The use of existing integer-based Uniform* APIs is still permitted, in which case the integer specified will identify a texture image or image unit. For samplers and images with values specified as texture image or image units, the GL implemenation will translate the unit number to an internal handle as required.

To access texture or image resources using handles, the handles must first be made resident. Accessing a texture or image by handle without first making it resident can result in undefined results, including program termination. Since the amount of texture memory required by an application may exceed the amount of memory available to the system, this extension provides API calls allowing applications to manage overall texture memory consumption by making a texture resident and non-resident as required.

Requires OpenGL 4.0.

Method Summary

Modifier and Type	Method	Description
static long	glGetImageHandleNV(int texture, int level, boolean layered, int layer, int format)	Creates and returns an image handle for level level of the texture named texture.
static long	glGetTextureHandleNV(int texture)	Creates a texture handle using the current state of the texture named texture, including any embedded sampler state.
static long	glGetTextureSamplerHandleNV(int texture, int sampler)	Creates a texture handle using the current non-sampler state from the texture named texture and the sampler state from the sampler object sampler.
static boolean	glIsImageHandleResidentNV(long handle)	Returns TRUE if the specified image handle is resident in the current context.
static boolean	glIsTextureHandleResidentNV(long handle)	Returns TRUE if the specified texture handle is resident in the current context.
static void	glMakeImageHandleNonResidentNV(long handle)	Makes an image handle inaccessible to shaders.
static void	glMakeImageHandleResidentNV(long handle, int access)	Makes an image handle resident, so that it is accessible to shaders for image loads, stores, and atomic operations.
static void	glMakeTextureHandleNonResidentNV(long handle)	Makes a texture handle inaccessible to shaders.
static void	glMakeTextureHandleResidentNV(long handle)	Make a texture handle resident, so that it is accessible to shaders for texture mapping operations.
static void	glProgramUniformHandleui64NV(int program, int location, long value)	DSA version of UniformHandleui64NV.
static void	glProgramUniformHandleui64vNV(int program, int location, long[] values)	Array version of: ProgramUniformHandleui64vNV
static void	glProgramUniformHandleui64vNV(int program, int location, java.nio.LongBuffer values)	DSA version of UniformHandleui64vNV.
static void	glUniformHandleui64NV(int location, long value)	Loads a 64-bit unsigned integer handle into a uniform location corresponding to sampler or image variable types.
static void	glUniformHandleui64vNV(int location, long[] values)	Array version of: UniformHandleui64vNV
static void	glUniformHandleui64vNV(int location, java.nio.LongBuffer values)	Loads count 64-bit unsigned integer handles into a uniform location corresponding to sampler or image variable types.
static void	nglProgramUniformHandleui64vNV(int program, int location, int count, long values)	Unsafe version of: ProgramUniformHandleui64vNV
static void	nglUniformHandleui64vNV(int location, int count, long values)	Unsafe version of: UniformHandleui64vNV

Methods inherited from class java.lang.Object

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

Method Detail

glGetTextureHandleNV

public static long glGetTextureHandleNV(int texture)

Creates a texture handle using the current state of the texture named texture, including any embedded sampler state. See GetTextureSamplerHandleNV for details.

Parameters:

texture - the texture object

glGetTextureSamplerHandleNV

public static long glGetTextureSamplerHandleNV(int texture,
                                               int sampler)

Creates a texture handle using the current non-sampler state from the texture named texture and the sampler state from the sampler object sampler. In both cases, a 64-bit unsigned integer handle is returned. The error INVALID_VALUE is generated if texture is zero or is not the name of an existing texture object or if sampler is zero or is not the name of an existing sampler object. The error INVALID_OPERATION is generated if the texture object texture is not complete. If an error occurs, a handle of zero is returned.

The error INVALID_OPERATION is generated if the border color (taken from the embedded sampler for GetTextureHandleNV or from the sampler for GetTextureSamplerHandleNV) is not one of the following allowed values. If the texture's base internal format is signed or unsigned integer, allowed values are (0,0,0,0), (0,0,0,1), (1,1,1,0), and (1,1,1,1). If the base internal format is not integer, allowed values are (0.0,0.0,0.0,0.0), (0.0,0.0,0.0,1.0), (1.0,1.0,1.0,0.0), and (1.0,1.0,1.0,1.0).

The handle for each texture or texture/sampler pair is unique; the same handle will be returned if GetTextureHandleNV is called multiple times for the same texture or if GetTextureSamplerHandleNV is called multiple times for the same texture/sampler pair.

When a texture object is referenced by one or more texture handles, the texture parameters of the object may not be changed, and the size and format of the images in the texture object may not be re-specified. The error INVALID_OPERATION is generated if the functions TexImage*, CopyTexImage*, CompressedTexImage*, TexBuffer*, or TexParameter* are called to modify a texture object referenced by one or more texture handles. The contents of the images in a texture object may still be updated via commands such as TexSubImage*, CopyTexSubImage*, and CompressedTexSubImage*, and by rendering to a framebuffer object, even if the texture object is referenced by one or more texture handles.

The error INVALID_OPERATION is generated by BufferData if it is called to modify a buffer object bound to a buffer texture while that texture object is referenced by one or more texture handles. The contents of the buffer object may still be updated via buffer update commands such as BufferSubData and MapBuffer*, or via the texture update commands, even if the buffer is bound to a texture while that buffer texture object is referenced by one or more texture handles.

When a sampler object is referenced by one or more texture handles, the sampler parameters of the object may not be changed. The error INVALID_OPERATION is generated when calling SamplerParameter* functions to modify a sampler object referenced by one or more texture handles.

Parameters:

texture - the texture object

sampler - the sampler object

glMakeTextureHandleResidentNV

public static void glMakeTextureHandleResidentNV(long handle)

Make a texture handle resident, so that it is accessible to shaders for texture mapping operations.

While the texture handle is resident, it may be used in texture mapping operations. If a shader attempts to perform a texture mapping operation using a handle that is not resident, the results of that operation are undefined and may lead to application termination. When a texture handle is resident, the texture it references is also considered resident for the purposes of the AreTexturesResident command. The error INVALID_OPERATION is generated if handle is not a valid texture handle, or if handle is already resident in the current GL context.

Parameters:

handle - the texture handle

glMakeTextureHandleNonResidentNV

public static void glMakeTextureHandleNonResidentNV(long handle)

Makes a texture handle inaccessible to shaders.

The error INVALID_OPERATION is generated if handle is not a valid texture handle, or if handle is not resident in the current GL context.

Parameters:

handle - the texture handle

glGetImageHandleNV

public static long glGetImageHandleNV(int texture,
                                      int level,
                                      boolean layered,
                                      int layer,
                                      int format)

Creates and returns an image handle for level level of the texture named texture. If layered is TRUE, a handle is created for the entire texture level. If layered is FALSE, a handle is created for only the layer layer of the texture level. format specifies a format used to interpret the texels of the image when used for image loads, stores, and atomics, and has the same meaning as the format parameter of BindImageTextureEXT(). A 64-bit unsigned integer handle is returned if the command succeeds; otherwise, zero is returned.

The error INVALID_VALUE is generated by GetImageHandleNV if:

• texture is zero or not the name of an existing texture object;
• the image for the texture level level doesn't exist (i.e., has a size of zero in texture); or
• layered is FALSE and layer is greater than or equal to the number of layers in the image at level level.

The error INVALID_OPERATION is generated by GetImageHandleNV if:

• the texture object texture is not complete (section 3.9.14);
• layered is TRUE and the texture is not a three-dimensional, one-dimensional array, two dimensional array, cube map, or cube map array texture.

When a texture object is referenced by one or more image handles, the texture parameters of the object may not be changed, and the size and format of the images in the texture object may not be re-specified. The error INVALID_OPERATION is generated when calling TexImage*, CopyTexImage*, CompressedTexImage*, TexBuffer*, or TexParameter* functions while a texture object is referenced by one or more image handles. The contents of the images in a texture object may still be updated via commands such as TexSubImage*, CopyTexSubImage*, and CompressedTexSubImage*, and by rendering to a framebuffer object, even if the texture object is referenced by one or more image handles.

The error INVALID_OPERATION is generated by BufferData if it is called to modify a buffer object bound to a buffer texture while that texture object is referenced by one or more image handles. The contents of the buffer object may still be updated via buffer update commands such as BufferSubData and MapBuffer*, or via the texture update commands, even if the buffer is bound to a texture while that buffer texture object is referenced by one or more image handles.

The handle returned for each combination of texture, level, layered, layer, and format is unique; the same handle will be returned if GetImageHandleNV is called multiple times with the same parameters.

Parameters:

texture - the texture object

level - the texture level

layered - the layered flag

layer - the texture layer

format - the texture format

glMakeImageHandleResidentNV

public static void glMakeImageHandleResidentNV(long handle,
                                               int access)

Makes an image handle resident, so that it is accessible to shaders for image loads, stores, and atomic operations.

access specifies whether the texture bound to the image handle will be treated as READ_ONLY, WRITE_ONLY, or READ_WRITE. If a shader reads from an image handle made resident as WRITE_ONLY, or writes to an image handle made resident as READ_ONLY, the results of that shader operation are undefined and may lead to application termination. The error INVALID_OPERATION is generated if handle is not a valid image handle, or if handle is already resident in the current GL context.

While the image handle is resident, it may be used in image load, store, and atomic operations. If a shader attempts to perform an image operation using a handle that is not resident, the results of that operation are undefined and may lead to application termination. When an image handle is resident, the texture it references is not necessarily considered resident for the purposes of the AreTexturesResident command.

Parameters:

handle - the image handle

access - the access type. One of:

READ_ONLY

WRITE_ONLY

READ_WRITE

glMakeImageHandleNonResidentNV

public static void glMakeImageHandleNonResidentNV(long handle)

Makes an image handle inaccessible to shaders.

Parameters:

handle - the image handle

glUniformHandleui64NV

public static void glUniformHandleui64NV(int location,
                                         long value)

Loads a 64-bit unsigned integer handle into a uniform location corresponding to sampler or image variable types.

Parameters:

location - the uniform location

value - the handle value

nglUniformHandleui64vNV

public static void nglUniformHandleui64vNV(int location,
                                           int count,
                                           long values)

Unsafe version of: UniformHandleui64vNV

Parameters:

count - the number of handles to load

glUniformHandleui64vNV

public static void glUniformHandleui64vNV(int location,
                                          java.nio.LongBuffer values)

Loads count 64-bit unsigned integer handles into a uniform location corresponding to sampler or image variable types.

Parameters:

location - the uniform location

values - a buffer from which to load the handles

glProgramUniformHandleui64NV

public static void glProgramUniformHandleui64NV(int program,
                                                int location,
                                                long value)

DSA version of UniformHandleui64NV.

Parameters:

program - the program object

location - the uniform location

value - the handle value

nglProgramUniformHandleui64vNV

public static void nglProgramUniformHandleui64vNV(int program,
                                                  int location,
                                                  int count,
                                                  long values)

Unsafe version of: ProgramUniformHandleui64vNV

Parameters:

count - the number of handles to load

glProgramUniformHandleui64vNV

public static void glProgramUniformHandleui64vNV(int program,
                                                 int location,
                                                 java.nio.LongBuffer values)

DSA version of UniformHandleui64vNV.

Parameters:

program - the program object

location - the uniform location

values - a buffer from which to load the handles

glIsTextureHandleResidentNV

public static boolean glIsTextureHandleResidentNV(long handle)

Returns TRUE if the specified texture handle is resident in the current context.

Parameters:

handle - the texture handle

glIsImageHandleResidentNV

public static boolean glIsImageHandleResidentNV(long handle)

Returns TRUE if the specified image handle is resident in the current context.

Parameters:

handle - the image handle

glUniformHandleui64vNV

public static void glUniformHandleui64vNV(int location,
                                          long[] values)

Array version of: UniformHandleui64vNV

glProgramUniformHandleui64vNV

public static void glProgramUniformHandleui64vNV(int program,
                                                 int location,
                                                 long[] values)

Array version of: ProgramUniformHandleui64vNV