Firefox Tomorrow

web api instance method

WebGLRenderingContext: getTexParameter() method

View on MDN ↗

Available in workers

The WebGLRenderingContext.getTexParameter() method of the WebGL API returns information about the given texture.

Syntax

getTexParameter(target, pname)

Parameters

  • target

    • : A GLenum specifying the binding point (target). Possible values:

      • gl.TEXTURE_2D: A two-dimensional texture.
      • gl.TEXTURE_CUBE_MAP: A cube-mapped texture.

      When using a WebGL 2 context, the following values are available additionally:

      • gl.TEXTURE_3D: A three-dimensional texture.
      • gl.TEXTURE_2D_ARRAY: A two-dimensional array texture.

  • pname

    • : A GLenum specifying the information to query. Possible values:

      pname Return type Description Possible return values
      Available in a WebGL 1 context
      gl.TEXTURE_MAG_FILTER [`GLenum`](/firefox/mdn/api/webgl_api/types/) Texture magnification filter gl.LINEAR (default value), gl.NEAREST.
      gl.TEXTURE_MIN_FILTER [`GLenum`](/firefox/mdn/api/webgl_api/types/) Texture minification filter gl.LINEAR, gl.NEAREST, gl.NEAREST_MIPMAP_NEAREST, gl.LINEAR_MIPMAP_NEAREST, gl.NEAREST_MIPMAP_LINEAR (default value), gl.LINEAR_MIPMAP_LINEAR.
      gl.TEXTURE_WRAP_S [`GLenum`](/firefox/mdn/api/webgl_api/types/) Wrapping function for texture coordinate s gl.REPEAT (default value), gl.CLAMP_TO_EDGE, gl.MIRRORED_REPEAT.
      gl.TEXTURE_WRAP_T [`GLenum`](/firefox/mdn/api/webgl_api/types/) Wrapping function for texture coordinate t gl.REPEAT (default value), gl.CLAMP_TO_EDGE, gl.MIRRORED_REPEAT.
      Additionally available when using the [`EXT_texture_filter_anisotropic`](/firefox/mdn/api/ext_texture_filter_anisotropic/) extension
      ext.TEXTURE_MAX_ANISOTROPY_EXT [`GLfloat`](/firefox/mdn/api/webgl_api/types/) Maximum anisotropy for a texture Any float values.
      Additionally available when using a WebGL 2 context
      gl.TEXTURE_BASE_LEVEL [`GLint`](/firefox/mdn/api/webgl_api/types/) Texture mipmap level Any int values.
      gl.TEXTURE_COMPARE_FUNC [`GLenum`](/firefox/mdn/api/webgl_api/types/) Comparison function gl.LEQUAL (default value), gl.GEQUAL, gl.LESS, gl.GREATER, gl.EQUAL, gl.NOTEQUAL, gl.ALWAYS, gl.NEVER.
      gl.TEXTURE_COMPARE_MODE [`GLenum`](/firefox/mdn/api/webgl_api/types/) Texture comparison mode gl.NONE (default value), gl.COMPARE_REF_TO_TEXTURE.
      gl.TEXTURE_IMMUTABLE_FORMAT [`GLboolean`](/firefox/mdn/api/webgl_api/types/) Immutability of the texture format and size true or false.
      gl.TEXTURE_IMMUTABLE_LEVELS [`GLuint`](/firefox/mdn/api/webgl_api/types/) ? Any uint values.
      gl.TEXTURE_MAX_LEVEL [`GLint`](/firefox/mdn/api/webgl_api/types/) Maximum texture mipmap array level Any int values.
      gl.TEXTURE_MAX_LOD [`GLfloat`](/firefox/mdn/api/webgl_api/types/) Texture maximum level-of-detail value Any float values.
      gl.TEXTURE_MIN_LOD [`GLfloat`](/firefox/mdn/api/webgl_api/types/) Texture minimum level-of-detail value Any float values.
      gl.TEXTURE_WRAP_R [`GLenum`](/firefox/mdn/api/webgl_api/types/) Wrapping function for texture coordinate r gl.REPEAT (default value), gl.CLAMP_TO_EDGE, gl.MIRRORED_REPEAT.

Return value

Returns the requested texture information (as specified with pname). If an error occurs, null is returned.

Examples

gl.getTexParameter(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER);

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also