WebGLRenderingContext.hint()

The WebGLRenderingContext.hint() method of the WebGL API specifies hints for certain behaviors. The interpretation of these hints depend on the implementation.

Syntax

void gl.hint(target, mode);

Parameters

target
Sets which behavior to be controlled. Possible values:
  • gl.GENERATE_MIPMAP_HINT: Quality of filtering when generating mipmap images with WebGLRenderingContext.generateMipmap().
  • When using the OES_standard_derivatives extension:
    • ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES: Accuracy of the derivative calculation for the GLSL built-in functions: dFdx, dFdy, and fwidth.
mode
Sets the behavior. The default value is gl.DONT_CARE. The possible values are:
  • gl.FASTEST: The most efficient behavior should be used.
  • gl.NICEST: The most correct or the highest quality option should be used.
  • gl.DONT_CARE: There is no preference for this behavior.

Return value

None.

Examples

The following example hints that the quality of filtering when generating mipmap images should be most efficient instead of best quality.

gl.hint(gl.GENERATE_MIPMAP_HINT, gl.FASTEST);

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'hint' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glHint' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

Feature Chrome Edge Firefox Internet Explorer Opera Safari Servo
Basic Support9124.011125.1No support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic Support(Yes)25(Yes)4.0128.1

See also

Document Tags and Contributors

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