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.getSamplerParameter() method of the WebGL 2 API returns parameter information of a WebGLSampler object.
Syntax
any gl.getSamplerParameter(sampler, pname);
Parameters
- sampler
- A
WebGLSamplerobject. pname- A
GLenumspecifying which information to return. Possible values:gl.TEXTURE_COMPARE_FUNC: Returns aGLenumindicating the texture comparison function.gl.TEXTURE_COMPARE_MODE: Returns aGLenumindicating the texture comparison mode.gl.TEXTURE_MAG_FILTER: Returns aGLenumindicating the texture magnification filter.gl.TEXTURE_MAX_LOD: Returns aGLfloatindicating the maximum level-of-detail value.gl.TEXTURE_MIN_FILTER: Returns aGLenumindicating the texture minification filtergl.TEXTURE_MIN_LOD: Returns aGLfloatindicating the minimum level-of-detail value.gl.TEXTURE_WRAP_R: Returns aGLenumindicating the texture wrapping function for the texture coordinate r.gl.TEXTURE_WRAP_S: Returns aGLenumindicating the texture wrapping function for the texture coordinate s.gl.TEXTURE_WRAP_T: Returns aGLenumindicating 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
| 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.