WebGL2RenderingContext: getSamplerParameter() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

The WebGL2RenderingContext.getSamplerParameter() method of the WebGL 2 API returns parameter information of a WebGLSampler object.

Syntax

js
getSamplerParameter(sampler, pname)

Parameters

sampler

A WebGLSampler object.

pname

A GLenum specifying which information to return. Possible values:

  • gl.TEXTURE_COMPARE_FUNC: Returns a GLenum indicating the texture comparison function.
  • gl.TEXTURE_COMPARE_MODE: Returns a GLenum indicating the texture comparison mode.
  • gl.TEXTURE_MAG_FILTER: Returns a GLenum indicating the texture magnification filter.
  • gl.TEXTURE_MAX_LOD: Returns a GLfloat indicating the maximum level-of-detail value.
  • gl.TEXTURE_MIN_FILTER: Returns a GLenum indicating the texture minification filter
  • gl.TEXTURE_MIN_LOD: Returns a GLfloat indicating the minimum level-of-detail value.
  • gl.TEXTURE_WRAP_R: Returns a GLenum indicating the texture wrapping function for the texture coordinate r.
  • gl.TEXTURE_WRAP_S: Returns a GLenum indicating the texture wrapping function for the texture coordinate s.
  • gl.TEXTURE_WRAP_T: Returns a GLenum indicating the texture wrapping function for the texture coordinate t.

Return value

Depends on the pname parameter, either a GLenum or a GLfloat.

Examples

js
const sampler = gl.createSampler();
gl.getSamplerParameter(sampler, gl.TEXTURE_COMPARE_FUNC);

Specifications

Specification
WebGL 2.0 Specification
# 3.7.13

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getSamplerParameter
Chrome – Full support
Chrome 56 (Release date: 2017-01-25)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – Full support
Firefox 51 (Release date: 2017-01-24)
footnote Full support
Opera – Full support
Opera 43 (Release date: 2017-02-07)
footnote Full support
Safari – Full support
Safari 15 (Release date: 2021-09-20)
footnote Full support
Chrome Android – Full support
Chrome Android 58 (Release date: 2017-04-25)
footnote Full support
Firefox for Android – Full support
Firefox for Android 51 (Release date: 2017-01-24)
footnote Full support
Opera Android – Full support
Opera Android 43 (Release date: 2017-09-27)
footnote Full support
Safari on iOS – Full support
Safari on iOS 15 (Release date: 2021-09-20)
footnote Full support
Samsung Internet – Full support
Samsung Internet 7 (Release date: 2018-03-16)
footnote Full support
WebView Android – Full support
WebView Android 58 (Release date: 2017-04-25)
footnote Full support
WebView on iOS – Full support
WebView on iOS 15 (Release date: 2021-09-20)
footnote Full support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also