Class PostEffectVisual

Uses an input color lookup table image to adjust the coloring of the Lens.

See

Color Correction Post Effect guide.

Example

// Sets the post effects texture to a custom texture in script and sets the color to red
//@input Component.PostEffectVisual postEffect
//@input Asset.Texture texture

script.postEffect.mainPass.baseTex = script.texture;
script.postEffect.mainPass.baseColor = new vec4(1.0,0.0,0.0,1.0);

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled extentsTarget horizontalAlignment mainMaterial mainPass materials meshShadowMode sceneObject shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

Methods

addMaterial clearMaterials destroy getMaterial getMaterialsCount getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin setRenderOrder snap worldAabbMax worldAabbMin

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

extentsTarget

extentsTarget: ScreenTransform

When a ScreenTransform is present on this SceneObject, and extentsTarget is a child of this SceneObject, extentsTarget will be repositioned to match the exact area this MeshVisual is being rendered. Very useful for Image and Text components.

horizontalAlignment

horizontalAlignment: HorizontalAlignment

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.

mainMaterial

mainMaterial: Material

Returns the first Material.

mainPass

mainPass: Pass

Returns the mainPass of the mainMaterial.

materials

materials: Material[]

Get the array of materials used by the MaterialMeshVisual.

meshShadowMode

meshShadowMode: MeshShadowMode

None = 0, Caster = 1, Receiver = 2

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

shadowColor

shadowColor: vec4

Affects the color of shadows being cast by this MeshVisual. The color of the cast shadow is a mix between shadowColor and the material's base texture color. The alpha value of shadowColor controls the mixing of these two colors, with 0 = shadowColor and 1 = shadowColor * textureColor.

shadowDensity

shadowDensity: number

Density of shadows cast by this MeshVisual.

stretchMode

stretchMode: StretchMode

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be stretched relative to the ScreenTransform's boundaries.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

verticalAlignment

verticalAlignment: VerticalAlignment

When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.

Methods

addMaterial

clearMaterials

destroy

getMaterial

getMaterialsCount

getRenderOrder

getSceneObject

getTransform

getTypeName

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

localAabbMax

localAabbMin

setRenderOrder

  • setRenderOrder(value: number): void

    Sets the order of this Visual in the render queue.

    Parameters

    • value: number

    Returns void

snap

  • snap(camera: Camera): void

    Projects screen positions from camera's view onto the mesh's UVs. If the MeshVisual's material uses the same texture as the camera input, the MeshVisual will look identical to the part of the screen it covers.

    Parameters

    Returns void

worldAabbMax

worldAabbMin

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR