Top Description Fields Constructors Methods
org.lwjgl.opengl

public Class ARBTextureMultisample

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

This extension provides support for two new types of "multisample textures" - two-dimensional and two-dimensional array - as well as mechanisms to fetch a specific sample from such a texture in a shader, and to attach such textures to FBOs for rendering.

This extension also includes the following functionality, first described in NV_explicit_multisample:

Promoted to core in OpenGL 3.2.

Field Summary

Modifier and TypeField and Description
public static final int
GL_INT_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

public static final int
GL_INT_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

public static final int
GL_MAX_COLOR_TEXTURE_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_MAX_DEPTH_TEXTURE_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_MAX_INTEGER_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_MAX_SAMPLE_MASK_WORDS

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_PROXY_TEXTURE_2D_MULTISAMPLE

Accepted by the target parameter of TexImage2DMultisample.

public static final int
GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY

Accepted by the target parameter of TexImage3DMultisample.

public static final int
GL_SAMPLE_MASK

Accepted by the cap parameter of Enable, Disable, and IsEnabled, and by the pname parameter of GetBooleanv, GetIntegerv, GetFloatv, and GetDoublev.

public static final int
GL_SAMPLE_MASK_VALUE

Accepted by the target parameter of GetBooleani_v and GetIntegeri_v.

public static final int
GL_SAMPLE_POSITION

Accepted by the pname parameter of GetMultisamplefv.

public static final int
GL_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

public static final int
GL_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

public static final int
GL_TEXTURE_2D_MULTISAMPLE

Accepted by the target parameter of BindTexture and TexImage2DMultisample.

public static final int
GL_TEXTURE_2D_MULTISAMPLE_ARRAY

Accepted by the target parameter of BindTexture and TexImage3DMultisample.

public static final int
GL_TEXTURE_BINDING_2D_MULTISAMPLE

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

public static final int
GL_TEXTURE_FIXED_SAMPLE_LOCATIONS

Accepted by the pname parameter of GetTexLevelParameter.

public static final int
GL_TEXTURE_SAMPLES

Accepted by the pname parameter of GetTexLevelParameter.

public static final int
GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

public static final int
GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

Constructor Summary

AccessConstructor and Description
protected
ARBTextureMultisample()

Method Summary

Modifier and TypeMethod and Description
public static float
glGetMultisamplef(int
the sample parameter name. Must be:
SAMPLE_POSITION
pname, int
the index of the sample whose position to query
index)

Retrieves the location of a sample.

public static void
glGetMultisamplefv(int
the sample parameter name. Must be:
SAMPLE_POSITION
pname, int
the index of the sample whose position to query
index, FloatBuffer
an array to receive the position of the sample
val)

Retrieves the location of a sample.

public static void
glGetMultisamplefv(int pname, int index, float[] val)

Array version of: GetMultisamplefv

public static void
glSampleMaski(int
which 32-bit sub-word of the sample mask to update
index, int
the new value of the mask sub-word
mask)

Sets the value of a sub-word of the sample mask.

public static void
glTexImage2DMultisample(int
the target of the operation. One of:
TEXTURE_2D_MULTISAMPLEPROXY_TEXTURE_2D_MULTISAMPLE
target, int
the number of samples in the multisample texture's image
samples, int
the internal format to be used to store the multisample texture's image. internalformat must specify a color-renderable, depth-renderable, or stencil-renderable format.
internalformat, int
the width of the multisample texture's image, in texels
width, int
the height of the multisample texture's image, in texels
height, boolean
whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image
fixedsamplelocations)

Establishes the data storage, format, dimensions, and number of samples of a 2D multisample texture's image.

public static void
glTexImage3DMultisample(int
the target of the operation. One of:
TEXTURE_2D_MULTISAMPLE_ARRAYPROXY_TEXTURE_2D_MULTISAMPLE_ARRAY
target, int
the number of samples in the multisample texture's image
samples, int
the internal format to be used to store the multisample texture's image. internalformat must specify a color-renderable, depth-renderable, or stencil-renderable format.
internalformat, int
the width of the multisample texture's image, in texels
width, int
the height of the multisample texture's image, in texels
height, int
the depth of the multisample texture's image, in texels
depth, boolean
whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image
fixedsamplelocations)

Establishes the data storage, format, dimensions, and number of samples of a 3D multisample texture's image.

public static void
nglGetMultisamplefv(int pname, int index, long val)

Unsafe version of: GetMultisamplefv

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

GL_INT_SAMPLER_2D_MULTISAMPLEback to summary
public static final int GL_INT_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

GL_INT_SAMPLER_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_INT_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

GL_MAX_COLOR_TEXTURE_SAMPLESback to summary
public static final int GL_MAX_COLOR_TEXTURE_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_MAX_DEPTH_TEXTURE_SAMPLESback to summary
public static final int GL_MAX_DEPTH_TEXTURE_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_MAX_INTEGER_SAMPLESback to summary
public static final int GL_MAX_INTEGER_SAMPLES

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_MAX_SAMPLE_MASK_WORDSback to summary
public static final int GL_MAX_SAMPLE_MASK_WORDS

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_PROXY_TEXTURE_2D_MULTISAMPLEback to summary
public static final int GL_PROXY_TEXTURE_2D_MULTISAMPLE

