WebGL2RenderingContext.samplerParameter[if]()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The WebGL2RenderingContext.samplerParameter[if]() methods of the WebGL 2 API set WebGLSampler parameters.

Syntax

void gl.samplerParameteri(sampler, pname, param);
void gl.samplerParameterf(sampler, pname, param);

Parameters

sampler
A WebGLSampler object.
pname
A GLenum specifying which parameter to set. Possible values:
  • gl.TEXTURE_COMPARE_FUNC: A GLenum specifying the texture comparison function.
  • gl.TEXTURE_COMPARE_MODE: A GLenum specifying the texture comparison mode.
  • gl.TEXTURE_MAG_FILTER: A GLenum specifying the texture magnification filter.
  • gl.TEXTURE_MAX_LOD: A GLfloat specifying the maximum level-of-detail value.
  • gl.TEXTURE_MIN_FILTER: A GLenum specifying the texture minification filter
  • gl.TEXTURE_MIN_LOD: A GLfloat specifying the minimum level-of-detail value.
  • gl.TEXTURE_WRAP_R: A GLenum specifying the texture wrapping function for the texture coordinate r.
  • gl.TEXTURE_WRAP_S: A GLenum specifying the texture wrapping function for the texture coordinate s.
  • gl.TEXTURE_WRAP_T: A GLenum specifying the texture wrapping function for the texture coordinate t.
param
A GLint (samplerParameteri) or a GLfloat (samplerParameterf) specifying a value for pname.

Return value

None.

Examples

var sampler = gl.createSampler();
gl.samplerParameteri(sampler, gl.TEXTURE_MAG_FILTER, gl.NEAREST);

Specifications

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support No support [2] Nightly build [1] No support No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support No support No support No support No support No support

[1] WebGL 2 is enabled by default in Firefox Nightly. To enable it in a release version of Firefox, set the preference webgl.enable-prototype-webgl2 to true in about:config.

[2] To use an experimental implementation of WebGL 2 in Chrome, you have to start Chrome with the runtime flag --enable-unsafe-es3-apis.

See also

Document Tags and Contributors

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