Difference between revisions of "GLAPI/glGetTexParameter"

From OpenGL Wiki
Jump to: navigation, search
m (Bot: Adding better formatting.)
m (Bot: Adding better formatting.)
 
(3 intermediate revisions by 2 users not shown)
Line 16: Line 16:
 
: Specifies the symbolic name of the target texture. {{enum|GL_TEXTURE_1D}}, {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_2D_ARRAY}}, {{enum|GL_TEXTURE_3D}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_TEXTURE_CUBE_MAP}}, and {{enum|GL_TEXTURE_CUBE_MAP_ARRAY}} are accepted.
 
: Specifies the symbolic name of the target texture. {{enum|GL_TEXTURE_1D}}, {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_2D_ARRAY}}, {{enum|GL_TEXTURE_3D}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_TEXTURE_CUBE_MAP}}, and {{enum|GL_TEXTURE_CUBE_MAP_ARRAY}} are accepted.
 
; pname
 
; pname
: Specifies the symbolic name of a texture parameter. {{enum|GL_TEXTURE_BASE_LEVEL}}, {{enum|GL_TEXTURE_BORDER_COLOR}}, {{enum|GL_TEXTURE_COMPARE_MODE}}, {{enum|GL_TEXTURE_COMPARE_FUNC}}, {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}}, {{enum|GL_TEXTURE_LOD_BIAS}}, {{enum|GL_TEXTURE_MAG_FILTER}}, {{enum|GL_TEXTURE_MAX_LEVEL}}, {{enum|GL_TEXTURE_MAX_LOD}}, {{enum|GL_TEXTURE_MIN_FILTER}}, {{enum|GL_TEXTURE_MIN_LOD}}, {{enum|GL_TEXTURE_SWIZZLE_R}}, {{enum|GL_TEXTURE_SWIZZLE_G}}, {{enum|GL_TEXTURE_SWIZZLE_B}}, {{enum|GL_TEXTURE_SWIZZLE_A}}, {{enum|GL_TEXTURE_SWIZZLE_RGBA}}, {{enum|GL_TEXTURE_WRAP_S}}, {{enum|GL_TEXTURE_WRAP_T}}, and {{enum|GL_TEXTURE_WRAP_R}} are accepted.
+
: Specifies the symbolic name of a texture parameter. {{enum|GL_DEPTH_STENCIL_TEXTURE_MODE}}, {{enum|GL_TEXTURE_BASE_LEVEL}}, {{enum|GL_TEXTURE_BORDER_COLOR}}, {{enum|GL_TEXTURE_COMPARE_MODE}}, {{enum|GL_TEXTURE_COMPARE_FUNC}}, {{enum|GL_TEXTURE_IMMUTABLE_FORMAT}}, {{enum|GL_TEXTURE_IMMUTABLE_LEVELS}}, {{enum|GL_TEXTURE_LOD_BIAS}}, {{enum|GL_TEXTURE_MAG_FILTER}}, {{enum|GL_TEXTURE_MAX_LEVEL}}, {{enum|GL_TEXTURE_MAX_LOD}}, {{enum|GL_TEXTURE_MIN_FILTER}}, {{enum|GL_TEXTURE_MIN_LOD}}, {{enum|GL_TEXTURE_SWIZZLE_R}}, {{enum|GL_TEXTURE_SWIZZLE_G}}, {{enum|GL_TEXTURE_SWIZZLE_B}}, {{enum|GL_TEXTURE_SWIZZLE_A}}, {{enum|GL_TEXTURE_SWIZZLE_RGBA}}, {{enum|GL_TEXTURE_VIEW_MIN_LAYER}}, {{enum|GL_TEXTURE_VIEW_MIN_LEVEL}}, {{enum|GL_TEXTURE_VIEW_NUM_LAYERS}}, {{enum|GL_TEXTURE_VIEW_NUM_LEVELS}}, {{enum|GL_TEXTURE_WRAP_S}}, {{enum|GL_TEXTURE_WRAP_T}}, and {{enum|GL_TEXTURE_WRAP_R}} are accepted.
 
; params
 
; params
 
