PostEffectVisual

Lens Studio v1.0.0+

Scripting Name: Component.PostEffectVisual

Inherits from MeshVisual

Description

Uses an input color lookup table image to adjust the coloring of the Lens. See the Color Correction Post Effect guide for more information.

Inherited Methods

---

addMaterial(Material material) : void

Adds a Material to the MeshVisual.

---

clearMaterials() : void

Clears all Materials from the MeshVisual.

---

getMaterial(Number index) : Material

Returns the Material at index index.

---

getMaterialsCount() : Number

Returns the number of Materials on the MeshVisual.

---

setBlendShape(BlendShapesVisual value) : void

Sets the BlendShape for this MeshVisual.

---

setSkin(Skin value) : void

Sets the Skin used by this MeshVisual.

---

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.

---

getRenderOrder() : Number

Returns the order of this Visual in the render queue.

---

setRenderOrder(Number value) : void

Sets the order of this Visual in the render queue.

---

destroy() : void

Destroys the component.

---

getSceneObject() : SceneObject

Returns the SceneObject the component is attached to.

---

getTransform() : Transform

Returns the Transform this component is attached to.

---

getTypeName() : String

Returns the name of this object’s type.

---

isSame(SerializableWithUID other) : Boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited Properties

---

horizontalAlignment : Number

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

The possible values are:

• Left = 0
• Center = 1
• Right = 2

---

mainMaterial : Material

Returns the first Material.

---

mainPass : Pass

Returns the mainPass of the mainMaterial.

---

mesh : RenderMesh

The RenderMesh asset this MeshVisual will render.

---

meshShadowMode : MeshShadowMode

None = 0, Caster = 1, Receiver = 2

---

shadowDensity : Number

Density of shadows cast by this MeshVisual.

---

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.

---

verticalAlignment : Number

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

The possible values are:

• Bottom = 0
• Center = 1
• Top = 2

---

enabled : Boolean

If disabled, the Component will stop enacting its behavior.

Examples

// 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);