Skip to main content
Version: Phaser v4.0.0

NormalTools

The NormalTools Filter Controller.

This filter controller manages the NormalTools effect for a Camera.

NormalTools is a filter for manipulating the normals of a normal map. It has several functions:

  • Rotate or reorient the normal map.

  • Change how strongly the normals face the camera.

  • Output a grayscale texture showing how strongly the normals face the camera, or some other vector.

The output can be used for various purposes, such as:

  • Editing a normal map for special applications.

  • Altering the apparent visual depth of a normal map by manipulating the facing power.

  • Creating a base for other effects, such as a mask for a gradient or other effect.

You can even use the output as a normal map for regular lighting. Ordinarily, normal maps are loaded alongside the main texture, but you can override this.


// Given a dynamic texture `dyn` where the filter output is drawn,

// and a texture `spiderTex` with lighting enabled,

// we can inject the WebGL texture straight into the scene lighting as a normal map.

spiderTex.setDataSource(dyn.getWebGLTexture());

A NormalTools effect is added to a Camera via the FilterList component:


const camera = this.cameras.main;

camera.filters.internal.addNormalTools({

    rotation: 0,

    facingPower: 1,

    outputRatio: false,

    ratioVector: [ 0, 0, 1 ],

    ratioRadius: 1

});

camera.filters.external.addNormalTools({});

Constructor

new NormalTools(camera, [config])

Parameters

nametypeoptionaldescription
cameraPhaser.Cameras.Scene2D.CameraNoThe camera that owns this filter.
configPhaser.Types.Filters.NormalToolsConfigYesThe configuration object for the NormalTools effect.

Scope: static

Extends

Phaser.Filters.Controller

Source: src/filters/NormalTools.js#L12
Since: 4.0.0

Inherited Members​

From Phaser.Filters.Controller:

Public Members​

facingPower​

facingPower: number​

Description:

The power of the facing effect. Higher values bend normals toward the camera; lower values bend them away. This can be useful for suggesting depth in a 2D scene.

Source: src/filters/NormalTools.js#L113
Since: 4.0.0

outputRatio​

outputRatio: boolean​

Description:

Whether to output the ratio of the normal map. If true, the output will be a grayscale texture, with the white area being the areas where the normals are facing the camera, fading to black when they're orthogonal. You can manipulate this ratio with ratioVector and ratioRadius. This can be useful as a base for other effects.

Source: src/filters/NormalTools.js#L125
Since: 4.0.0

ratioRadius​

ratioRadius: number​

Description:

How much of a hemisphere to consider for the ratio output. At 1, the ratio will be calculated for the entire hemisphere. At 0, the ratio will be calculated for a single point. This uses the same algorithm as PanoramaBlur.radius.

This is only used if outputRatio is true.

Source: src/filters/NormalTools.js#L158
Since: 4.0.0

ratioVector​

ratioVector: Phaser.Math.Vector3​

Description:

The vector to use for the ratio output. This is the direction in which the ratio will be calculated. The default is the camera's forward direction. Manipulate this to highlight parts of the map which are facing in a specific direction.

This is only used if outputRatio is true.

Source: src/filters/NormalTools.js#L140
Since: 4.0.0

rotationSource​

rotationSource: Phaser.GameObjects.GameObject, Phaser.Types.Filters.NormalToolsSourceCallback, null​

Description:

The source of the rotation. If a function, it will be called to get the rotation. If a GameObject, it will be used to get the rotation from the GameObject's world transform. If null, the rotation will not be updated by the filter.

Source: src/filters/NormalTools.js#L101
Since: 4.0.0

viewMatrix​

viewMatrix: Phaser.Math.Matrix4​

Description:

The view matrix used for the NormalTools effect. This controls the orientation of the normal map. Use this to control 3D rotation of the normal map. Ordinarily, you would just use setRotation for 2D rotation.

Source: src/filters/NormalTools.js#L87
Since: 4.0.0

Inherited Methods​

From Phaser.Filters.Controller:

Public Methods​

getRotation​

<instance> getRotation()​

Description:

Gets the 2D rotation of the normal map, as set by setRotation or the rotationSource.

This value is not accurate if the viewMatrix is manipulated directly, e.g. for 3D rotation. There is no single value which can accurately represent 3D rotation.

Returns: number - The rotation in radians.

Source: src/filters/NormalTools.js#L174
Since: 4.0.0

setRotation​

<instance> setRotation(rotation)​

Description:

Sets the rotation of the normal map. This sets the viewMatrix to a rotation around the Z axis, suitable for 2D rotation. For more advanced controls, manipulate the filter's viewMatrix to control 3D rotation.

Parameters:

nametypeoptionaldescription
rotationnumberNoThe rotation in radians.

Returns: Phaser.Filters.NormalTools - This NormalTools instance.

Source: src/filters/NormalTools.js#L204
Since: 4.0.0

updateRotation​

<instance> updateRotation()​

Description:

Updates the rotation of the normal map from the rotationSource, if it is set. This is called automatically during rendering.

Returns: Phaser.Filters.NormalTools - This NormalTools instance.

Source: src/filters/NormalTools.js#L223
Since: 4.0.0