Components
Every component a plugin can add to a scene object and edit.
Commonly used
ScriptComponentComponent that runs a script asset.CameraRenders the scene from a viewpoint with configurable projection and output.RenderMeshVisualRenders a mesh with customizable blend shapes and normals.ScreenTransformComponent for positioning and scaling UI elements relative to screen dimensions.CanvasManages 2D canvas rendering and layout properties for a scene object.ComponentBase class for components attached to scene objects.
Guides
Building PluginsYou can build your own plugins to support your own workflow, and even share it to help others.Timeline PluginThe Timeline plugin arranges a Lens in time, keying objects, materials, and effects and playing clips, sound, and video on one clock.Transitions Library PluginThis plugin is a library of VFX transitions, with the ability to preview existing transitions, search among them, and install them into a project without the need for additional…
All APIs in this topic
Add components to a scene object with sceneObject.addComponent('Camera'). APIs listed by a short name are in Editor.Components: AnimationPlayer is Editor.Components.AnimationPlayer.
Components, assets, and modules
| API | Description |
|---|---|
| AnimationPlayer | Component that manages animation playback with clips and autoplay settings. |
| AudioComponent | Manages audio playback and spatial audio properties for a scene object. |
| BaseMeshVisual | Base class for mesh-based visual components. |
| Camera | Renders the scene from a viewpoint with configurable projection and output. |
| Canvas | Manages 2D canvas rendering and layout properties for a scene object. |
| ClothVisual | Simulates cloth physics with stretching, bending, and collision interactions. |
| Component | Base class for components attached to scene objects. |
| CompositionLayerComponent | Base class for components attached to scene objects. |
| CompositionLayerRenderComponent | Base class for components attached to scene objects. |
| DeviceTracking | Component that configures device tracking behavior and options. |
| EyeColorVisual | Visual component for rendering eye color on a face mesh. |
| FaceInsetVisual | Visual component for rendering an inset region of a face mesh with customizable borders. |
| FaceMaskVisual | Visual component for rendering face masks with optional mouth and teeth correction. |
| FaceStretchVisual | Visual component for stretching and deforming face meshes with named features. |
| GaussianSplattingVisual | Renders a Gaussian Splatting asset with optional frame selection for animated content. |
| HairVisual | Renders and simulates hair with physics, collision, and material properties. |
| Head | Component that attaches a scene object to a tracked head position. |
| Image | Renders a 2D image with optional flip, pivot, and rotation. |
| InteractionComponent | Handles touch and interaction detection on 3D meshes. |
| LightSource | Component controlling light properties, shadows, and environment mapping. |
| LiquifyVisual | Visual component applying liquify distortion to face mesh geometry. |
| LocatedAtComponent | Pins a scene object to a real-world location asset. |
| LookAtComponent | Rotates an object to face a target point or direction. |
| ManipulateComponent | Enables drag, rotate, and scale interactions on a scene object. |
| MarkerTrackingComponent | Tracks a marker asset for marker-based AR anchoring. |
| MaskingComponent | Applies a rounded-corner mask to a scene object. |
| MaterialMeshVisual | Base class for mesh visual components that render with materials. |
| ObjectTracking | Tracks 2D objects in the camera feed using ML classification. |
| ObjectTracking3D | Tracks and matches 3D objects in the scene using pose estimation. |
| PinToMeshComponent | Component that pins a SceneObject to a point on a mesh surface. |
| PostEffectVisual | Visual component for rendering post-effect materials. |
| RectangleSetter | Component for setting rectangular regions on textures. |
| RenderLayerOwner | The render layer which the component will be on. |
| RenderMeshVisual | Renders a mesh with customizable blend shapes and normals. |
| RetouchVisual | Visual component for applying retouching effects to faces. |
| ScreenRegionComponent | Component that defines a rectangular region on screen. |
| ScreenTransform | Component for positioning and scaling UI elements relative to screen dimensions. |
| ScriptComponent | Component that runs a script asset. |
| Skin | Represents a skeletal rigging component that controls deformation of mesh geometry through bone transformations. |
| Text | Renders and manages text in the scene with customizable font, size, layout, and visual effects. |
| Text3D | 3D text rendering component with font, layout, and styling options. |
| Visual | Base class for visual components that control rendering order and appearance. |
Objects and data
| API | Description |
|---|---|
| BackgroundSettings | Configures background styling for UI components. |
| BarycentricVertex | Settings used with Editor.Components.Head to set position on the face. |
| CameraClearColor | The same entity as in Lens Scripting. |
| CameraClearDepth | The same entity as in Lens Scripting. |
| DropshadowSettings | Drop shadow settings for text rendering. |
| Editor.Components | Container for all scene component types and related enums. |
| FontStyles | Standard font style names for the preferredStyle property of Editor.Components.Text and Editor.Components.Text3D. |
| OutlineSettings | Settings for outline rendering on a component. |
| Physics | Namespace containing physics simulation components, shapes, and constraints for rigid bodies and colliders. |
| PinToMesh | |
| RotationOptions | Configures rotation behavior for entities. |
| ScreenTransformConstraints | Used with Editor.Components.ScreenTransformConstraints. |
| StretchPoint | Defines a mesh vertex stretch point for FaceStretchVisual deformation. |
| SurfaceOptions | Configuration for surface rendering options. |
| TextAdvancedLayout | Advanced text layout configuration for controlling text appearance and spacing. |
| TextFill | Configures fill properties for text rendering. |
Enums
| API | Description |
|---|---|
| CameraAspectPreset | The same entity as in Lens Scripting. |
| CameraDepthBufferMode | The same entity as in Lens Scripting. |
| CameraDeviceProperty | The same entity as in Lens Scripting. |
| CameraOitLayers | The same entity as in Lens Scripting. |
| CameraType | The same entity as in Lens Scripting. |
| CapitalizationOverride | Enum for text capitalization override options. |
| ClipRangeType | Enum for specifying clip range units. |
| CompositionLayerRenderUpdateMode | |
| DeviceTrackingMode | The same entity as in Lens Scripting. |
| DistanceEffectCurveType | Curve type options for distance-based effects. |
| EnvmapFromCameraMode | The same entity as in Lens Scripting. |
| ExtrudeDirection | Settings used with Editor.Components.Text3D. |
| EyeToRender | Settings used with Editor.Components.EyeColorVisual. |
| FaceInsetRegion | The same entity as in Lens Scripting. |
| FalloffType | Falloff curve type options for light and effect components. |
| HeadAttachmentPointType | Settings used with Editor.Components.Head. |
| HorizontalOverflow | Settings used with Editor.Components.Text and Editor.Components.Text3D. |
| LightType | Settings used with Editor.Components.LightSource. |
| MeshShadowMode | The same entity as in Lens Scripting. |
| ObjectTrackingType | Settings used with Editor.Components.ObjectTracking. |
| ScreenRegionType | Used with Editor.Components.ScreenRegionComponent. |
| ShadowType | Enum specifying shadow rendering technique for light sources. |
| SortingType | Used with Editor.Components.Canvas. |
| StretchMode | Used with Editor.Components.BaseMeshVisual. |
| TextFillMode | Settings used with Editor.Components.Text. |
| TextFillTileZone | Specifies the coordinate system for text fill tile positioning. |
| UnitType | Settings used with Editor.Components.Canvas. |
| VerticalOverflow | Settings used with Editor.Components.Text. |