Skip to main content

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.

NameTopicDescription
AnchorComponentAR & Tracking › WorldThe active tracker: set its AnchorModule.Anchor and it drives its SceneObject's transform, reporting per-frame tracking state.
AnimationPlayerAnimationControls animation playback.
AudioComponentAudio & Voice › Playback & EffectsUsed to play audio in a Lens.
AudioEffectComponentAudio & Voice › Playback & EffectsUsed to add effects to audio recorded by the device, such as Robot, Alien, etc.
AudioListenerComponentAudio & Voice › Playback & EffectsProcesses input from AudioComponents that use Spatial Audio.
BaseMeshVisualGraphics, Materials & Particles › Meshes & EffectsBase for all mesh rendering components.
BlurNoiseEstimationGraphics, Materials & Particles › Rendering & MaterialsUsed to analyze camera input and apply similar image artifacts to AR objects to better blend and match with the real world.
BodyComponentPhysics › Bodies & CollidersAllows Physics simulation to control SceneObject.
CameraGraphics, Materials & Particles › Rendering & MaterialsRenders SceneObjects to one or more Render Target textures.
CanvasUIA root of the 2D ScreenTransform hierarchy in 3D space.
ClothVisualPhysics › Cloth & HairSimulates and renders cloth visuals in a Lens.
ColliderComponentPhysics › Bodies & CollidersUsed to define the physical boundaries of an object, allowing it to interact with other objects in Physics, Cloth or Hair simulation.
ColocatedTrackingComponentConnected Lenses (Multiplayer)Allows SceneObject to be tracked in a Connected Lens Experience.
ComponentBase ClassesThe base class for all components.
CompositionLayerComponentGraphics, Materials & Particles › Rendering & MaterialsRepresents a composition layer that is rendered independently from the main scene and composited by the system compositor.
CompositionLayerRenderComponentGraphics, Materials & Particles › Rendering & MaterialsControls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings.
ConstraintComponentPhysics › Bodies & CollidersUsed to apply specific restrictions on how a SceneObject with BodyComponent can move.
CustomLocationGroupComponentAR & Tracking › Location & NavigationA component managing and tracking a group of Custom Locations with known relative transforms.
DeviceLocationTrackingComponentAR & Tracking › Location & NavigationUsed to track a real-world location in a Lens.
DeviceTrackingAR & Tracking › WorldEnables a SceneObject to align with the movements and orientation of the user's device.
EditorInteractionProfileScriptingDeclares how stock Scene Editor Move / Rotate / Scale manipulators may interact with a SceneObject.
EyeColorVisualAR & Tracking › FaceApplies an eye color effect to a face.
FaceInsetVisualAR & Tracking › FaceProvides a 2D visual of a section of a tracked face, such as Mouth, Nose, etc.
FaceMaskVisualAR & Tracking › FaceMaps a 2D texture to the user's face.
FaceStretchVisualAR & Tracking › FaceUsed to apply deformation effects to specific regions of a tracked face.
GaussianSplattingVisualGraphics, Materials & Particles › Meshes & EffectsAllows displaying GaussianSplattingAsset and play its animation.
HairVisualPhysics › Cloth & HairUsed to simulate and render hairstyles with realistic lighting and physics.
HeadAR & Tracking › FaceUsed to move and rotate SceneObjects in sync with the user's head movements.
HintsComponentUIUsed to display text hints in a Lens.
ImageUIUsed to display 2D textures within a scene.
InteractionComponentInteractionEnables invoking touch interactions with a BaseMeshVisual rendered to specific Camera.
LightSourceGraphics, Materials & Particles › Rendering & MaterialsActs as a source of light in the scene.
LiquifyVisualGraphics, Materials & Particles › Meshes & EffectsApplies a liquify effect to anything rendered behind it.
LocatedAtComponentAR & Tracking › Location & NavigationEnables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.
LookAtComponentSceneOrients a SceneObject towards a target SceneObject.
ManipulateComponentInteractionHandles input information from user touch input via the InteractionComponent to control the Scale, Rotation, and Translation of objects.
MarkerTrackingComponentAR & Tracking › WorldUsed to track images in the camera.
MaskingComponentUIMasks out visuals and InteractionComponent touch events area within a rectangle defined by ScreenTransform component.
MaterialMeshVisualGraphics, Materials & Particles › Meshes & EffectsInherits from BaseMeshVisual and provides access to the Material used in the rendering process.
MLComponentSnapMLUsed to integrate machine learning models into a Lens.
ObjectTrackingAR & Tracking › BodyUsed to track objects in 2D space, such as body parts, pet, hand.
ObjectTracking3DAR & Tracking › BodyUsed to track objects in 3D space, such as body, hands.
PinToMeshComponentGraphics, Materials & Particles › Meshes & EffectsAttaches the SceneObject to the mesh surface of a specific RenderMeshVisual.
PostEffectVisualGraphics, Materials & Particles › Meshes & EffectsUses an input color lookup table image to adjust the coloring of the Lens.
RectangleSetterUIPositions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider.
RenderMeshVisualGraphics, Materials & Particles › Meshes & EffectsExtends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene.
RetouchVisualAR & Tracking › FaceAdds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc.
ScreenRegionComponentUIOverrides the settings on a local ScreenTransform to fit specific screen region on the device.
ScreenTransformUIUsed for positioning objects in 2D screen space.
ScriptComponentScriptingUsed to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity.
SkinGraphics, Materials & Particles › Meshes & EffectsRepresents skinning data for rigged meshes.
TextText & FontsRenders 2D text with specific style and layout.
Text3DText & FontsRenders 3D text with specific style, layout and material.
VertexCacheGraphics, Materials & Particles › Meshes & EffectsUsed to help control vertex animations on the SceneObject.
VFXComponentGraphics, Materials & Particles › Meshes & EffectsRenders VFXAsset in scene.
VisualGraphics, Materials & Particles › Meshes & EffectsBase class for all visual Components.
WorldComponentPhysics › Bodies & CollidersGroups Physics objects in its subtree into an independent world simulation.