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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support56 No51 No43 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5858 No5143 No7.0

See also

Document Tags and Contributors

 Contributors to this page: fscholz, teoli
 Last updated by: fscholz,