GLAPI/glGetSamplerParameter

From OpenGL.org
Jump to: navigation, search
glGetSamplerParameter
Core in version 4.4
Core since version 3.3
Core ARB extension ARB_sampler_objects

glGetSamplerParameter: return sampler parameter values

Function Definition

 void glGetSamplerParameterfv(GLuint sampler​, GLenum pname​, GLfloat * params​);
 void glGetSamplerParameteriv(GLuint sampler​, GLenum pname​, GLint * params​);
 void glGetSamplerParameterIiv(GLuint sampler​, GLenum pname​, GLint * params​);
 void glGetSamplerParameterIuiv(GLuint sampler​, GLenum pname​, GLuint * params​);
sampler
Specifies name of the sampler object from which to retrieve parameters.
pname
Specifies the symbolic name of a sampler parameter. GL_TEXTURE_MAG_FILTER​, GL_TEXTURE_MIN_FILTER​, GL_TEXTURE_MIN_LOD​, GL_TEXTURE_MAX_LOD​, GL_TEXTURE_LOD_BIAS​, GL_TEXTURE_WRAP_S​, GL_TEXTURE_WRAP_T​, GL_TEXTURE_WRAP_R​, GL_TEXTURE_BORDER_COLOR​, GL_TEXTURE_COMPARE_MODE​, and GL_TEXTURE_COMPARE_FUNC​ are accepted.
params
Returns the sampler parameters.

Description

glGetSamplerParameter returns in params​ the value or values of the sampler parameter specified as pname​. sampler​ defines the target sampler, and must be the name of an existing sampler object, returned from a previous call to glGenSamplers. pname​ accepts the same symbols as glSamplerParameter, with the same interpretations:

GL_TEXTURE_MAG_FILTER​
Returns the single-valued texture magnification filter, a symbolic constant. The initial value is GL_LINEAR​.
GL_TEXTURE_MIN_FILTER​
Returns the single-valued texture minification filter, a symbolic constant. The initial value is GL_NEAREST_MIPMAP_LINEAR​.
GL_TEXTURE_MIN_LOD​
Returns the single-valued texture minimum level-of-detail value. The initial value is -1000.
GL_TEXTURE_MAX_LOD​
Returns the single-valued texture maximum level-of-detail value. The initial value is 1000.
GL_TEXTURE_WRAP_S​
Returns the single-valued wrapping function for texture coordinate s, a symbolic constant. The initial value is GL_REPEAT​.
GL_TEXTURE_WRAP_T​
Returns the single-valued wrapping function for texture coordinate s, a symbolic constant. The initial value is GL_REPEAT​.
GL_TEXTURE_WRAP_R​
Returns the single-valued wrapping function for texture coordinate s, a symbolic constant. The initial value is GL_REPEAT​.
GL_TEXTURE_BORDER_COLOR​
Returns four integer or floating-point numbers that comprise the RGBA color of the texture border. Floating-point values are returned in the range [0, 1]. Integer values are returned as a linear mapping of the internal floating-point representation such that 1.0 maps to the most positive representable integer and -1.0 maps to the most negative representable integer. The initial value is (0, 0, 0, 0).
GL_TEXTURE_COMPARE_MODE​
Returns a single-valued texture comparison mode, a symbolic constant. The initial value is GL_NONE​. See glSamplerParameter.
GL_TEXTURE_COMPARE_FUNC​
Returns a single-valued texture comparison function, a symbolic constant. The initial value is GL_LEQUAL​. See glSamplerParameter.

When the ParameterI​ forms of the function are used with GL_TEXTURE_BORDER_COLOR​, the border color is returned as an integer value, not a floating-point value.


Notes

If an error is generated, no change is made to the contents of params​.

glGetSamplerParameter is available only if the GL version is 3.3 or higher.

Errors

GL_INVALID_VALUE​ is generated if sampler​ is not the name of a sampler object returned from a previous call to glGenSamplers.

GL_INVALID_ENUM​ is generated if pname​ is not an accepted value.

See Also

glSamplerParameter, glGenSamplers, glDeleteSamplers

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.