WebGL2RenderingContext.getSamplerParameter()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

Syntax

any gl.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

var sampler = gl.createSampler();
gl.getSamplerParameter(sampler, gl.TEXTURE_COMPARE_FUNC);

Specifications

Specification Status Comment
WebGL 2.0
The definition of 'getSamplerParameter' in that specification.
Editor's Draft Initial definition.
OpenGL ES 3.0
The definition of 'glGetSamplerParameter' in that specification.
Standard Man page of the (similar) OpenGL API.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getSamplerParameterChrome Full support 56Edge Full support 79Firefox Full support 51IE No support NoOpera Full support 43Safari No support NoWebView Android Full support 58Chrome Android Full support 58Firefox Android Full support 51Opera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 7.0

Legend

Full support
Full support
No support
No support

See also