GLAPI/glGetSamplerParameter: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adding better formatting.
m Bot: Adding better formatting.
 
(3 intermediate revisions by the same user not shown)
Line 11: Line 11:
   void '''glGetSamplerParameterfv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLfloat * {{param|params}});
   void '''glGetSamplerParameterfv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLfloat * {{param|params}});
   void '''glGetSamplerParameteriv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLint * {{param|params}});
   void '''glGetSamplerParameteriv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLint * {{param|params}});
  void '''glGetSamplerParameterIiv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLint * {{param|params}});
  void '''glGetSamplerParameterIuiv'''(GLuint {{param|sampler}}, GLenum {{param|pname}}, GLuint * {{param|params}});


; sampler
; sampler
: Specifies name of the sampler object from which to retrieve parameters.
: Specifies name of the sampler object from which to retrieve parameters.
; pname
; pname
: Specifies the symbolic name of a sampler parameter. {{code|GL_TEXTURE_MAG_FILTER}}, {{code|GL_TEXTURE_MIN_FILTER}}, {{code|GL_TEXTURE_MIN_LOD}}, {{code|GL_TEXTURE_MAX_LOD}}, {{code|GL_TEXTURE_LOD_BIAS}}, {{code|GL_TEXTURE_WRAP_S}}, {{code|GL_TEXTURE_WRAP_T}}, {{code|GL_TEXTURE_WRAP_R}}, {{code|GL_TEXTURE_BORDER_COLOR}}, {{code|GL_TEXTURE_COMPARE_MODE}}, and {{code|GL_TEXTURE_COMPARE_FUNC}} are accepted.
: Specifies the symbolic name of a sampler parameter. {{enum|GL_TEXTURE_MAG_FILTER}}, {{enum|GL_TEXTURE_MIN_FILTER}}, {{enum|GL_TEXTURE_MIN_LOD}}, {{enum|GL_TEXTURE_MAX_LOD}}, {{enum|GL_TEXTURE_LOD_BIAS}}, {{enum|GL_TEXTURE_WRAP_S}}, {{enum|GL_TEXTURE_WRAP_T}}, {{enum|GL_TEXTURE_WRAP_R}}, {{enum|GL_TEXTURE_BORDER_COLOR}}, {{enum|GL_TEXTURE_COMPARE_MODE}}, and {{enum|GL_TEXTURE_COMPARE_FUNC}} are accepted.
; params
; params
: Returns the sampler parameters.
: Returns the sampler parameters.
Line 23: Line 25:
'''glGetSamplerParameter''' returns in {{param|params}} the value or values of the sampler parameter specified as {{param|pname}}. {{param|sampler}} defines the target sampler, and must be the name of an existing sampler object, returned from a previous call to {{apifunc|glGenSamplers}}. {{param|pname}} accepts the same symbols as {{apifunc|glSamplerParameter}}, with the same interpretations:
'''glGetSamplerParameter''' returns in {{param|params}} the value or values of the sampler parameter specified as {{param|pname}}. {{param|sampler}} defines the target sampler, and must be the name of an existing sampler object, returned from a previous call to {{apifunc|glGenSamplers}}. {{param|pname}} accepts the same symbols as {{apifunc|glSamplerParameter}}, with the same interpretations:


; {{code|GL_TEXTURE_MAG_FILTER}}
; {{enum|GL_TEXTURE_MAG_FILTER}}
: Returns the single-valued texture magnification filter, a symbolic constant. The initial value is {{code|GL_LINEAR}}.
: Returns the single-valued texture magnification filter, a symbolic constant. The initial value is {{enum|GL_LINEAR}}.
; {{code|GL_TEXTURE_MIN_FILTER}}
; {{enum|GL_TEXTURE_MIN_FILTER}}
: Returns the single-valued texture minification filter, a symbolic constant. The initial value is {{code|GL_NEAREST_MIPMAP_LINEAR}}.
: Returns the single-valued texture minification filter, a symbolic constant. The initial value is {{enum|GL_NEAREST_MIPMAP_LINEAR}}.
; {{code|GL_TEXTURE_MIN_LOD}}
; {{enum|GL_TEXTURE_MIN_LOD}}
: Returns the single-valued texture minimum level-of-detail value. The initial value is -1000.
: Returns the single-valued texture minimum level-of-detail value. The initial value is -1000.
; {{code|GL_TEXTURE_MAX_LOD}}
; {{enum|GL_TEXTURE_MAX_LOD}}
: Returns the single-valued texture maximum level-of-detail value. The initial value is 1000.
: Returns the single-valued texture maximum level-of-detail value. The initial value is 1000.
; {{code|GL_TEXTURE_WRAP_S}}
; {{enum|GL_TEXTURE_WRAP_S}}
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{code|GL_REPEAT}}.
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{enum|GL_REPEAT}}.
; {{code|GL_TEXTURE_WRAP_T}}
; {{enum|GL_TEXTURE_WRAP_T}}
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{code|GL_REPEAT}}.
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{enum|GL_REPEAT}}.
; {{code|GL_TEXTURE_WRAP_R}}
; {{enum|GL_TEXTURE_WRAP_R}}
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{code|GL_REPEAT}}.
: Returns the single-valued wrapping function for texture coordinate ''s'', a symbolic constant. The initial value is {{enum|GL_REPEAT}}.
; {{code|GL_TEXTURE_BORDER_COLOR}}
; {{enum|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).
: 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).
; {{code|GL_TEXTURE_COMPARE_MODE}}
; {{enum|GL_TEXTURE_COMPARE_MODE}}
: Returns a single-valued texture comparison mode, a symbolic constant. The initial value is {{code|GL_NONE}}. See {{apifunc|glSamplerParameter}}.
: Returns a single-valued texture comparison mode, a symbolic constant. The initial value is {{enum|GL_NONE}}. See {{apifunc|glSamplerParameter}}.
; {{code|GL_TEXTURE_COMPARE_FUNC}}
; {{enum|GL_TEXTURE_COMPARE_FUNC}}
: Returns a single-valued texture comparison function, a symbolic constant. The initial value is {{code|GL_LEQUAL}}. See {{apifunc|glSamplerParameter}}.
: Returns a single-valued texture comparison function, a symbolic constant. The initial value is {{enum|GL_LEQUAL}}. See {{apifunc|glSamplerParameter}}.
 
When the {{code|ParameterI}} forms of the function are used with {{enum|GL_TEXTURE_BORDER_COLOR}}, the border color is returned as an integer value, not a floating-point value.
 
 
== Notes ==
== Notes ==


Line 51: Line 57:
== Errors ==
== Errors ==


{{code|GL_INVALID_VALUE}} is generated if {{param|sampler}} is not the name of a sampler object returned from a previous call to {{apifunc|glGenSamplers}}.
{{enum|GL_INVALID_VALUE}} is generated if {{param|sampler}} is not the name of a sampler object returned from a previous call to {{apifunc|glGenSamplers}}.


{{code|GL_INVALID_ENUM}} is generated if {{param|pname}} is not an accepted value.
{{enum|GL_INVALID_ENUM}} is generated if {{param|pname}} is not an accepted value.


== See Also ==
== See Also ==


{{apifunc|glSamplerParameter}}, {{apifunc|glGenSamplers}}, {{apifunc|glDeleteSamplers}}, {{apifunc|glSamplerParameter}}
{{apifunc|glSamplerParameter}}, {{apifunc|glGenSamplers}}, {{apifunc|glDeleteSamplers}}


== Copyright ==
== Copyright ==
Line 65: Line 71:
[[Category:Core API Reference|GetSamplerParameter]]
[[Category:Core API Reference|GetSamplerParameter]]
[[Category:Core API Ref Texturing|GetSamplerParameter]]
[[Category:Core API Ref Texturing|GetSamplerParameter]]
[[Category:Sampler Object API State Functions|GetSamplerParameter]]

Latest revision as of 10:01, 15 August 2013

glGetSamplerParameter
Core in version 4.6
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/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glGetSamplerParameter&oldid=11040"