Phaser.Renderer.WebGL.Utils
Scope: static
Source: src/renderer/webgl/Utils.js#L11
Since: 3.0.0
Static functions
checkShaderMax
<static> checkShaderMax(gl, maxTextures)
Description:
Check to see how many texture units the GPU supports in a fragment shader
and if the value specific in the game config is allowed.
This value is hard-clamped to 16 for performance reasons on Android devices.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| gl | WebGLRenderingContext | No | The WebGLContext used to create the shaders. |
| maxTextures | number | No | The Game Config maxTextures value. |
Returns: number - The number of texture units that is supported by this browser and GPU.
Source: src/renderer/webgl/Utils.js#L101
Since: 3.50.0
getFloatsFromUintRGB
<static> getFloatsFromUintRGB(rgb)
Description:
Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0
Parameters:
| name | type | optional | description |
|---|---|---|---|
| rgb | number | No | RGB packed as a Uint24 |
Returns: array - Array of floats representing each component as a float
Source: src/renderer/webgl/Utils.js#L82
Since: 3.0.0
getTintAppendFloatAlpha
<static> getTintAppendFloatAlpha(rgb, a)
Description:
Packs a Uint24, representing RGB components, with a Float32, representing
the alpha component, with a range between 0.0 and 1.0 and return a Uint32
Parameters:
| name | type | optional | description |
|---|---|---|---|
| rgb | number | No | Uint24 representing RGB components |
| a | number | No | Float32 representing Alpha component |
Returns: number - Packed RGBA as Uint32
Source: src/renderer/webgl/Utils.js#L40
Since: 3.0.0
getTintAppendFloatAlphaAndSwap
<static> getTintAppendFloatAlphaAndSwap(rgb, a)
Description:
Packs a Uint24, representing RGB components, with a Float32, representing
the alpha component, with a range between 0.0 and 1.0 and return a
swizzled Uint32
Parameters:
| name | type | optional | description |
|---|---|---|---|
| rgb | number | No | Uint24 representing RGB components |
| a | number | No | Float32 representing Alpha component |
Returns: number - Packed RGBA as Uint32
Source: src/renderer/webgl/Utils.js#L59
Since: 3.0.0
getTintFromFloats
<static> getTintFromFloats(r, g, b, a)
Description:
Packs four floats on a range from 0.0 to 1.0 into a single Uint32
Parameters:
| name | type | optional | description |
|---|---|---|---|
| r | number | No | Red component in a range from 0.0 to 1.0 |
| g | number | No | Green component in a range from 0.0 to 1.0 |
| b | number | No | Blue component in a range from 0.0 to 1.0 |
| a | number | No | Alpha component in a range from 0.0 to 1.0 |
Returns: number - The packed RGBA values as a Uint32.
Source: src/renderer/webgl/Utils.js#L17
Since: 3.0.0
updateLightingUniforms
<static> updateLightingUniforms(enable, drawingContext, programManager, textureUnit, vec, [selfShadow], [selfShadowPenumbra], [selfShadowThreshold])
Description:
Update lighting uniforms for a given shader program manager.
This is a standard procedure for most lighting shaders.
Tags:
- webglOnly
Parameters:
| name | type | optional | description |
|---|---|---|---|
| enable | boolean | No | Whether to enable lighting. |
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The DrawingContext instance. |
| programManager | Phaser.Renderer.WebGL.ProgramManager | No | The ShaderProgramManager instance. |
| textureUnit | number | No | The texture unit to use for the normal map. |
| vec | Phaser.Math.Vector2 | No | A Vector2 instance. |
| selfShadow | boolean | Yes | Whether to enable self-shadowing. |
| selfShadowPenumbra | number | Yes | The penumbra value for self-shadowing. |
| selfShadowThreshold | number | Yes | The threshold value for self-shadowing. |
Source: src/renderer/webgl/Utils.js#L133
Since: 4.0.0