: Returns the texture parameters.
 
: Returns the texture parameters.
Line 24: Line 24:
 
'''glGetTexParameter''' returns in {{param|params}} the value or values of the texture parameter specified as {{param|pname}}. {{param|target}} defines the target texture. {{enum|GL_TEXTURE_1D}}, {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_3D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_2D_ARRAY}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_TEXTURE_CUBE_MAP}}, {{enum|GL_TEXTURE_CUBE_MAP_ARRAY}} specify one-, two-, or three-dimensional, one-dimensional array, two-dimensional array, rectangle, cube-mapped or cube-mapped array texturing, respectively. {{param|pname}} accepts the same symbols as {{apifunc|glTexParameter}}, with the same interpretations:
 
'''glGetTexParameter''' returns in {{param|params}} the value or values of the texture parameter specified as {{param|pname}}. {{param|target}} defines the target texture. {{enum|GL_TEXTURE_1D}}, {{enum|GL_TEXTURE_2D}}, {{enum|GL_TEXTURE_3D}}, {{enum|GL_TEXTURE_1D_ARRAY}}, {{enum|GL_TEXTURE_2D_ARRAY}}, {{enum|GL_TEXTURE_RECTANGLE}}, {{enum|GL_TEXTURE_CUBE_MAP}}, {{enum|GL_TEXTURE_CUBE_MAP_ARRAY}} specify one-, two-, or three-dimensional, one-dimensional array, two-dimensional array, rectangle, cube-mapped or cube-mapped array texturing, respectively. {{param|pname}} accepts the same symbols as {{apifunc|glTexParameter}}, with the same interpretations:
  
 +
; {{enum|GL_DEPTH_STENCIL_TEXTURE_MODE}}
 +
: Returns the single-value depth stencil texture mode, a symbolic constant. The initial value is {{enum|GL_DEPTH_COMPONENT}}.
 
; {{enum|GL_TEXTURE_MAG_FILTER}}
 
; {{enum|GL_TEXTURE_MAG_FILTER}}
 
: Returns the single-valued texture magnification filter, a symbolic constant. The initial value is {{enum|GL_LINEAR}}.
 
: Returns the single-valued texture magnification filter, a symbolic constant. The initial value is {{enum|GL_LINEAR}}.
Line 29: Line 31:
 
: Returns the single-valued texture minification filter, a symbolic constant. The initial value is {{enum|GL_NEAREST_MIPMAP_LINEAR}}.
 
: Returns the single-valued texture minification filter, a symbolic constant. The initial value is {{enum|GL_NEAREST_MIPMAP_LINEAR}}.
 
; {{enum|GL_TEXTURE_MIN_LOD}}
 
