Components
Every component you can add to a scene object, with its topic.
57 in Lens API 387. Topic says where the sidebar lists each one.
| Name | Topic | Description |
|---|---|---|
| AnchorComponent | AR & Tracking › World | The active tracker: set its AnchorModule.Anchor and it drives its SceneObject's transform, reporting per-frame tracking state. |
| AnimationPlayer | Animation | Controls animation playback. |
| AudioComponent | Audio & Voice › Playback & Effects | Used to play audio in a Lens. |
| AudioEffectComponent | Audio & Voice › Playback & Effects | Used to add effects to audio recorded by the device, such as Robot, Alien, etc. |
| AudioListenerComponent | Audio & Voice › Playback & Effects | Processes input from AudioComponents that use Spatial Audio. |
| BaseMeshVisual | Graphics, Materials & Particles › Meshes & Effects | Base for all mesh rendering components. |
| BlurNoiseEstimation | Graphics, Materials & Particles › Rendering & Materials | Used to analyze camera input and apply similar image artifacts to AR objects to better blend and match with the real world. |
| BodyComponent | Physics › Bodies & Colliders | Allows Physics simulation to control SceneObject. |
| Camera | Graphics, Materials & Particles › Rendering & Materials | Renders SceneObjects to one or more Render Target textures. |
| Canvas | UI | A root of the 2D ScreenTransform hierarchy in 3D space. |
| ClothVisual | Physics › Cloth & Hair | Simulates and renders cloth visuals in a Lens. |
| ColliderComponent | Physics › Bodies & Colliders | Used to define the physical boundaries of an object, allowing it to interact with other objects in Physics, Cloth or Hair simulation. |
| ColocatedTrackingComponent | Connected Lenses (Multiplayer) | Allows SceneObject to be tracked in a Connected Lens Experience. |
| Component | Base Classes | The base class for all components. |
| CompositionLayerComponent | Graphics, Materials & Particles › Rendering & Materials | Represents a composition layer that is rendered independently from the main scene and composited by the system compositor. |
| CompositionLayerRenderComponent | Graphics, Materials & Particles › Rendering & Materials | Controls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings. |
| ConstraintComponent | Physics › Bodies & Colliders | Used to apply specific restrictions on how a SceneObject with BodyComponent can move. |
| CustomLocationGroupComponent | AR & Tracking › Location & Navigation | A component managing and tracking a group of Custom Locations with known relative transforms. |
| DeviceLocationTrackingComponent | AR & Tracking › Location & Navigation | Used to track a real-world location in a Lens. |
| DeviceTracking | AR & Tracking › World | Enables a SceneObject to align with the movements and orientation of the user's device. |
| EditorInteractionProfile | Scripting | Declares how stock Scene Editor Move / Rotate / Scale manipulators may interact with a SceneObject. |
| EyeColorVisual | AR & Tracking › Face | Applies an eye color effect to a face. |
| FaceInsetVisual | AR & Tracking › Face | Provides a 2D visual of a section of a tracked face, such as Mouth, Nose, etc. |
| FaceMaskVisual | AR & Tracking › Face | Maps a 2D texture to the user's face. |
| FaceStretchVisual | AR & Tracking › Face | Used to apply deformation effects to specific regions of a tracked face. |
| GaussianSplattingVisual | Graphics, Materials & Particles › Meshes & Effects | Allows displaying GaussianSplattingAsset and play its animation. |
| HairVisual | Physics › Cloth & Hair | Used to simulate and render hairstyles with realistic lighting and physics. |
| Head | AR & Tracking › Face | Used to move and rotate SceneObjects in sync with the user's head movements. |
| HintsComponent | UI | Used to display text hints in a Lens. |
| Image | UI | Used to display 2D textures within a scene. |
| InteractionComponent | Interaction | Enables invoking touch interactions with a BaseMeshVisual rendered to specific Camera. |
| LightSource | Graphics, Materials & Particles › Rendering & Materials | Acts as a source of light in the scene. |
| LiquifyVisual | Graphics, Materials & Particles › Meshes & Effects | Applies a liquify effect to anything rendered behind it. |
| LocatedAtComponent | AR & Tracking › Location & Navigation | Enables placing a SceneObject at a real world location provided by LocationAsset and specified relative position. |
| LookAtComponent | Scene | Orients a SceneObject towards a target SceneObject. |
| ManipulateComponent | Interaction | Handles input information from user touch input via the InteractionComponent to control the Scale, Rotation, and Translation of objects. |
| MarkerTrackingComponent | AR & Tracking › World | Used to track images in the camera. |
| MaskingComponent | UI | Masks out visuals and InteractionComponent touch events area within a rectangle defined by ScreenTransform component. |
| MaterialMeshVisual | Graphics, Materials & Particles › Meshes & Effects | Inherits from BaseMeshVisual and provides access to the Material used in the rendering process. |
| MLComponent | SnapML | Used to integrate machine learning models into a Lens. |
| ObjectTracking | AR & Tracking › Body | Used to track objects in 2D space, such as body parts, pet, hand. |
| ObjectTracking3D | AR & Tracking › Body | Used to track objects in 3D space, such as body, hands. |
| PinToMeshComponent | Graphics, Materials & Particles › Meshes & Effects | Attaches the SceneObject to the mesh surface of a specific RenderMeshVisual. |
| PostEffectVisual | Graphics, Materials & Particles › Meshes & Effects | Uses an input color lookup table image to adjust the coloring of the Lens. |
| RectangleSetter | UI | Positions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider. |
| RenderMeshVisual | Graphics, Materials & Particles › Meshes & Effects | Extends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene. |
| RetouchVisual | AR & Tracking › Face | Adds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc. |
| ScreenRegionComponent | UI | Overrides the settings on a local ScreenTransform to fit specific screen region on the device. |
| ScreenTransform | UI | Used for positioning objects in 2D screen space. |
| ScriptComponent | Scripting | Used to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity. |
| Skin | Graphics, Materials & Particles › Meshes & Effects | Represents skinning data for rigged meshes. |
| Text | Text & Fonts | Renders 2D text with specific style and layout. |
| Text3D | Text & Fonts | Renders 3D text with specific style, layout and material. |
| VertexCache | Graphics, Materials & Particles › Meshes & Effects | Used to help control vertex animations on the SceneObject. |
| VFXComponent | Graphics, Materials & Particles › Meshes & Effects | Renders VFXAsset in scene. |
| Visual | Graphics, Materials & Particles › Meshes & Effects | Base class for all visual Components. |
| WorldComponent | Physics › Bodies & Colliders | Groups Physics objects in its subtree into an independent world simulation. |