Accepted by the target parameter of TexImage2DMultisample.

GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY

Accepted by the target parameter of TexImage3DMultisample.

GL_SAMPLE_MASKback to summary
public static final int GL_SAMPLE_MASK

Accepted by the cap parameter of Enable, Disable, and IsEnabled, and by the pname parameter of GetBooleanv, GetIntegerv, GetFloatv, and GetDoublev.

GL_SAMPLE_MASK_VALUEback to summary
public static final int GL_SAMPLE_MASK_VALUE

Accepted by the target parameter of GetBooleani_v and GetIntegeri_v.

GL_SAMPLE_POSITIONback to summary
public static final int GL_SAMPLE_POSITION

Accepted by the pname parameter of GetMultisamplefv.

GL_SAMPLER_2D_MULTISAMPLEback to summary
public static final int GL_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

GL_SAMPLER_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

GL_TEXTURE_2D_MULTISAMPLEback to summary
public static final int GL_TEXTURE_2D_MULTISAMPLE

Accepted by the target parameter of BindTexture and TexImage2DMultisample.

GL_TEXTURE_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_TEXTURE_2D_MULTISAMPLE_ARRAY

Accepted by the target parameter of BindTexture and TexImage3DMultisample.

GL_TEXTURE_BINDING_2D_MULTISAMPLEback to summary
public static final int GL_TEXTURE_BINDING_2D_MULTISAMPLE

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY

Accepted by the pname parameter of GetBooleanv, GetDoublev, GetIntegerv, and GetFloatv.

GL_TEXTURE_FIXED_SAMPLE_LOCATIONSback to summary
public static final int GL_TEXTURE_FIXED_SAMPLE_LOCATIONS

Accepted by the pname parameter of GetTexLevelParameter.

GL_TEXTURE_SAMPLESback to summary
public static final int GL_TEXTURE_SAMPLES

Accepted by the pname parameter of GetTexLevelParameter.

GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLEback to summary
public static final int GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE

Returned by the type parameter of GetActiveUniform.

GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE_ARRAYback to summary
public static final int GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE_ARRAY

Returned by the type parameter of GetActiveUniform.

Constructor Detail

ARBTextureMultisampleback to summary
protected ARBTextureMultisample()

Method Detail

glGetMultisamplefback to summary
public static float glGetMultisamplef(int pname, int index)

Retrieves the location of a sample.

Parameters
pname:int

the sample parameter name. Must be:

SAMPLE_POSITION
index:int

the index of the sample whose position to query

Annotations
@NativeType:void
glGetMultisamplefvback to summary
public static void glGetMultisamplefv(int pname, int index, FloatBuffer val)

Retrieves the location of a sample.

Parameters
pname:int

the sample parameter name. Must be:

SAMPLE_POSITION
index:int

the index of the sample whose position to query

val:FloatBuffer

an array to receive the position of the sample

glGetMultisamplefvback to summary
public static void glGetMultisamplefv(int pname, int index, float[] val)

Array version of: GetMultisamplefv

glSampleMaskiback to summary
public static void glSampleMaski(int index, int mask)

Sets the value of a sub-word of the sample mask.

Parameters
index:int

which 32-bit sub-word of the sample mask to update

mask:int

the new value of the mask sub-word

glTexImage2DMultisampleback to summary
public static void glTexImage2DMultisample(int target, int samples, int internalformat, int width, int height, boolean fixedsamplelocations)

Establishes the data storage, format, dimensions, and number of samples of a 2D multisample texture's image.

Parameters
target:int

the target of the operation. One of:

TEXTURE_2D_MULTISAMPLEPROXY_TEXTURE_2D_MULTISAMPLE
samples:int

the number of samples in the multisample texture's image

internalformat:int

the internal format to be used to store the multisample texture's image. internalformat must specify a color-renderable, depth-renderable, or stencil-renderable format.

width:int

the width of the multisample texture's image, in texels

height:int

the height of the multisample texture's image, in texels

fixedsamplelocations:boolean

whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image

glTexImage3DMultisampleback to summary
public static void glTexImage3DMultisample(int target, int samples, int internalformat, int width, int height, int depth, boolean fixedsamplelocations)

Establishes the data storage, format, dimensions, and number of samples of a 3D multisample texture's image.

Parameters
target:int

the target of the operation. One of:

TEXTURE_2D_MULTISAMPLE_ARRAYPROXY_TEXTURE_2D_MULTISAMPLE_ARRAY
samples:int

the number of samples in the multisample texture's image

internalformat:int

the internal format to be used to store the multisample texture's image. internalformat must specify a color-renderable, depth-renderable, or stencil-renderable format.

width:int

the width of the multisample texture's image, in texels

height:int

the height of the multisample texture's image, in texels

depth:int

the depth of the multisample texture's image, in texels

fixedsamplelocations:boolean

whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image

nglGetMultisamplefvback to summary
public static void nglGetMultisamplefv(int pname, int index, long val)

Unsafe version of: GetMultisamplefv