; {{enum|GL_TEXTURE_MIN_LOD}}
: Returns the single-valued texture minimum level-of-detail value. The initial value is -1000.
 
 
; {{enum|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.
Line 58: Line 59:
 
; {{enum|GL_TEXTURE_COMPARE_FUNC}}
 
; {{enum|GL_TEXTURE_COMPARE_FUNC}}
 
: Returns a single-valued texture comparison function, a symbolic constant. The initial value is {{enum|GL_LEQUAL}}. See {{apifunc|glTexParameter}}.
 
: Returns a single-valued texture comparison function, a symbolic constant. The initial value is {{enum|GL_LEQUAL}}. See {{apifunc|glTexParameter}}.
 +
; {{enum|GL_TEXTURE_VIEW_MIN_LEVEL}}
 +
: Returns a single-valued base level of a texture view relative to its parent. The initial value is 0. See {{apifunc|glTextureView}}.
 +
; {{enum|GL_TEXTURE_VIEW_NUM_LEVELS}}
 +
: Returns a single-valued number of levels of detail of a texture view. See {{apifunc|glTextureView}}.
 +
; {{enum|GL_TEXTURE_VIEW_MIN_LAYER}}
 +
: Returns a single-valued first level of a texture array view relative to its parent. See {{apifunc|glTextureView}}.
 +
; {{enum|GL_TEXTURE_VIEW_NUM_LAYERS}}
 +
: Returns a single-valued number of layers in a texture array view. See {{apifunc|glTextureView}}.
 +
; {{enum|GL_TEXTURE_IMMUTABLE_LEVELS}}
 +
: Returns a single-valued number of immutable texture levels in a texture view. See {{apifunc|glTextureView}}.
 
In addition to the parameters that may be set with {{apifunc|glTexParameter}}, '''glGetTexParameter''' accepts the following read-only parameters:
 
In addition to the parameters that may be set with {{apifunc|glTexParameter}}, '''glGetTexParameter''' accepts the following read-only parameters:
  
Line 65: Line 76:
  
 
If an error is generated, no change is made to the contents of {{param|params}}.
 
If an error is generated, no change is made to the contents of {{param|params}}.
 +
 +
{{enum|GL_DEPTH_STENCIL_TEXTURE_MODE}}, {{enum|GL_TEXTURE_VIEW_MIN_LEVEL}}, {{enum|GL_TEXTURE_VIEW_NUM_LEVELS}}, {{enum|GL_TEXTURE_VIEW_MIN_LAYER}}, {{enum|GL_TEXTURE_VIEW_NUM_LAYERS}} and {{enum|GL_TEXTURE_IMMUTABLE_LEVELS}} are available only if the GL version is 4.3 or greater.
  
 
== Errors ==
 
== Errors ==
Line 72: Line 85:
 
== See Also ==
 
== See Also ==
  
{{apifunc|glTexParameter}}, {{apifunc|glTexStorage1D}}, {{apifunc|glTexStorage2D}}, {{apifunc|glTexStorage3D}}
+
{{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}, {{apifunc|glGetTexLevelParameter}}, {{apifunc|glTexParameter}}
  
 
== Copyright ==
 
== Copyright ==
  
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/].
+
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2012 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/].
  
 
[[Category:Core API Reference|GetTexParameter]]
 
[[Category:Core API Reference|GetTexParameter]]
 
[[Category:Core API Ref Texturing|GetTexParameter]]
 
[[Category:Core API Ref Texturing|GetTexParameter]]
 +
[[Category:Texture Object API State Functions|GetTexParameter]]

Latest revision as of 10:01, 15 August 2013

glGetTexParameter
Core in version 4.6
Core since version 1.0

glGetTexParameter: return texture parameter values

Function Definition

 void glGetTexParameterfv(GLenum target​, GLenum pname​, GLfloat * params​);
 void glGetTexParameteriv(GLenum target​, GLenum pname​, GLint * params​);
 void glGetTexParameterIiv(GLenum target​, GLenum pname​, GLint * params​);
 void glGetTexParameterIuiv(GLenum target​, GLenum pname​, GLuint * params​);
target
Specifies the symbolic name of the target texture. GL_TEXTURE_1D, GL_TEXTURE_2D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_3D, GL_TEXTURE_RECTANGLE, GL_TEXTURE_CUBE_MAP, and GL_TEXTURE_CUBE_MAP_ARRAY are accepted.
pname
Specifies the symbolic name of a texture parameter. GL_DEPTH_STENCIL_TEXTURE_MODE, GL_TEXTURE_BASE_LEVEL, GL_TEXTURE_BORDER_COLOR, GL_TEXTURE_COMPARE_MODE, GL_TEXTURE_COMPARE_FUNC, GL_TEXTURE_IMMUTABLE_FORMAT, GL_TEXTURE_IMMUTABLE_LEVELS, GL_TEXTURE_LOD_BIAS, GL_TEXTURE_MAG_FILTER, GL_TEXTURE_MAX_LEVEL, GL_TEXTURE_MAX_LOD, GL_TEXTURE_MIN_FILTER, GL_TEXTURE_MIN_LOD, GL_TEXTURE_SWIZZLE_R, GL_TEXTURE_SWIZZLE_G, GL_TEXTURE_SWIZZLE_B, GL_TEXTURE_SWIZZLE_A, GL_TEXTURE_SWIZZLE_RGBA, GL_TEXTURE_VIEW_MIN_LAYER, GL_TEXTURE_VIEW_MIN_LEVEL, GL_TEXTURE_VIEW_NUM_LAYERS, GL_TEXTURE_VIEW_NUM_LEVELS, GL_TEXTURE_WRAP_S, GL_TEXTURE_WRAP_T, and GL_TEXTURE_WRAP_R are accepted.
params
Returns the texture parameters.

Description

glGetTexParameter returns in params​ the value or values of the texture parameter specified as pname​. target​ defines the target texture. GL_TEXTURE_1D, GL_TEXTURE_2D, GL_TEXTURE_3D, GL_TEXTURE_1D_ARRAY, GL_TEXTURE_2D_ARRAY, GL_TEXTURE_RECTANGLE, GL_TEXTURE_CUBE_MAP, GL_TEXTURE_CUBE_MAP_ARRAY specify one-, two-, or three-dimensional, one-dimensional array, two-dimensional array, rectangle, cube-mapped or cube-mapped array texturing, respectively. pname​ accepts the same symbols as glTexParameter, with the same interpretations:

GL_DEPTH_STENCIL_TEXTURE_MODE
Returns the single-value depth stencil texture mode, a symbolic constant. The initial value is GL_DEPTH_COMPONENT.
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
GL_TEXTURE_MAX_LOD
Returns the single-valued texture maximum level-of-detail value. The initial value is 1000.
GL_TEXTURE_BASE_LEVEL
Returns the single-valued base texture mipmap level. The initial value is 0.
GL_TEXTURE_MAX_LEVEL
Returns the single-valued maximum texture mipmap array level. The initial value is 1000.
GL_TEXTURE_SWIZZLE_R
Returns the red component swizzle. The initial value is GL_RED.
GL_TEXTURE_SWIZZLE_G
Returns the green component swizzle. The initial value is GL_GREEN.
GL_TEXTURE_SWIZZLE_B
Returns the blue component swizzle. The initial value is GL_BLUE.
GL_TEXTURE_SWIZZLE_A
Returns the alpha component swizzle. The initial value is GL_ALPHA.
GL_TEXTURE_SWIZZLE_RGBA
Returns the component swizzle for all channels in a single query.
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 t, a symbolic constant. The initial value is GL_REPEAT.
GL_TEXTURE_WRAP_R
Returns the single-valued wrapping function for texture coordinate r, 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 glTexParameter.
GL_TEXTURE_COMPARE_FUNC
Returns a single-valued texture comparison function, a symbolic constant. The initial value is GL_LEQUAL. See glTexParameter.
GL_TEXTURE_VIEW_MIN_LEVEL
Returns a single-valued base level of a texture view relative to its parent. The initial value is 0. See glTextureView.
GL_TEXTURE_VIEW_NUM_LEVELS
Returns a single-valued number of levels of detail of a texture view. See glTextureView.
GL_TEXTURE_VIEW_MIN_LAYER
Returns a single-valued first level of a texture array view relative to its parent. See glTextureView.
GL_TEXTURE_VIEW_NUM_LAYERS
Returns a single-valued number of layers in a texture array view. See glTextureView.
GL_TEXTURE_IMMUTABLE_LEVELS
Returns a single-valued number of immutable texture levels in a texture view. See glTextureView.

In addition to the parameters that may be set with glTexParameter, glGetTexParameter accepts the following read-only parameters:

GL_TEXTURE_IMMUTABLE_FORMAT
Returns non-zero if the texture has an immutable format. Textures become immutable if their storage is specified with glTexStorage1D, glTexStorage2D or glTexStorage3D. The initial value is GL_FALSE.

Notes

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

GL_DEPTH_STENCIL_TEXTURE_MODE, GL_TEXTURE_VIEW_MIN_LEVEL, GL_TEXTURE_VIEW_NUM_LEVELS, GL_TEXTURE_VIEW_MIN_LAYER, GL_TEXTURE_VIEW_NUM_LAYERS and GL_TEXTURE_IMMUTABLE_LEVELS are available only if the GL version is 4.3 or greater.

Errors

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

See Also

glActiveTexture, glBindTexture, glGetTexLevelParameter, glTexParameter

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2012 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.