Full API List
Every symbol in the Lens Scripting API in one list, with its kind and topic.
Generated from the Lens Studio typings: Lens API 387, Lens Studio client 14.31. 1041 symbols.
Topic says where the sidebar lists a symbol: under the same section names as the Develop tab. Nested types (CameraModule.CameraRequest) and options or result classes only one symbol uses (WebSocketOptions, used by InternetModule) sit under that symbol. Deprecated APIs are not listed here; see Deprecated Lens Scripting APIs. Use your browser's find to jump to a name.
| Symbol | Kind | Topic | Description |
|---|---|---|---|
| AccountType | Enum | User & Friends | The kind of account backing a User. |
| allowUndefined | Function | Scripting › Decorators | |
| Anchor | Class | AR & Tracking › Location & Navigation | An object containing the position of an object relative to a LocationAsset. |
| AnchorComponent | Class | AR & Tracking › World | The active tracker: set its AnchorModule.Anchor and it drives its SceneObject's transform, reporting per-frame tracking state. |
| AnchorLocationModule | Class | AR & Tracking › Location & Navigation | Look up the real-world geographic position of an anchor. |
| AnchorModule | Class | AR & Tracking › World | Entry point to the anchoring system. |
| AnchorModule.Anchor | Class | AR & Tracking › World › AnchorModule | A saved place the system can recognise and track — an identity plus metadata. |
| AnchorModule.AnchorScope | Enum | AR & Tracking › World › AnchorModule | Who can access an anchor. |
| AnchorModule.AnchorSession | Class | AR & Tracking › World › AnchorModule | Your connection to the anchor system for an area. |
| AnchorModule.AnchorSessionOptions | Class | AR & Tracking › World › AnchorModule | Options for opening an AnchorSession. |
| AnchorModule.AnchorTrackingState | Enum | AR & Tracking › World › AnchorModule | The tracking state of an AnchorComponent. |
| AnchorModule.AnchorType | Enum | AR & Tracking › World › AnchorModule | The kind of anchor. |
| AnchorModule.SaveOptions | Class | AR & Tracking › World › AnchorModule | Options for saving an anchor. |
| AnchorModule.WorldAnchor | Class | AR & Tracking › World › AnchorModule | A spatial anchor fixed to a point in the user's mapped space. |
| AnimatedTextureFileProvider | Class | Graphics, Materials & Particles › Textures & Video | Provider for animated texture resource. |
| AnimationAsset | Class | Animation | Represents animation data. |
| AnimationAsset.selfLayerName | Variable | Animation › AnimationAsset | Special layer name that resolves to the SceneObject the AnimationPlayer is attached to, allowing animations to work regardless of the SceneObject's name. |
| AnimationClip | Class | Animation | Animation Clip is what an Animation Player uses to manage playback for a specific animation. |
| AnimationCurve | Class | Animation | A curve that contains a set of keyframes and can evaluate values at specific timestamps. |
| AnimationCurveTrack | Class | Animation | Container for one or more AnimationCurves. |
| AnimationKeyFrame | Class | Animation | A keyframe with time and respective value. |
| AnimationLayerBlendMode | Enum | Animation | How animation layers are blended. |
| AnimationLayerScaleMode | Enum | Animation | The method in which an Animation Layer should be scaled to other layers in an AnimationClip. |
| AnimationPlayer | Class | Animation | Controls animation playback. |
| AnimationPlayerOnEventArgs | Class | Animation | Args used for AnimationPlayer's event, which is triggered every time the animation playback passes the given time in the event. |
| AnimationPropertyEventRegistration | Class | Animation | The event registration returned by AnimationAsset's createEvent. |
| AnimationPropertyLayer | Class | Animation | A layer containing different properties. |
| AnimationPropertyLayer.BlendShapes | Variable | Animation › AnimationPropertyLayer | Accessor string for BlendsShapes. |
| AnimationPropertyLayer.TransformPosition | Variable | Animation › AnimationPropertyLayer | Accessor string for Transform Position property. |
| AnimationPropertyLayer.TransformRotation | Variable | Animation › AnimationPropertyLayer | Accessor string for Transform Rotation property. |
| AnimationPropertyLayer.TransformScale | Variable | Animation › AnimationPropertyLayer | Accessor string for Transform Scale property. |
| AnimationPropertyLayer.VertexCache | Variable | Animation › AnimationPropertyLayer | Accessor string for VertexCache. |
| AnimationPropertyLayer.Visibility | Variable | Animation › AnimationPropertyLayer | Accessor string for Visibility. |
| AnimationPropertyTrack | Class | Animation | Interface class for typed property tracks. |
| AnimationTrack | Class | Animation | Represents the base class for animation tracks. |
| AsrModule | Class | Audio & Voice › Speech | Allows the Lens to incorporate voice transcription with higher quality than the VoiceMlModule and supports a vast number of different languages. |
| AsrModule.AsrContentType | Enum | Audio & Voice › Speech › AsrModule | The kind of content the speech is expected to carry. |
| AsrModule.AsrMode | Enum | Audio & Voice › Speech › AsrModule | The mode of the transcription to prioritise, between speed and accuracy. |
| AsrModule.AsrStatusCode | Enum | Audio & Voice › Speech › AsrModule | An enum stating the status of the transcription. |
| AsrModule.AsrTranscriptionOptions | Class | Audio & Voice › Speech › AsrModule | Provides the options for the session. |
| AsrModule.TranscriptionUpdateEvent | Class | Audio & Voice › Speech › AsrModule | Argument passed for a transcription update event. |
| Asset | Class | Base Classes | Base class for all assets used in the engine. |
| asset | Function | Scripting › Decorators | |
| AttachmentPointType | Enum | AR & Tracking › Face | |
| Audio | Namespace | Audio & Voice › Playback & Effects | |
| Audio.DistanceCurveType | Enum | Audio & Voice › Playback & Effects › Audio | The curve that specifies how sound fades with the distance from Audio Component to the Audio Listener.**** |
| Audio.PlaybackMode | Enum | Audio & Voice › Playback & Effects › Audio | The Playback Mode property of the AudioComponent used in Lenses targeting Spectacles. |
| AudioComponent | Class | Audio & Voice › Playback & Effects | Used to play audio in a Lens. |
| AudioEffectAsset | Class | Audio & Voice › Playback & Effects | Configures an audio effect for AudioEffectComponent. |
| AudioEffectComponent | Class | Audio & Voice › Playback & Effects | Used to add effects to audio recorded by the device, such as Robot, Alien, etc. |
| AudioEffectProvider | Class | Audio & Voice › Playback & Effects | Provider for AudioEffectAsset. |
| AudioListenerComponent | Class | Audio & Voice › Playback & Effects | Processes input from AudioComponents that use Spatial Audio. |
| AudioOutputProvider | Class | Audio & Voice › Playback & Effects | Provider of the Audio Output Audio Track asset. |
| AudioTrackAsset | Class | Audio & Voice › Playback & Effects | Represents an audio file asset. |
| AudioTrackProvider | Class | Audio & Voice › Playback & Effects | Base class for Audio Track providers. |
| Axis | Enum | Physics › Shapes & Collision Meshes | Cardinal axis enumeration. |
| BackgroundSettings | Class | Text & Fonts › Text | Settings for rendering the background on a Text component. |
| Base64 | Namespace | Utilities › Data & Encoding | |
| Base64.decode | Function | Utilities › Data & Encoding › Base64 | Decode a Base64 string to a byte array (Uint8Array). |
| Base64.decodeTextureAsync | Function | Utilities › Data & Encoding › Base64 | Decode a texture from Base64, asynchronously. |
| Base64.encode | Function | Utilities › Data & Encoding › Base64 | Encode a byte array (Uint8Array) to Base64 string. |
| Base64.encodeString | Function | Utilities › Data & Encoding › Base64 | Encode a string to Base64 format. |
| Base64.encodeTextureAsync | Function | Utilities › Data & Encoding › Base64 | Encode a texture according to Base64 encoding algorithm, asynchronously. |
| BaseMeshVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Base for all mesh rendering components. |
| BaseMultiplayerSessionOptions | Class | Connected Lenses (Multiplayer) | Base class for MultiplayerSession options. |
| BasePlaceholder | Class | SnapML | Base class for Input and Output Placeholders used by MLComponent. |
| BaseScriptComponent | Class | Scripting › BaseScriptComponent | |
| BasicTransform | Class | Base Classes | Provides basic information about a transformation. |
| BatteryStateArgs | Class | Utilities › Device & Runtime | Stores the battery level and charging state of the device. |
| BinAsset | Class | Base Classes | A file based asset. |
| Bitmoji2DOptions | Class | Bitmoji › BitmojiModule | The options used with requestBitmoji2DResource. |
| Bitmoji2DResource | Class | Bitmoji | The DynamicResource of a 2D Bitmoji which can be loaded with RemoteMediaModule. |
| Bitmoji3DOptions | Class | Bitmoji › BitmojiModule | The options used with requestBitmoji3DResource |
| Bitmoji3DOptions.AnimationParams | Class | Bitmoji › Bitmoji3DOptions | Used to set the animation params for the request type. |
| Bitmoji3DOptions.AvatarScope | Enum | Bitmoji › Bitmoji3DOptions | Enum representing avatar scope used in custom params of bitmoji3d options. |
| Bitmoji3DOptions.BaseBodyParams | Class | Bitmoji › Bitmoji3DOptions | Body parameters for base Bitmoji avatar customization. |
| Bitmoji3DOptions.BodyType | Enum | Bitmoji › Bitmoji3DOptions | Enum representing different body types for the avatar. |
| Bitmoji3DOptions.BreastType | Enum | Bitmoji › Bitmoji3DOptions | Enum representing different breast types for the avatar. |
| Bitmoji3DOptions.ClothingType | Enum | Bitmoji › Bitmoji3DOptions | Enum representing different types of clothing |
| Bitmoji3DOptions.CustomParams | Class | Bitmoji › Bitmoji3DOptions | The custom params can be used for requesting bitmoji assets like garments. |
| Bitmoji3DOptions.Gender | Enum | Bitmoji › Bitmoji3DOptions | Enum representing the gender of the avatar. |
| Bitmoji3DOptions.OptimizationParams | Class | Bitmoji › Bitmoji3DOptions | Optimization parameters for Bitmoji 3D assets. |
| Bitmoji3DOptions.ParamSet | Class | Bitmoji › Bitmoji3DOptions | Set of parameters used to customize specific parts of avatar such as garment, outerwear etc. |
| Bitmoji3DOptions.RequestType | Enum | Bitmoji › Bitmoji3DOptions | Enum representing different request types. |
| Bitmoji3DResource | Class | Bitmoji | Provides information about the current user's 3D Bitmoji avatar to be downloaded via the RemoteMediaModule. |
| BitmojiModule | Class | Bitmoji | Provides access to functionalities related to Bitmoji avatar. |
| BlendMode | Enum | Graphics, Materials & Particles › Rendering & Materials | |
| Blob | Class | Cloud, Networking & Storage › Internet Access | Represents a blob, which is a file-like object of immutable, raw data. |
| Bluetooth | Namespace | Cloud, Networking & Storage | |
| Bluetooth.BluetoothCentralModule | Class | Cloud, Networking & Storage › Bluetooth | Provides access to Bluetooth GATT devices. |
| Bluetooth.BluetoothGatt | Class | Cloud, Networking & Storage › Bluetooth | Provides access to the Bluetooth connection. |
| Bluetooth.BluetoothGattCharacteristic | Class | Cloud, Networking & Storage › Bluetooth | A characteristic of the Bluetooth GATT device. |
| Bluetooth.BluetoothGattDescriptor | Class | Cloud, Networking & Storage › Bluetooth | Descriptors contain additional information and attributes of a Bluetooth.BluetoothGattCharacteristic. |
| Bluetooth.BluetoothGattService | Class | Cloud, Networking & Storage › Bluetooth | Bluetooth GATT Services are collections of related Bluetooth.BluetoothGattCharacteristics representing specific functions or features of a device. |
| Bluetooth.BluetoothStatus | Enum | Cloud, Networking & Storage › Bluetooth | The statuses for Bluetooth availability. |
| Bluetooth.BluetoothStatusChangedEvent | Class | Cloud, Networking & Storage › Bluetooth | The event received when Bluetooth status has changed. |
| Bluetooth.CharacteristicProperty | Enum | Cloud, Networking & Storage › Bluetooth | Properties of a Bluetooth.BluetoothGattCharacteristic. |
| Bluetooth.MtuChangedEvent | Class | Cloud, Networking & Storage › Bluetooth | The event received when Maximum Transmission Unit (MTU) of a Bluetooth device has changed. |
| Bluetooth.ScanFilter | Class | Cloud, Networking & Storage › Bluetooth | The filters to be used with BluetoothCentralModule.startScan. |
| Bluetooth.ScanMode | Enum | Cloud, Networking & Storage › Bluetooth | Defines how Bluetooth devices should be scanned. |
| Bluetooth.ScanResult | Class | Cloud, Networking & Storage › Bluetooth | The results of a Bluetooth scan. |
| Bluetooth.ScanSettings | Class | Cloud, Networking & Storage › Bluetooth | Settings when scanning for Bluetooth devices via BluetoothCentralModule.startScan. |
| BlurNoiseEstimation | Class | 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 | Class | Physics › Bodies & Colliders | Allows Physics simulation to control SceneObject. |
| BodyDepthTextureProvider | Class | AR & Tracking › Body | Provides depth values of the tracked body encoded as D24_UNORM_S8_UINT in screen resolution. |
| BodyInstanceSegmentationTextureProvider | Class | AR & Tracking › Body | Provides segmentation confidence values encoded in the R channel. |
| BodyNormalsTextureProvider | Class | AR & Tracking › Body | Provides surface normal values of the tracked body encoded as RGBA (x, y, z, confidence) in R8G8B8A8_UNORM format in screen resolution. |
| BodyRenderObjectProvider | Class | AR & Tracking › Body | Provider for full Body Mesh render object. |
| BodyTrackingAsset | Class | AR & Tracking › Body | Configures 3D Body Tracking for the ObjectTracking3D component. |
| BodyTrackingAsset.Head | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Head attachment point. |
| BodyTrackingAsset.Hips | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Hips attachment point. |
| BodyTrackingAsset.LeftArm | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Arm attachment point. |
| BodyTrackingAsset.LeftFoot | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Foot attachment point. |
| BodyTrackingAsset.LeftForeArm | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Forearm attachment point. |
| BodyTrackingAsset.LeftHand | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand attachment point. |
| BodyTrackingAsset.LeftHandIndex1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Index 1 attachment point. |
| BodyTrackingAsset.LeftHandIndex2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Index 2 attachment point. |
| BodyTrackingAsset.LeftHandIndex3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Index 3 attachment point. |
| BodyTrackingAsset.LeftHandMiddle1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Middle 1 attachment point. |
| BodyTrackingAsset.LeftHandMiddle2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Middle 2 attachment point. |
| BodyTrackingAsset.LeftHandMiddle3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Middle 3 attachment point. |
| BodyTrackingAsset.LeftHandPinky1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Pinky 1 attachment point. |
| BodyTrackingAsset.LeftHandPinky2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Pinky 2 attachment point. |
| BodyTrackingAsset.LeftHandPinky3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Pinky 3 attachment point. |
| BodyTrackingAsset.LeftHandRing1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Ring 1 attachment point. |
| BodyTrackingAsset.LeftHandRing2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Ring 2 attachment point. |
| BodyTrackingAsset.LeftHandRing3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Ring 3 attachment point. |
| BodyTrackingAsset.LeftHandThumb1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Thumb 1 attachment point. |
| BodyTrackingAsset.LeftHandThumb2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Thumb 2 attachment point. |
| BodyTrackingAsset.LeftHandThumb3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Hand Thumb 3 attachment point. |
| BodyTrackingAsset.LeftLeg | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Leg attachment point. |
| BodyTrackingAsset.LeftShoulder | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Shoulder attachment point. |
| BodyTrackingAsset.LeftToeBase | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Left Toe Base attachment point. |
| BodyTrackingAsset.LeftUpLeg | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Upper Left Leg attachment point. |
| BodyTrackingAsset.Neck | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Neck attachment point. |
| BodyTrackingAsset.RightArm | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Arm attachment point. |
| BodyTrackingAsset.RightFoot | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Foot attachment point. |
| BodyTrackingAsset.RightForeArm | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Forearm attachment point. |
| BodyTrackingAsset.RightHand | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand attachment point. |
| BodyTrackingAsset.RightHandIndex1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Index 1 attachment point. |
| BodyTrackingAsset.RightHandIndex2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Index 2 attachment point. |
| BodyTrackingAsset.RightHandIndex3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Index 3 attachment point. |
| BodyTrackingAsset.RightHandMiddle1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Middle 1 attachment point. |
| BodyTrackingAsset.RightHandMiddle2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Middle 2 attachment point. |
| BodyTrackingAsset.RightHandMiddle3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Middle 3 attachment point. |
| BodyTrackingAsset.RightHandPinky1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Pinky 1 attachment point. |
| BodyTrackingAsset.RightHandPinky2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Pinky 2 attachment point. |
| BodyTrackingAsset.RightHandPinky3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Pinky 3 attachment point. |
| BodyTrackingAsset.RightHandRing1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Ring 1 attachment point. |
| BodyTrackingAsset.RightHandRing2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Ring 2 attachment point. |
| BodyTrackingAsset.RightHandRing3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Ring 3 attachment point. |
| BodyTrackingAsset.RightHandThumb1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Thumb 1 attachment point. |
| BodyTrackingAsset.RightHandThumb2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Thumb 2 attachment point. |
| BodyTrackingAsset.RightHandThumb3 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Hand Thumb 3 attachment point. |
| BodyTrackingAsset.RightLeg | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Leg attachment point. |
| BodyTrackingAsset.RightShoulder | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Shoulder attachment point. |
| BodyTrackingAsset.RightToeBase | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Right Toe Base attachment point. |
| BodyTrackingAsset.RightUpLeg | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Upper Right Leg attachment point. |
| BodyTrackingAsset.Spine | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Spine attachment point. |
| BodyTrackingAsset.Spine1 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Spine1 attachment point. |
| BodyTrackingAsset.Spine2 | Variable | AR & Tracking › Body › BodyTrackingAsset | Key for Spine2 attachment point. |
| BoxShape | Class | Physics › Shapes & Collision Meshes | A box collision shape. |
| BrowsLoweredEvent | Class | AR & Tracking › Face | Triggered when eyebrows are lowered on the tracked face. |
| BrowsRaisedEvent | Class | AR & Tracking › Face | Triggered when eyebrows are raised on the tracked face. |
| BrowsReturnedToNormalEvent | Class | AR & Tracking › Face | Triggered when eyebrows are returned to normal on the tracked face. |
| Camera | Class | Graphics, Materials & Particles › Rendering & Materials | Renders SceneObjects to one or more Render Target textures. |
| Camera.BaseRenderTarget | Class | Graphics, Materials & Particles › Rendering & Materials › Camera | The base class from which ColorRenderTarget and DepthStencilRenderTarget are derived from |
| Camera.ColorRenderTarget | Class | Graphics, Materials & Particles › Rendering & Materials › Camera | Color based RenderTarget. |
| Camera.CubemapFace | Enum | Graphics, Materials & Particles › Rendering & Materials › Camera | Different faces of the cubemap that a camera can render into. |
| Camera.DepthBufferMode | Enum | Graphics, Materials & Particles › Rendering & Materials › Camera | Used in Camera's depthBufferMode property. |
| Camera.DepthStencilRenderTarget | Class | Graphics, Materials & Particles › Rendering & Materials › Camera | This class inherits from the BaseRenderTarget class. |
| Camera.DeviceProperty | Enum | Graphics, Materials & Particles › Rendering & Materials › Camera | Used in Camera's devicePropertyUsage property. |
| Camera.Type | Enum | Graphics, Materials & Particles › Rendering & Materials › Camera | Returned from Camera's type property. |
| CameraBackEvent | Class | AR & Tracking › Camera | Triggered when the device's back facing camera becomes active. |
| CameraFrame | Class | AR & Tracking › Camera | Metadata about the current camera image of a CameraTextureProvider. |
| CameraFrontEvent | Class | AR & Tracking › Camera | Triggered when the device's front facing camera becomes active. |
| CameraModule | Class | AR & Tracking › Camera | Provides access to the SPECS cameras. |
| CameraModule.CameraFacing | Enum | AR & Tracking › Camera › CameraModule | Which way a camera faces, reported on CameraModule.CameraInfo#facing. |
| CameraModule.CameraId | Enum | AR & Tracking › Camera › CameraModule | A handle to specify which camera on the Spectacles to request from. |
| CameraModule.CameraInfo | Class | AR & Tracking › Camera › CameraModule | A physical camera on SPECS, returned by CameraModule#getCameras. |
| CameraModule.CameraLocation | Enum | AR & Tracking › Camera › CameraModule | Camera position on the device, reported on CameraModule.CameraInfo#location. |
| CameraModule.CameraRequest | Class | AR & Tracking › Camera › CameraModule | An object that is used to request the desired camera ID. |
| CameraModule.CameraType | Enum | AR & Tracking › Camera › CameraModule | Camera sensor type, reported on CameraModule.CameraInfo#type. |
| CameraModule.CaptureSession | Class | AR & Tracking › Camera › CameraModule | Still-capture camera session for SPECS. |
| CameraModule.ConfigKey | Enum | AR & Tracking › Camera › CameraModule | Typed keys for camera tuning parameters. |
| CameraModule.Frame | Class | AR & Tracking › Camera › CameraModule | A camera image, delivered by CameraModule.StreamingSession#onNewFrame or returned by CameraModule.CaptureSession#capture. |
| CameraModule.ImageFormat | Enum | AR & Tracking › Camera › CameraModule | Image format for camera image data. |
| CameraModule.MetadataKey | Enum | AR & Tracking › Camera › CameraModule | Typed keys for querying per-frame metadata. |
| CameraModule.Operation | Enum | AR & Tracking › Camera › CameraModule | Which session a stream capability works with, reported by CameraModule.StreamInfo#operation. |
| CameraModule.Quality | Enum | AR & Tracking › Camera › CameraModule | Processing quality tier of a stream configuration. |
| CameraModule.Result | Enum | AR & Tracking › Camera › CameraModule | Result codes from camera session operations. |
| CameraModule.StreamConfig | Class | AR & Tracking › Camera › CameraModule | Stream configuration for creating a camera session. |
| CameraModule.StreamConfigOverrides | Class | AR & Tracking › Camera › CameraModule | Per-shot overrides for CameraModule.CaptureSession#capture. |
| CameraModule.StreamInfo | Class | AR & Tracking › Camera › CameraModule | Describes one stream capability of a camera (read-only). |
| CameraModule.StreamingSession | Class | AR & Tracking › Camera › CameraModule | Continuous-frame camera session for SPECS. |
| CameraModule.StreamStatus | Enum | AR & Tracking › Camera › CameraModule | Session lifecycle status delivered via onStatusChanged event. |
| CameraRollMedia | Class | Graphics, Materials & Particles › Textures & Video | Represents media selected from the device camera roll. |
| CameraRollMediaType | Enum | Graphics, Materials & Particles › Textures & Video | Enum representing the type of media selected from camera roll. |
| CameraRollModule | Class | Graphics, Materials & Particles › Textures & Video | Provides an interface to the device’s camera roll and allows users to select multiple media. |
| CameraRollModule.ShowOptions | Class | Graphics, Materials & Particles › Textures & Video › CameraRollModule | Configuration options for displaying the camera roll media picker. |
| CameraTextureProvider | Class | AR & Tracking › Camera | |
| Canvas | Class | UI | A root of the 2D ScreenTransform hierarchy in 3D space. |
| Canvas.OffsetUnit | Enum | UI › Canvas | The unit system for child ScreenTransform offsets on a Canvas. |
| Canvas.SortingType | Enum | UI › Canvas | Used by Canvas to set how an object is sorted during rendering. |
| Canvas.UnitType | Enum | UI › Canvas | Used by Canvas to set how an object is positioned. |
| CapitalizationOverride | Enum | Text & Fonts | Changes the capitalization of the text component. |
| CapsuleShape | Class | Physics › Shapes & Collision Meshes | A capsule collision shape. |
| ClearColorOption | Enum | Graphics, Materials & Particles › Rendering & Materials | Settings for how color will be cleared before rendering. |
| clearTimeout | Function | Utilities › Time & Timers | Clears the timeout with the specified TimeoutID. |
| ClothVisual | Class | Physics › Cloth & Hair | Simulates and renders cloth visuals in a Lens. |
| ClothVisual.BendMode | Enum | Physics › Cloth & Hair › ClothVisual | Cloth bend mode to use for cloth simulation. |
| CloudStorageListOptions | Class | Cloud, Networking & Storage › Storage | Options associated with the listValues method call. |
| CloudStorageModule | Class | Cloud, Networking & Storage › Storage | Provides access to Cloud Storage capabilities. |
| CloudStorageOptions | Class | Cloud, Networking & Storage › Storage › CloudStorageModule | Used to configure Cloud Storage Module with various options. |
| CloudStorageReadOptions | Class | Cloud, Networking & Storage › Storage | Options associated with the getValue/deleteValue methods for Cloud Storage. |
| CloudStorageWriteOptions | Class | Cloud, Networking & Storage › Storage | Options associated with the setValue method for Cloud Storage. |
| CloudStore | Class | Cloud, Networking & Storage › Storage | An instance of Cloud Storage that can store data in a multiplayer experience. |
| ColliderComponent | Class | 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. |
| Collision | Class | Physics › Collisions & Overlaps | A state generated for ColliderComponent collision events. |
| CollisionEnterEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins. |
| CollisionExitEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionExit, which is triggered when a collision ends. |
| CollisionMesh | Class | Physics › Shapes & Collision Meshes | Defines the physical boundaries of an object for collision detection. |
| CollisionStayEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues. |
| ColocatedLandmarks2DRenderObjectProvider | Class | Connected Lenses (Multiplayer) | Not usable from JS. |
| ColocatedLandmarks3DRenderObjectProvider | Class | Connected Lenses (Multiplayer) | Not usable from JS. |
| ColocatedLandmarksRenderObjectProviderBase | Class | Connected Lenses (Multiplayer) | |
| ColocatedTrackingComponent | Class | Connected Lenses (Multiplayer) | Allows SceneObject to be tracked in a Connected Lens Experience. |
| ColorWidget | Class | Scripting › UIControl | |
| ComboBoxItem | Class | Scripting › UIControl | |
| ComboBoxWidget | Class | Scripting › UIControl | |
| Commerce | Namespace | Commerce › Commerce Kit | |
| Commerce.Client | Class | Commerce › Commerce Kit › Commerce | The primary interface for interacting with the commerce system within a Lens. |
| Commerce.ClientOptions | Class | Commerce › Commerce Kit › Commerce | Specifies the configuration for creating a commerce client. |
| Commerce.Price | Class | Commerce › Commerce Kit › Commerce | Represents the price of a product in a Lens. |
| Commerce.PricingPhase | Class | Commerce › Commerce Kit › Commerce | Describes one phase of a subscription offer's pricing schedule, such as a free trial, an introductory price, or the regular recurring price. |
| Commerce.Product | Class | Commerce › Commerce Kit › Commerce | Contains all the essential details about an item available for purchase in a Lens. |
| Commerce.ProductType | Enum | Commerce › Commerce Kit › Commerce | Defines the type of product that can be purchased in a Lens. |
| Commerce.Purchase | Class | Commerce › Commerce Kit › Commerce | Represents a completed or pending transaction for a product. |
| Commerce.PurchaseResult | Class | Commerce › Commerce Kit › Commerce | Provides an immediate summary of the outcome of a purchase attempt. |
| Commerce.PurchaseState | Enum | Commerce › Commerce Kit › Commerce | Represents the state of a purchase in a Lens. |
| Commerce.RecurrenceMode | Enum | Commerce › Commerce Kit › Commerce | Describes how a subscription pricing phase repeats over time. |
| Commerce.ResponseCode | Enum | Commerce › Commerce Kit › Commerce | Defines the possible outcomes of a purchase attempt in a Lens |
| Commerce.SubscriptionOfferDetails | Class | Commerce › Commerce Kit › Commerce | Describes a specific offer for a subscription product, such as a base plan or a promotional plan with a trial. |
| CommerceKitModule | Class | Commerce › Commerce Kit | The main entry point for integrating commerce functionalities into a Lens. |
| CompassTrackingData | Namespace | AR & Tracking › Location & Navigation | |
| CompassTrackingData.Accuracy | Enum | AR & Tracking › Location & Navigation › CompassTrackingData | |
| Component | Class | Base Classes | The base class for all components. |
| component | Function | Scripting › Decorators | |
| CompositionLayer | Namespace | Graphics, Materials & Particles › Rendering & Materials | |
| CompositionLayer.Render | Namespace | Graphics, Materials & Particles › Rendering & Materials › CompositionLayer | |
| CompositionLayer.Render.UpdateMode | Enum | Graphics, Materials & Particles › Rendering & Materials › CompositionLayer | Determines when a composition layer should be (re-)rendered. |
| CompositionLayerComponent | Class | Graphics, Materials & Particles › Rendering & Materials | Represents a composition layer that is rendered independently from the main scene and composited by the system compositor. |
| CompositionLayerRenderComponent | Class | Graphics, Materials & Particles › Rendering & Materials | Controls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings. |
| CompressionQuality | Enum | Graphics, Materials & Particles › Textures & Video | Enum used to define the quality of image or texture compression. |
| ConeShape | Class | Physics › Shapes & Collision Meshes | A cone collision shape. |
| ConnectedLensEnteredEvent | Class | Connected Lenses (Multiplayer) | Event fired when the "Launch connected lens" button was pressed. |
| ConnectedLensModule | Class | Connected Lenses (Multiplayer) | Enables the creation and management of networked Lens experiences, allowing for real-time communication and interaction between users through Connected Lenses. |
| ConnectedLensModule.ConnectionInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Information that is bootstrapped to the user who just connected to the session. |
| ConnectedLensModule.HostUpdateInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Information about the host update. |
| ConnectedLensModule.MatchmakingAvailability | Enum | Connected Lenses (Multiplayer) › ConnectedLensModule | Whether matchmaking is available, and if not, why. |
| ConnectedLensModule.MatchmakingConfig | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Configuration for matchmaking when creating a session. |
| ConnectedLensModule.MatchmakingConfig.LobbyMode | Enum | Connected Lenses (Multiplayer) › ConnectedLensModule | How matchmaking fills a session. |
| ConnectedLensModule.MatchmakingConfig.LobbyState | Enum | Connected Lenses (Multiplayer) › ConnectedLensModule | Open/close gate of an open-lobby session. |
| ConnectedLensModule.MultiplayerSupportInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Which multiplayer capabilities are available for the current Lens launch, from ConnectedLensModule#getMultiplayerSupportInfo. |
| ConnectedLensModule.RealtimeStoreCreationInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Provides extra context about a RealtimeStore's creation. |
| ConnectedLensModule.RealtimeStoreDeleteInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Gives information about the Realtime Store delete operation. |
| ConnectedLensModule.RealtimeStoreKeyRemovalInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Provides information about a key being removed from a RealtimeStore. |
| ConnectedLensModule.RealtimeStoreOwnershipUpdateInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Provides information about a RealtimeStore's ownership being updated. |
| ConnectedLensModule.RealtimeStoreUpdateInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Gives information about the Realtime Store update operation. |
| ConnectedLensModule.SessionShareType | Enum | Connected Lenses (Multiplayer) › ConnectedLensModule | Used by ConnectedLensModule to specify the session share type. |
| ConnectedLensModule.TurnState | Namespace | Connected Lenses (Multiplayer) › ConnectedLensModule | |
| ConnectedLensModule.UserInfo | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Provides information about a user in a Connected Lens session. |
| ConnectedLensSessionOptions | Class | Connected Lenses (Multiplayer) › ConnectedLensModule | Settings for configuring a Connected Lens session. |
| ConnectedLensSessionOptions.SessionCreationType | Enum | Connected Lenses (Multiplayer) › ConnectedLensSessionOptions | Type of the created Connected Lens session. |
| console | Namespace | Utilities › Logging & Debugging | |
| console.debug | Function | Utilities › Logging & Debugging › console | Prints out a message to the Logger window at the debug log level. |
| console.error | Function | Utilities › Logging & Debugging › console | Prints out a message to the Logger window at the error log level. |
| console.info | Function | Utilities › Logging & Debugging › console | Prints out a message to the Logger window at the info log level. |
| console.log | Function | Utilities › Logging & Debugging › console | Prints out a message to the Logger window. |
| console.time | Function | Utilities › Logging & Debugging › console | Starts a timer named label or "default" if no label specified. |
| console.timeEnd | Function | Utilities › Logging & Debugging › console | Ends timer with name label or "default" if no label specified. |
| console.timeLog | Function | Utilities › Logging & Debugging › console | Logs current time for timer named label or "default" if no label specified. |
| console.trace | Function | Utilities › Logging & Debugging › console | Prints out a stack trace to the Logger window. |
| console.warn | Function | Utilities › Logging & Debugging › console | Prints out a message to the Logger window at the warning log level. |
| ConstraintComponent | Class | Physics › Bodies & Colliders | Used to apply specific restrictions on how a SceneObject with BodyComponent can move. |
| Contact | Class | Physics › Collisions & Overlaps | Contact point between two colliding objects. |
| CropTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Base class for Texture Providers that crop an input texture. |
| crypto | Namespace | Utilities › Data & Encoding | |
| crypto.getRandomValues | Function | Utilities › Data & Encoding › crypto | Fills a provided Uint8Array with cryptographically secure random values. |
| crypto.randomUUID | Function | Utilities › Data & Encoding › crypto | Generates a cryptographically secure UUID. |
| crypto.subtle | Namespace | Utilities › Data & Encoding › crypto | |
| crypto.subtle.digest | Function | Utilities › Data & Encoding › crypto | Generates a cryptographic hash of the given data using the specified algorithm. |
| CullMode | Enum | Graphics, Materials & Particles › Rendering & Materials | Used with Pass's cullMode property. |
| CursorPosition | Class | Text & Fonts | The position of a text cursor for a given character index, returned by Text.getCursorPositions and Text3D.getCursorPositions. |
| CustomAsset | Class | Base Classes | Base class for all assets used in the engine. |
| CustomLocationGroupComponent | Class | AR & Tracking › Location & Navigation | A component managing and tracking a group of Custom Locations with known relative transforms. |
| CustomObject3DAsset | Namespace | AR & Tracking › Body | |
| CustomObject3DSpecificData | Namespace | AR & Tracking › Body | |
| CustomVariationStyle | Class | Text & Fonts | A user-defined named style on a variable Font. |
| CylinderShape | Class | Physics › Shapes & Collision Meshes | A cylinder collision shape. |
| DataStoreWithScene | Class | Cloud, Networking & Storage › Storage | A GeneralDataStore that persists data across multiple Snaps within the same Lens session. |
| DebugRender | Class | Utilities › Logging & Debugging | Provides methods to draw primitive visuals for debugging. |
| Decorators | Module | Scripting | The Decorators typings for TypeScript Lens scripts. |
| DeepLinkModule | Class | Lifecycle Events | The DeepLinkModule brings the concept of deep linking, familiar from mobile platforms like Android and iOS, to Spectacles. |
| DeepLinkUriReceivedArgs | Class | Lifecycle Events | Arguments used with the DeepLinkModule#onUriReceived event. |
| DeformingCollisionMesh | Class | Physics › Shapes & Collision Meshes | Used for collision meshes that can change shape or form dynamically. |
| Delay | Class | SnapML | Creates a buffer for the audio data. |
| DelayBuilder | Class | SnapML | Builder class for the Delay. |
| DelayedCallbackEvent | Class | Lifecycle Events | An event that gets triggered after a delay. |
| Delta | Class | SnapML | Local estimate of the derivative of the input data along the selected axis. |
| DeltaBuilder | Class | SnapML | Builder class for Delta. |
| DepthClearOption | Enum | Graphics, Materials & Particles › Rendering & Materials | Settings for the depth clear option modes on a DepthStencilRenderTargetProvider. |
| DepthFrameData | Class | AR & Tracking › Camera › DepthModule | The depth frame data as provided by the DepthFrameSession.onNewFrame. |
| DepthFrameSession | Class | AR & Tracking › Camera | Used for receiving DepthFrameData on Spectacles device. |
| DepthModule | Class | AR & Tracking › Camera | Provides access to a DepthFrameSession on Spectacles device. |
| DepthStencilRenderTargetProvider | Class | Graphics, Materials & Particles › Rendering & Materials | Access to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format. |
| DepthTextureProvider | Class | AR & Tracking › Camera | Provides depth information of the video feed that the Lens is being applied to when available. |
| DeviceCamera | Class | AR & Tracking › Camera | Provides information about the device's camera. |
| DeviceDependentBinFileProvider | Class | Base Classes | |
| DeviceInfoSystem | Class | Utilities › Device & Runtime | Provides information about the device running the Lens. |
| DeviceLocationTrackingComponent | Class | AR & Tracking › Location & Navigation | Used to track a real-world location in a Lens. |
| DeviceTracking | Class | AR & Tracking › World | Enables a SceneObject to align with the movements and orientation of the user's device. |
| DeviceTrackingMode | Enum | AR & Tracking › World | Tracking modes used by the DeviceTracking component to specify what type of tracking to use. |
| DeviceTrackingModule | Class | AR & Tracking › World | The module that allows Device Tracking capabilities in a Lens. |
| Dialog | Namespace | Audio & Voice › Speech | |
| Dialog.Answer | Class | Audio & Voice › Speech › Dialog | Provides answer information in response to DialogModule.askQuestions(). |
| DirectivityEffect | Class | Audio & Voice › Playback & Effects | An Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent. |
| DirectMultiplayerSessionOptions | Class | Connected Lenses (Multiplayer) | |
| DistanceEffect | Class | Audio & Voice › Playback & Effects | An audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent. |
| DomainInfo | Class | Commerce › Shopping › ShoppingModule | The domain of a ShoppingModule. |
| DoubleTapEvent | Class | Interaction | Triggered when a double tap event has occurred. |
| DoubleTapEventArgs | Class | Interaction | Base class for objects representing Script data. |
| DropshadowSettings | Class | Text & Fonts › Text | Used in Text's dropShadowSettings property. |
| DynamicMeshRenderObjectProvider | Class | Graphics, Materials & Particles › Meshes & Effects | RenderObjectProvider for mesh objects generated procedurally. |
| DynamicResource | Class | Cloud, Networking & Storage › Remote Assets & Media | A resource that is resolved at runtime. |
| EditorInteractionProfile | Class | Scripting | Declares how stock Scene Editor Move / Rotate / Scale manipulators may interact with a SceneObject. |
| EncodingType | Enum | Utilities › Data & Encoding | Specifies the format for encoding textures, used with Base64. |
| EventRegistration | Class | Lifecycle Events | |
| exportRequired | Function | Scripting › Decorators | |
| Expressions | Enum | AR & Tracking › Face | |
| ExternalMusicInfo | Class | Audio & Voice › Music & Lyrics | Information about an external music track. |
| ExternalMusicModule | Class | Audio & Voice › Music & Lyrics | Provides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene. |
| EyeColorVisual | Class | AR & Tracking › Face | Applies an eye color effect to a face. |
| EyeToRender | Enum | AR & Tracking › Face | Specifies which eye to apply an EyeColorVisual effect to. |
| FaceCropTextureProvider | Class | AR & Tracking › Face | Texture Provider giving a cropped region of the input texture, calculated based on face position. |
| FaceFoundEvent | Class | AR & Tracking › Face | Triggered when a new face is detected and starts being tracked. |
| FaceInsetRegion | Enum | AR & Tracking › Face | |
| FaceInsetVisual | Class | AR & Tracking › Face | Provides a 2D visual of a section of a tracked face, such as Mouth, Nose, etc. |
| FaceLostEvent | Class | AR & Tracking › Face | Triggered when a face can no longer be tracked. |
| FaceMaskVisual | Class | AR & Tracking › Face | Maps a 2D texture to the user's face. |
| FaceRenderObjectProvider | Class | AR & Tracking › Face | Mesh provider for a Face Mesh. |
| FaceStretchVisual | Class | AR & Tracking › Face | Used to apply deformation effects to specific regions of a tracked face. |
| FaceTrackingEvent | Class | AR & Tracking › Face | This is the base class for all face tracking events. |
| FaceTrackingModule | Class | AR & Tracking › Face | Declares the face tracking permission for your Lens project. |
| FaceTrackingScope | Class | AR & Tracking › Face | The face that a tracker should use. |
| failAsync | Function | Utilities › Logging & Debugging | Unhandled Promise rejections are silently ignored by default. |
| FalloffType | Enum | Graphics, Materials & Particles › Rendering & Materials | The types of light falloff from a LightSource. |
| FileAudioTrackProvider | Class | Audio & Voice › Playback & Effects | Provider for file based Audio Tracks. |
| FileBasedMarkerProvider | Class | AR & Tracking › World | Provides an image marker based on an imported image file. |
| FileLicensedSoundProvider | Class | Audio & Voice › Music & Lyrics | A file track provider of the Licensed Sounds from Asset LIbrary. |
| FileTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | A TextureProvider for textures originating from files. |
| FilteringMode | Enum | Graphics, Materials & Particles › Textures & Video | |
| FixedCollisionMesh | Class | Physics › Shapes & Collision Meshes | Used for collision meshes that remain static and do not change their shape over time. |
| FloatAnimationPropertyTrack | Class | Animation | FloatAnimationPropertyTrack. |
| FloatCurveAnimationPropertyTrack | Class | Animation | FloatCurveAnimationPropertyTrack. |
| FocusEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onFocusEnd event. |
| FocusStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onFocusStart event. |
| Font | Class | Text & Fonts | A font asset used for rendering text. |
| FontCollection | Class | Text & Fonts | An ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families. |
| FontCollectionEntry | Class | Text & Fonts › FontCollection | Represents a single entry in a FontCollection. |
| FontFamily | Class | Text & Fonts | Groups multiple Font assets into a single family, mapping each to a style (weight + italic). |
| FontFamilyEntry | Class | Text & Fonts › FontFamily | Represents a single entry in a FontFamily, mapping a Font asset to a style (weight + italic). |
| FontStyles | Enum | Text & Fonts | |
| FrustumCullMode | Enum | Graphics, Materials & Particles › Rendering & Materials | Mode for setting frustum culling on Pass |
| GameControllerModule | Class | Interaction | Provides access to game controller input on Spectacles. |
| GameControllerModule.AnalogStickInputEvent | Class | Interaction › GameControllerModule | Fired when a thumbstick's axis values change. |
| GameControllerModule.AnalogTriggerInputEvent | Class | Interaction › GameControllerModule | Fired when a trigger's analog axis value changes. |
| GameControllerModule.Button | Enum | Interaction › GameControllerModule | Common gamepad button identifiers. |
| GameControllerModule.ButtonEventType | Enum | Interaction › GameControllerModule | Whether a button changed to pressed or released. |
| GameControllerModule.ButtonInputEvent | Class | Interaction › GameControllerModule | Fired when a button is pressed or released on a connected controller. |
| GameControllerModule.ControllerCapability | Enum | Interaction › GameControllerModule | Optional capabilities a controller may support. |
| GameControllerModule.ControllerConnectedEvent | Class | Interaction › GameControllerModule | Fired when a new game controller is connected. |
| GameControllerModule.ControllerDisconnectedEvent | Class | Interaction › GameControllerModule | Fired when a game controller is disconnected. |
| GameControllerModule.ControllerInfo | Class | Interaction › GameControllerModule | Metadata describing a connected game controller. |
| GameControllerModule.ControllerType | Enum | Interaction › GameControllerModule | Controller family as reported by the device. |
| GameControllerModule.MotionInputEvent | Class | Interaction › GameControllerModule | Fired when motion sensor data (gyroscope, accelerometer) is received. |
| GameControllerModule.RumbleOptions | Class | Interaction › GameControllerModule | Options for a haptic feedback (rumble) request. |
| GameControllerModule.Side | Enum | Interaction › GameControllerModule | Which side of the controller a thumbstick or trigger belongs to. |
| GameControllerModule.TouchInfo | Class | Interaction › GameControllerModule | A single touch point on the controller touchpad. |
| GameControllerModule.TouchpadInputEvent | Class | Interaction › GameControllerModule | Fired when touchpad input is received. |
| GameControllerModule.TouchState | Enum | Interaction › GameControllerModule | State of a single touch point on the controller touchpad. |
| GameControllerSession | Class | Interaction | Represents an active game controller session. |
| GaussianSplattingAsset | Class | Graphics, Materials & Particles › Meshes & Effects | Asset that contains Gaussian Splats. |
| GaussianSplattingVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Allows displaying GaussianSplattingAsset and play its animation. |
| GeneralDataStore | Class | Cloud, Networking & Storage › Storage | Class for storing and retrieving data based on keys. |
| GeoLocation | Namespace | AR & Tracking › Location & Navigation | |
| GeoLocation.createLocationService | Function | AR & Tracking › Location & Navigation › GeoLocation | Creates a new LocationService. |
| GeoLocation.getGeoPositionForLocation | Function | AR & Tracking › Location & Navigation › GeoLocation | Returns the GPS position of a custom location. |
| GeoLocation.getNorthAlignedHeading | Function | AR & Tracking › Location & Navigation › GeoLocation | Calculates heading based on north aligned device orientation. |
| GeoLocationAccuracy | Enum | AR & Tracking › Location & Navigation | Enumeration of supported GPS location accuracy. |
| GeoPosition | Class | AR & Tracking › Location & Navigation | The location of the device. |
| GestureModule | Class | Interaction | Allows to detect hand gestures using machine learning algorithms. |
| GestureModule.HandType | Enum | Interaction › GestureModule | The hand used in gesture detection with GestureModule. |
| GesturesDataArgs | Class | Interaction | |
| getAbsoluteStartTime | Function | Utilities › Time & Timers | The start time of the Lens since UNIX Epoch in seconds. |
| getDeltaTime | Function | Utilities › Time & Timers | Returns the time difference in seconds between the current frame and previous frame. |
| getRealTimeNanos | Function | Utilities › Time & Timers | Get current time in nanoseconds. |
| getTime | Function | Utilities › Time & Timers | Returns the time in seconds since the lens was started. |
| global | Namespace | Scripting | |
| global.debugRenderSystem | Variable | Scripting › global | Returns the DebugRender, which provides methods to draw primitive visuals for debugging. |
| global.deviceInfoSystem | Variable | Scripting › global | Returns the global DeviceInfoSystem, which provides information about the device running the Lens. |
| global.hapticFeedbackSystem | Variable | Scripting › global | Returns the HapticFeedbackSystem, which provides methods to trigger the device's haptic system. |
| global.launchParams | Variable | Scripting › global | Returns the global GeneralDataStore for Launch Params, which provides any special data passed in when the Lens is launched. |
| global.localizationSystem | Variable | Scripting › global | Returns the global LocalizationSystem, which helps convert times, dates, and other units to user friendly strings. |
| global.persistentStorageSystem | Variable | Scripting › global | Returns the global PersistentStorageSystem, which allows data to persist between Lens sessions. |
| global.scene | Variable | Scripting › global | Returns the global ScriptScene object, which offers information and controls for the current scene. |
| global.textInputSystem | Variable | Scripting › global | Returns the TextInputSystem, which provides methods to access the device's keyboard and typing systems. |
| global.touchSystem | Variable | Scripting › global | Returns the global TouchDataProvider, which controls how the Lens handles touch events. |
| global.userContextSystem | Variable | Scripting › global | Returns the global UserContextSystem, which provides information about the user such as display name, birthday, and even current weather. |
| GltfAsset | Class | Graphics, Materials & Particles › Meshes & Effects | Represents a GLTF 3D Model. |
| GltfSettings | Class | Graphics, Materials & Particles › Meshes & Effects › GltfAsset | Settings for importing a glTF Asset. |
| GrabBeginArgs | Class | Interaction | The arguments of the GrabBegin event on GestureModule. |
| GrabEndArgs | Class | Interaction | The arguments of the GrabEnd event on GestureModule. |
| HairDataAsset | Class | Physics › Cloth & Hair | Hair asset converted from an FBX containing splines to be used with HairVisual. |
| HairVisual | Class | Physics › Cloth & Hair | Used to simulate and render hairstyles with realistic lighting and physics. |
| HandRenderObjectProvider | Class | AR & Tracking › Hand | Provider for Hand Mesh render object. |
| HandSpecificData | Class | AR & Tracking › Hand | Provides additional data for the tracked hand. |
| HandTracking3DAsset | Class | AR & Tracking › Hand | Enables Hand Tracking 3D for the ObjectTracking3D component. |
| HandTrackingScope | Class | AR & Tracking › Hand | The hand that a tracker should use. |
| HapticFeedbackSystem | Class | Interaction | Triggers haptic feedback on the device. |
| HapticFeedbackType | Enum | Interaction | The method in which haptic feedback is provided. |
| Head | Class | AR & Tracking › Face | Used to move and rotate SceneObjects in sync with the user's head movements. |
| Headers | Class | Cloud, Networking & Storage › Internet Access | Headers for the Fetch API in RemoteServiceModule. |
| hint | Function | Scripting › Decorators | |
| HintsComponent | Class | UI | Used to display text hints in a Lens. |
| HitTestSession | Class | AR & Tracking › World | Class responsible for detecting intersections between a virtual ray and real-world surfaces. |
| HitTestSessionOptions | Class | AR & Tracking › World › WorldQueryModule | Options for configuring a HitTestSession. |
| HorizontalAlignment | Enum | Text & Fonts | Used by the horizontalAlignment property in MeshVisual. |
| HorizontalOverflow | Enum | Text & Fonts | Options for wrapping text horizontally. |
| HoverEndEvent | Class | Interaction | Triggered when hovering state has ended on an InteractionComponent. |
| HoverEndEventArgs | Class | Interaction | The arguments passed in by HoverEndEvent. |
| HoverEvent | Class | Interaction | Triggered when a mouse hover event occurs. |
| HoverEventArgs | Class | Interaction | Base class for objects representing Script data. |
| HoverStartEvent | Class | Interaction | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| HoverStartEventArgs | Class | Interaction | The arguments passed in by HoverStartEvent. |
| IEventParameters | Class | Lifecycle Events | The base class for parameter objects passed into event callbacks. |
| Image | Class | UI | Used to display 2D textures within a scene. |
| ImageUploadCompressionMethod | Enum | Cloud, Networking & Storage › Remote Assets & Media | Specifies the compression format to use when uploading an image. |
| ImageUploadOptions | Class | Cloud, Networking & Storage › Remote Assets & Media › RemoteMediaModule | Provides configuration options for uploading images via RemoteMediaModule.uploadImage. |
| input | Function | Scripting › Decorators | |
| InputBuilder | Class | SnapML | Builds InputPlaceHolders for MLComponent. |
| InputPlaceholder | Class | SnapML | Controls input data for a neural network used by an MLComponent. |
| IntAnimationPropertyTrack | Class | Animation | IntAnimationPropertyTrack. |
| InteractionComponent | Class | Interaction | Enables invoking touch interactions with a BaseMeshVisual rendered to specific Camera. |
| InternetModule | Class | Cloud, Networking & Storage › Internet Access | Provides access to the open internet. |
| InternetStatusChangedArgs | Class | Utilities › Device & Runtime | Arguments used with the onInternetStatusChanged event. |
| IntStepAnimationPropertyTrack | Class | Animation | IntAnimationPropertyTrack. |
| isNull | Function | Scripting | Returns true if the passed in object is null or destroyed. |
| IsPhoneInHandBeginArgs | Class | Interaction | The arguments of getIsPhoneInHandBeginEvent on GestureModule. |
| IsPhoneInHandEndArgs | Class | Interaction | The arguments of getIsPhoneInHandEndEvent on GestureModule. |
| JsonAsset | Class | Utilities › Data & Encoding | Represents a JsonAsset that can be used to store JSON data in your Lens. |
| KeyboardManager | Namespace | Interaction | |
| KeyboardManager.isKeyPressed | Function | Interaction › KeyboardManager | Returns true if the specified key is currently pressed. |
| KeyModifiers | Enum | Interaction | |
| KeyPressEvent | Class | Interaction | This event is triggered when the user presses a key. |
| KeyReleaseEvent | Class | Interaction | This event is triggered when the user releases a key. |
| Keys | Enum | Interaction | |
| KissFinishedEvent | Class | AR & Tracking › Face | Triggered when the tracked face ends a kiss. |
| KissStartedEvent | Class | AR & Tracking › Face | Triggered when the tracked face starts a kiss. |
| label | Function | Scripting › Decorators | |
| LateUpdateEvent | Class | Lifecycle Events | Event that runs during each frame, only if a Component and its SceneObject is enabled. |
| LayerSet | Class | Scene | Used to describe a set of layers that an object belongs to or interacts with. |
| Leaderboard | Class | User & Friends | A leaderboard which can contain scores and information about participating users. |
| Leaderboard.CreateOptions | Class | User & Friends › Leaderboard | The options for the leaderboard to be made. |
| Leaderboard.OrderingType | Enum | User & Friends › Leaderboard | Describes how the leaderboard should be ordered. |
| Leaderboard.RetrievalOptions | Class | User & Friends › Leaderboard | Describes the context for the leaderboard to be requested. |
| Leaderboard.SafeUserRecord | Class | User & Friends › Leaderboard | Information for a user who submitted a score to the leaderboard, carrying only non-sensitive user data. |
| Leaderboard.UserRecord | Class | User & Friends › Leaderboard | Information for a user who submitted a score to the leaderboard. |
| Leaderboard.UsersType | Enum | User & Friends › Leaderboard | The type of user to be retrieved. |
| LeaderboardModule | Class | User & Friends | Enables usage of Leaderboard API within a Lens. |
| LevelsetColliderAsset | Class | Physics › Cloth & Hair | Collider asset generated from a mesh to be used with the HairVisual as part of the hair simulation. |
| LevelsetShape | Class | Physics › Shapes & Collision Meshes | A levelset collision shape. |
| LicensedAudioTrackAsset | Class | Audio & Voice › Music & Lyrics | A Licensed Sounds audio track from Asset LIbrary. |
| LightSource | Class | Graphics, Materials & Particles › Rendering & Materials | Acts as a source of light in the scene. |
| LightType | Enum | Graphics, Materials & Particles › Rendering & Materials | The types of light emission from a LightSource. |
| LiquifyVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Applies a liquify effect to anything rendered behind it. |
| LoadStatus | Enum | Base Classes | |
| LocalizationsAsset | Class | Text & Fonts | Asset that provides the necessary localized text for your Lens. |
| LocalizationSystem | Class | Text & Fonts | Helps convert data types to localized string representations. |
| LocatedAtComponent | Class | AR & Tracking › Location & Navigation | Enables placing a SceneObject at a real world location provided by LocationAsset and specified relative position. |
| LocationAsset | Class | AR & Tracking › Location & Navigation | Provides a frame of reference in which to localize objects to the real world. |
| LocationCloudStorageModule | Class | Cloud, Networking & Storage › Storage | Provides access to location cloud storage depending upon the LocationCloudStorageOptions. |
| LocationCloudStorageOptions | Class | Cloud, Networking & Storage › Storage › LocationCloudStorageModule | Used to configure LocationCloudStorage module with various options. |
| LocationCloudStore | Class | Cloud, Networking & Storage › Storage | Instance of location cloud store which has a similar interface as cloud store. |
| LocationProximityStatus | Enum | AR & Tracking › Location & Navigation | Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location. |
| LocationRenderObjectProvider | Class | AR & Tracking › Location & Navigation | Provides access to a location's Mesh--such as when working with City Scale AR. |
| LocationService | Class | AR & Tracking › Location & Navigation | The LocationService allows the user to provide their location to Lens applications if they so desire. |
| LocationTextureProvider | Class | AR & Tracking › Location & Navigation | Provides access to a location's texture--such as when working with City Scale AR. |
| LongPressEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onLongPressEnd event. |
| LongPressStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onLonPressStart event. |
| LookAtComponent | Class | Scene | Orients a SceneObject towards a target SceneObject. |
| LookAtComponent.AimVectors | Enum | Scene › LookAtComponent | The "aim" and "up" vectors used with LookAtComponent when determining rotation. |
| LookAtComponent.LookAtMode | Enum | Scene › LookAtComponent | Modes used in LookAtComponent.lookAtMode to determine the rotation method being used. |
| LookAtComponent.WorldUpVector | Enum | Scene › LookAtComponent | Used with LookAtComponent to set the "up" vector when determining rotation. |
| Lyrics | Class | Audio & Voice › Music & Lyrics | Represents the full set of Lyrics data for tracked music. |
| LyricsLine | Class | Audio & Voice › Music & Lyrics | Represents a single line of Lyrics. |
| LyricsSync | Class | Audio & Voice › Music & Lyrics | Represents a single sync/word of a LyricsLine. |
| LyricsTracker | Class | Audio & Voice › Music & Lyrics | Provides information about lyrics data for a currently playing track. |
| LyricsType | Enum | Audio & Voice › Music & Lyrics | Types of granularity for lyric data. |
| MachineLearning | Namespace | SnapML | |
| MachineLearning.createDelayBuilder | Function | SnapML › MachineLearning | Creates a new DelayBuilder object. |
| MachineLearning.createDeltaBuilder | Function | SnapML › MachineLearning | Creates a new DeltaBuilder object. |
| MachineLearning.createInputBuilder | Function | SnapML › MachineLearning | Creates a new InputBuilder object. |
| MachineLearning.createMelSpectrogramBuilder | Function | SnapML › MachineLearning | Creates a new MelSpectrogramBuilder object. |
| MachineLearning.createMFCCBuilder | Function | SnapML › MachineLearning | Creates a new MFCCBuilder object. |
| MachineLearning.createNoiseReductionBuilder | Function | SnapML › MachineLearning | |
| MachineLearning.createOutputBuilder | Function | SnapML › MachineLearning | Creates a new OutputBuilder object. |
| MachineLearning.createPitchShifterBuilder | Function | SnapML › MachineLearning | |
| MachineLearning.createSamplerBuilder | Function | SnapML › MachineLearning | Creates SamplerBuilder. |
| MachineLearning.createSpectrogramBuilder | Function | SnapML › MachineLearning | Creates a new SpectrogramBuilder object. |
| MachineLearning.createTransformerBuilder | Function | SnapML › MachineLearning | Creates a new TransformerBuilder object. |
| MachineLearning.DataLayout | Enum | SnapML › MachineLearning | Used with BasePlaceHolder. |
| MachineLearning.FrameTiming | Enum | SnapML › MachineLearning | Timing options for when MLComponent should start or stop running. |
| MachineLearning.InferenceMode | Enum | SnapML › MachineLearning | Inference modes used by MLComponent.inferenceMode. |
| MachineLearning.ModelState | Enum | SnapML › MachineLearning | Describes the current state of the MLComponent model. |
| MachineLearning.OutputMode | Enum | SnapML › MachineLearning | Types of output used by OutputPlaceholder. |
| ManipulateComponent | Class | Interaction | Handles input information from user touch input via the InteractionComponent to control the Scale, Rotation, and Translation of objects. |
| ManipulateEndEvent | Class | Interaction | This event is triggered when manipulation on the object ends. |
| ManipulateEndEventArgs | Class | Interaction | Arguments used with the ManipulateComponent.onManipulateEnd event. |
| ManipulateFrameIntersectResult | Class | Interaction › ManipulateComponent | Result object returned from ManipulateComponent.intersectManipulateFrame. |
| ManipulateStartEvent | Class | Interaction | This event is triggered when manipulation on the object begins. |
| ManipulateStartEventArgs | Class | Interaction | Arguments used with the ManipulateComponent.onManipulateStart event. |
| ManipulateType | Enum | Interaction | Enum values specifying each type of manipulation. |
| MapModule | Class | AR & Tracking › Location & Navigation | Allows access to map texture data around a specified location. |
| MappingOptions | Class | AR & Tracking › Location & Navigation › LocatedAtComponent | Used with MappingSession to describe the session to be created. |
| MappingSession | Class | AR & Tracking › Location & Navigation | Used with the LocatedAtComponent to map the current physical location. |
| MappingSession.MappingScope | Enum | AR & Tracking › Location & Navigation › MappingSession | Determines what data is included in the checkpoint of the @MappingSession. |
| MappingSession.MappingThrottling | Enum | AR & Tracking › Location & Navigation › MappingSession | Throttling levels for a MappingSession. |
| MapTextureProvider | Class | AR & Tracking › Location & Navigation | A texture of the map at the given location of a LocationAsset. |
| MarkerAsset | Class | AR & Tracking › World | Represents a texture to be tracked with MarkerTrackingComponent. |
| MarkerProvider | Class | AR & Tracking › World | Base class for marker providers. |
| MarkerTrackingComponent | Class | AR & Tracking › World | Used to track images in the camera. |
| MaskingComponent | Class | UI | Masks out visuals and InteractionComponent touch events area within a rectangle defined by ScreenTransform component. |
| mat2 | Class | Math | A 2x2 matrix. |
| mat3 | Class | Math | A 3x3 matrix. |
| mat4 | Class | Math | A 4x4 matrix. |
| Material | Class | Graphics, Materials & Particles › Rendering & Materials | An asset that describes how visual objects should appear. |
| MaterialMeshVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Inherits from BaseMeshVisual and provides access to the Material used in the rendering process. |
| MaterialPropertyOverrides | Class | Graphics, Materials & Particles › Rendering & Materials | Overrides the passes of one material on a single visual. |
| MathUtils | Namespace | Math | |
| MathUtils.clamp | Function | Math › MathUtils | Clamp floating-point value v in the range [lo, hi] (inclusive). |
| MathUtils.DegToRad | Variable | Math › MathUtils | Constant mapping degrees to radians. |
| MathUtils.lerp | Function | Math › MathUtils | Linearly interpolate from floating-point a to b, based on fraction t (where t=0.0 returns a, and t=1.0 returns b). |
| MathUtils.RadToDeg | Variable | Math › MathUtils | Constant mapping radians to degrees. |
| MathUtils.randomRange | Function | Math › MathUtils | Generate a random floating-point value in the range [lo, hi). |
| MathUtils.remap | Function | Math › MathUtils | Map floating-point v from range [inMin, inMax] to [outMin, outMax]. |
| Matter | Class | Physics › Bodies & Colliders | Settings for the physical substance, such as friction and bounciness, of a collider. |
| MediaPickerTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Base class for Texture Providers based on selectable media. |
| MelSpectrogram | Class | SnapML | Computes a mel scale spectrogram - a spectrogram where the frequencies are converted to the mel scale. |
| MelSpectrogramBuilder | Class | SnapML | A builder class for MelSpectrogram. |
| MeshBuilder | Class | Graphics, Materials & Particles › Meshes & Effects | A class for generating meshes at runtime. |
| MeshClassificationFormat | Enum | AR & Tracking › World | Formats of mesh classification used by WorldRenderObjectProvider. |
| MeshIndexType | Enum | Graphics, Materials & Particles › Meshes & Effects | Possible index data types used by MeshBuilder. |
| MeshRenderObjectProvider | Class | Graphics, Materials & Particles › Meshes & Effects | |
| MeshShadowMode | Enum | Graphics, Materials & Particles › Rendering & Materials | |
| MeshShape | Class | Physics › Shapes & Collision Meshes | Allows meshes to be used as collision shapes, for ColliderComponent and BodyComponent. |
| MeshTopology | Enum | Graphics, Materials & Particles › Meshes & Effects | Mesh topology types used by MeshBuilder. |
| MessageEvent | Class | Lifecycle Events | Event fired when a message is received from the host (Lens Studio or an AI agent). |
| MFCC | Class | SnapML | Mel-frequency cepstral coefficients. |
| MFCCBuilder | Class | SnapML | Builder class for the MFCC (Mel Frequency Cepstral Co-efficients). |
| MicrophoneAudioProvider | Class | Audio & Voice › Playback & Effects | The Audio Track Provider of the audio from microphone. |
| MLAsset | Class | SnapML | Represents a machine learning model that can be integrated with an MLComponent. |
| MLComponent | Class | SnapML | Used to integrate machine learning models into a Lens. |
| MotionController | Class | Interaction | Gives access to motion data and touch events from an external device to Spectacles, as well as haptic feedback requests from Spectacles to an external device. |
| MotionController.HapticFeedback | Enum | Interaction › MotionController | Defines a set of haptic feedback patterns that can be requested. |
| MotionController.HapticRequest | Class | Interaction › MotionController | Describes a request for haptic feedback. |
| MotionController.MotionControllerOptions | Class | Interaction › MotionController | Settings for configuring a motion controller. |
| MotionController.MotionType | Enum | Interaction › MotionController | Enum for describing the motion type. |
| MotionController.Options | Namespace | Interaction › MotionController | |
| MotionController.TouchPhase | Enum | Interaction › MotionController | Enum that defines a current state of a touch interaction with the touchpad of the motion controller. |
| MotionController.TrackingQuality | Enum | Interaction › MotionController | Describes Motion Controller tracking quality state, whether the data received from the Motion Controller is accurate or not. |
| MotionControllerModule | Class | Interaction | Provides access to MotionController. |
| MouthClosedEvent | Class | AR & Tracking › Face | Triggered when the tracked face's mouth closes. |
| MouthOpenedEvent | Class | AR & Tracking › Face | Triggered when the tracked face's mouth opens. |
| MultiplayerSession | Class | Connected Lenses (Multiplayer) | An instance of a Connected Lens session among a group of participants who were successfully invited into the experience. |
| NamedInstanceInfo | Class | Text & Fonts › Font | Read-only named axis preset from the font's fvar table, for example "Condensed Bold". |
| NamedValues | Class | AR & Tracking › Face | A type containing two arrays which map positionally to each other. |
| NativeARTrackingState | Enum | AR & Tracking › World | Describes the state of the native AR tracking (SLAM) system that backs DeviceTracking. |
| NativeLibraryAsset | Class | Scripting | NativeLibraryAsset loads a native shared library (e.g. .so, .dylib, .dll) and exposes its exports to JavaScript. |
| NativePlaneTrackingType | Enum | AR & Tracking › World | Tracking type used by the DeviceTracking component to specify what type of plane to detect. |
| NaturalFeatureMarkerProvider | Class | AR & Tracking › World | Base class for marker providers. |
| NoiseReduction | Class | SnapML | Base class for objects representing Script data. |
| NoiseReductionBuilder | Class | SnapML | Base class for objects representing Script data. |
| Object3DAsset | Class | AR & Tracking › Body | Base class for configuring object tracking in the ObjectTracking3D component. |
| ObjectPrefab | Class | Scene | Represents reusable SceneObject hierarchy stored as a resource. |
| ObjectSpecificData | Class | AR & Tracking › Body | Provides additional data for the tracked object. |
| ObjectTracking | Class | AR & Tracking › Body | Used to track objects in 2D space, such as body parts, pet, hand. |
| ObjectTracking3D | Class | AR & Tracking › Body | Used to track objects in 3D space, such as body, hands. |
| ObjectTracking3D.TrackingMode | Enum | AR & Tracking › Body › ObjectTracking3D | Strategies for updating attached objects. |
| ObjectTrackingMaskedTextureProvider | Class | AR & Tracking › Body | |
| ObjectTrackingNormalsTextureProvider | Class | AR & Tracking › Body | |
| ObjectTrackingTextureProvider | Class | AR & Tracking › Body | Controls a segmentation texture and its placement using information provided by Object tracking. |
| OnAwakeEvent | Class | Lifecycle Events | Event that runs immediately when a Component is constructed or deserialized. |
| OnDestroyEvent | Class | Lifecycle Events | Event that runs when a Component will be destroyed. |
| OnDidEnterForegroundEvent | Class | Lifecycle Events | Triggered when the Lens has entered the Foreground phase. |
| OnDidEnterSuspendedEvent | Class | Lifecycle Events | Triggered when the Lens has entered the Suspended phase. |
| OnDisableEvent | Class | Lifecycle Events | Event that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled. |
| OnEnableEvent | Class | Lifecycle Events | Event that runs when a Component becomes enabled, either directly via its own Component.enabled property or because its SceneObject becomes enabled. |
| OnFullScreenEnterEvent | Class | Lifecycle Events | Triggered immediately when the Lens enters full-screen mode. |
| OnFullScreenExitEvent | Class | Lifecycle Events | Triggered when the Lens returns to the standard UI with carousel and other Snapchat UI elements. |
| OnPauseEvent | Class | Lifecycle Events | Triggered when users tap the menu button in Palm UI. |
| OnResumeEvent | Class | Lifecycle Events | Triggered when users tap the menu button in Palm UI during pause state. |
| OnStartEvent | Class | Lifecycle Events | Runs on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering. |
| OnTimeStartEvent | Class | Lifecycle Events | The base class for scenewide events. |
| OnWillEnterForegroundEvent | Class | Lifecycle Events | Triggered when the Lens is about to enter the Foreground phase. |
| OnWillEnterSuspendedEvent | Class | Lifecycle Events | Triggered when the Lens is about to enter the Suspended phase. |
| OS | Enum | Utilities › Device & Runtime | Types of operating system that may be running on the device. |
| OutlineSettings | Class | Text & Fonts › Text | Used in Text's outlineSettings property. |
| OutputBuilder | Class | SnapML | Builds OutputPlaceholders for MLComponent. |
| OutputPlaceholder | Class | SnapML | Provides output data from the neural network used by an MLComponent. |
| Overlap | Class | Physics › Collisions & Overlaps | Exposes state generated for ColliderComponent overlap events. |
| OverlapEnterEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. |
| OverlapExitEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object. |
| OverlapStayEventArgs | Class | Physics › Collisions & Overlaps | Args used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object. |
| PalmTapDownArgs | Class | Interaction | The arguments of the PalmTapDown event on GestureModule |
| PalmTapUpArgs | Class | Interaction | The arguments of the PalmTapUp event on GestureModule |
| PanEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPanEnd event. |
| PanGestureEndEvent | Class | Interaction | Triggered when a pan gesture ends. |
| PanGestureMoveEvent | Class | Interaction | Triggered while the user is panning. |
| PanGestureStartEvent | Class | Interaction | Triggered when a pan gesture starts. |
| PanMoveEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPanMove event. |
| PanStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPanStart event. |
| Pass | Class | Graphics, Materials & Particles › Rendering & Materials | Controls how a mesh will get rendered. |
| PassPropertyOverrides | Class | Graphics, Materials & Particles › Rendering & Materials | Overrides the properties of one material pass on a single visual, without affecting other visuals that use the same material. |
| PassWrapper | Class | Graphics, Materials & Particles › Rendering & Materials | Similar to Pass, except used by VFXAsset. |
| PassWrappers | Class | Graphics, Materials & Particles › Meshes & Effects | Allows for retrieval of a collection of Pass objects used by VFXAsset |
| PerformanceIndexes | Class | Utilities › Device & Runtime | Provides information about the device running the Lens. |
| PersistentStorageSystem | Class | Cloud, Networking & Storage › Storage | Allows data to be stored and retrieved between Lens sessions. |
| PersonTrackingScope | Class | AR & Tracking › Body | The person that a tracker should use. |
| Physics | Namespace | Physics › Bodies & Colliders | |
| Physics.Constraint | Class | Physics › Bodies & Colliders › Physics | Constraints body motion in configurable ways, for simulating physical objects such as joints and hinges. |
| Physics.ConstraintType | Enum | Physics › Bodies & Colliders › Physics | Constraint type used by a Constraint. |
| Physics.createGlobalProbe | Function | Physics › Bodies & Colliders › Physics | Create an intersection probe that spans all worlds. |
| Physics.createRootProbe | Function | Physics › Bodies & Colliders › Physics | Create an intersection probe for the implicit root world. |
| Physics.Filter | Class | Physics › Bodies & Colliders › Physics | Script interface for applying collision filtering to colliders and ray/shape-casts. |
| Physics.FixedConstraint | Class | Physics › Bodies & Colliders › Physics | Fully constrain rotation and translation. |
| Physics.ForceMode | Enum | Physics › Bodies & Colliders › Physics | Type of force to use when applying force or torque to a BodyComponent. |
| Physics.getRootWorldSettings | Function | Physics › Bodies & Colliders › Physics | Get settings that apply to the implicit root world. |
| Physics.HingeConstraint | Class | Physics › Bodies & Colliders › Physics | Constraints translation and a single axis of rotation. |
| Physics.HingeLimitSettings | Class | Physics › Bodies & Colliders › Physics | Settings that describe how the position of the object should be limited in respect to the applied forces. |
| Physics.HingeMotorSettings | Class | Physics › Bodies & Colliders › Physics | Settings describing the independent force (motor) applied to the constraint. |
| Physics.HingeMotorType | Enum | Physics › Bodies & Colliders › Physics | Enum that defines motor type. |
| Physics.PointConstraint | Class | Physics › Bodies & Colliders › Physics | A type of constraint that only allows rotation. |
| Physics.WorldSettingsAsset | Class | Physics › Bodies & Colliders › Physics | Stores reusable settings for a Physics WorldComponent such as gravity magnitude and direction. |
| PinchDownArgs | Class | Interaction | The arguments of the PinchDown event on GestureModule |
| PinchEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPinchEnd event. |
| PinchGestureEndEvent | Class | Interaction | Triggered when a pinch gesture ends. |
| PinchGestureMoveEvent | Class | Interaction | Triggered while the user is pinching. |
| PinchGestureStartEvent | Class | Interaction | Triggered when a pinch gesture starts. |
| PinchMoveEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPinchMove event. |
| PinchStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onPinchStart event. |
| PinchStrengthArgs | Class | Interaction | The arguments of the PinchStrength event on GestureModule |
| PinchUpArgs | Class | Interaction | The arguments of the PinchUp event on GestureModule |
| PinToMeshComponent | Class | Graphics, Materials & Particles › Meshes & Effects | Attaches the SceneObject to the mesh surface of a specific RenderMeshVisual. |
| PinToMeshComponent.Orientation | Enum | Graphics, Materials & Particles › Meshes & Effects › PinToMeshComponent | Used with PinToMeshComponent.orientation. |
| PitchShifter | Class | SnapML | Base class for objects representing Script data. |
| PitchShifterBuilder | Class | SnapML | Base class for objects representing Script data. |
| PlaybackMode | Enum | Animation | Used with AnimationClip to describe how the clip should be played. |
| PointCloud | Class | AR & Tracking › World | Represents 3D locations of stationary features in the environment. |
| PositionEffect | Class | Audio & Voice › Playback & Effects | An Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component. |
| PostEffectVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Uses an input color lookup table image to adjust the coloring of the Lens. |
| Function | Utilities › Logging & Debugging | Prints out a message to the Logger window. | |
| Probe | Class | Physics › Ray Casts | Performs collision tests (such as ray casts) in one or more world. |
| ProceduralMeshRenderObjectProvider | Class | Graphics, Materials & Particles › Meshes & Effects | RenderObjectProvider for mesh objects generated procedurally. |
| ProceduralTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Provides a texture that can be written to or read from. |
| ProcessedLocationModule | Class | AR & Tracking › Location & Navigation | Declares the precise location tracking permission for your Lens project. |
| Properties | Class | Graphics, Materials & Particles › Meshes & Effects | |
| PropertyOverrides | Class | Graphics, Materials & Particles › Rendering & Materials | Overrides material properties on a single visual, without affecting other visuals that use the same material. |
| Provider | Class | Base Classes | Base class for all resource providers. |
| ProxyTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Texture Provider used as output from other systems, for instance SnapML. |
| quat | Class | Math | A quaternion, used to represent rotation. |
| QuatAnimationPropertyTrack | Class | Animation | QuatAnimationPropertyTrack. |
| QuatSlerpAnimationPropertyTrack | Class | Animation | QuatSlerpAnimationPropertyTrack. |
| RawLocationModule | Class | AR & Tracking › Location & Navigation | Declares the coarse location tracking permission for your Lens project. |
| RayCastHit | Class | Physics › Ray Casts | Hit results of a ray-cast provided to script. |
| RayTracingSettings | Class | Graphics, Materials & Particles › Rendering & Materials | Ray Tracing settings for a camera. |
| RealtimeStoreCreateOptions | Class | Connected Lenses (Multiplayer) › MultiplayerSession | The options for the realtime store. |
| RealtimeStoreCreateOptions.Ownership | Enum | Connected Lenses (Multiplayer) › RealtimeStoreCreateOptions | The ownership model of a realtime store. |
| RealtimeStoreCreateOptions.Persistence | Enum | Connected Lenses (Multiplayer) › RealtimeStoreCreateOptions | The persistence model for a realtime store. |
| RecordingState | Enum | Lifecycle Events | Describes the current recording state of the Lens. |
| Rect | Class | Math | An axis aligned rectangle. |
| RectangleSetter | Class | UI | Positions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider. |
| RectCropTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Texture Provider providing a cropped region of the input texture. |
| RemoteApiRequest | Class | Cloud, Networking & Storage › RemoteServiceModule | |
| RemoteApiResponse | Class | Cloud, Networking & Storage › RemoteServiceModule | |
| RemoteMediaModule | Class | Cloud, Networking & Storage › Remote Assets & Media | Allows the Lens to download and integrate remote media content such as 3D GLTF assets, images, audio tracks, and video textures into Lenses. |
| RemoteReferenceAsset | Class | Cloud, Networking & Storage › Remote Assets & Media | Provides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script. |
| RemoteServiceHttpRequest | Class | Cloud, Networking & Storage › Internet Access › InternetModule | A http request which can be sent using the RemoteServiceModule. |
| RemoteServiceHttpRequest.HttpRequestMethod | Enum | Cloud, Networking & Storage › Internet Access › RemoteServiceHttpRequest | The http method which should be used to send this http request. |
| RemoteServiceHttpResponse | Class | Cloud, Networking & Storage › Internet Access › InternetModule | The response returned by a RemoteServiceHttpRequest call. |
| RemoteServiceModule | Class | Cloud, Networking & Storage | Provides access to Snap authorized remote services. |
| RenderMesh | Class | Graphics, Materials & Particles › Meshes & Effects | Represents a mesh asset. |
| RenderMeshVisual | Class | Graphics, Materials & Particles › Meshes & Effects | Extends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene. |
| RenderObjectProvider | Class | Graphics, Materials & Particles › Meshes & Effects | Provider for RenderMesh data. |
| RenderTargetProvider | Class | Graphics, Materials & Particles › Rendering & Materials | Controls a camera texture resource. |
| RenderTargetProvider.AntialiasingMode | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | The anti-aliasing technique to use on a render target. |
| RenderTargetProvider.AntialiasingQuality | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | The fidelity of the anti-aliasing technique to apply. |
| RenderTargetProvider.DepthBufferUsage | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Controls depth buffer usage strategy for the render target. |
| RenderTargetProvider.MSAAStrategy | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | How MSAA should be applied to the render target. |
| RenderTargetProvider.OutputResolution | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Controls the resolution source for the render target. |
| RenderTargetProvider.TextureType | Enum | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Specifies what kind of render target it is. |
| Request | Class | Cloud, Networking & Storage › Internet Access | Represents an HTTP request used by the Fetch API in RemoteServiceModule. |
| require | Function | Scripting | Load a JavaScript module. |
| requireAsset | Function | Scripting | Load an asset like a Texture, Material, or MLAsset directly from script. |
| requireType | Function | Scripting | Load a script by name or path in order to use that type to create or get a component at runtime. |
| Response | Class | Cloud, Networking & Storage › Internet Access | Represents an HTTP response used by the Fetch API in RemoteServiceModule. |
| RestrictedResource | Class | Cloud, Networking & Storage › Remote Assets & Media | A DynamicResource whose raw data cannot be retrieved as bytes or string. |
| RetouchVisual | Class | AR & Tracking › Face | Adds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc. |
| ReverseCameraTextureProvider | Class | AR & Tracking › Camera | Texture Provider giving the camera texture that is the opposite of CameraTextureProvider. |
| RotatedRect | Class | SnapML | |
| RotationOptions | Class | AR & Tracking › World › DeviceTracking | Used with DeviceTracking#rotationOptions to change settings for Rotation tracking mode. |
| runInEditor | Function | Scripting › Decorators | |
| SafeUser | Class | User & Friends | Represents a user of the current runtime with only non-sensitive information (Bitmoji info). |
| Sampler | Class | SnapML | |
| SamplerBuilder | Class | SnapML | Class for building Sampler. |
| SamplerWrapper | Class | Graphics, Materials & Particles › Rendering & Materials | An accessor for Pass.samplers when using PassWrappers |
| SamplerWrappers | Class | Graphics, Materials & Particles › Rendering & Materials | A proxy class that provides the access to the properties of the sampler under the hood of the passes contained in the Material asset and VFXAsset via either… |
| ScanModule | Class | AR & Tracking › World | Provides access to a Scan system that allows users to scan objects, places, and cars with a database of item labels within a Lens. |
| ScanModule.Contexts | Namespace | AR & Tracking › World › ScanModule | |
| ScanModule.Contexts.Cars | Variable | AR & Tracking › World › ScanModule | Category containing cars. |
| ScanModule.Contexts.Objects | Variable | AR & Tracking › World › ScanModule | Category containing objects. |
| ScanModule.Contexts.Places | Variable | AR & Tracking › World › ScanModule | Category containing places. |
| SceneActivityPhase | Enum | Lifecycle Events | Represents the current lifecycle activity phase of the Scene. |
| SceneEvent | Class | Lifecycle Events | The base class for scenewide events. |
| SceneObject | Class | Scene | An object in the scene hierarchy, containing a Transform and possibly Component. |
| SceneObjectEvent | Class | Lifecycle Events | Base class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.). |
| ScreenRegionComponent | Class | UI | Overrides the settings on a local ScreenTransform to fit specific screen region on the device. |
| ScreenRegionType | Enum | UI | Types of screen regions that can be used with ScreenRegionComponent. |
| ScreenTextureProvider | Class | Graphics, Materials & Particles › Rendering & Materials | Texture providing the current Render Target being rendered. |
| ScreenTransform | Class | UI | Used for positioning objects in 2D screen space. |
| script | Variable | Scripting | |
| ScriptAsset | Class | Scripting | Represents a JavaScript or TypeScript script that can be used to add logic in your Lens. |
| ScriptComponent | Class | Scripting | Used to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity. |
| ScriptObject | Class | Base Classes | Base class for objects representing Script data. |
| ScriptProfiler | Namespace | Utilities › Logging & Debugging | |
| ScriptProfiler.startSampling | Function | Utilities › Logging & Debugging › ScriptProfiler | Starts the sampling profiler. |
| ScriptProfiler.stopSampling | Function | Utilities › Logging & Debugging › ScriptProfiler | Stops the sampling profiler and writes the trace to device storage. |
| ScriptScene | Class | Scene | Represents the Lens scene. |
| ScrollEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onScrollEnd event. |
| ScrollEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onScroll event. |
| ScrollStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent#onScrollStart event. |
| SegmentationModel | Class | AR & Tracking › Camera | Segmentation model used for SegmentationTextureProvider. |
| SegmentationTextureProvider | Class | AR & Tracking › Camera | Controls a segmentation texture resource. |
| SelectEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onSelectEnd event. |
| SelectStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onSelectStart event. |
| SerializableWithUID | Class | Base Classes | Low-level data class. |
| setTimeout | Function | Utilities › Time & Timers | Sets a timeout to call the provided callback after the specified number of milliseconds. |
| ShadowMapQuality | Enum | Graphics, Materials & Particles › Rendering & Materials | |
| ShadowType | Enum | Graphics, Materials & Particles › Rendering & Materials | The types of shadows that a LightSource can cast. |
| Shape | Class | Physics › Shapes & Collision Meshes | Base type for collision shapes. |
| ShoppingLoadingIndicator | Class | Commerce › Shopping | Represents the loading state of the ShoppingModule. |
| ShoppingModule | Class | Commerce › Shopping | Allows the creation of Shopping Lenses with an integrated Product Catalog. |
| showIf | Function | Scripting › Decorators | |
| Skin | Class | Graphics, Materials & Particles › Meshes & Effects | Represents skinning data for rigged meshes. |
| SliderWidget | Class | Scripting › UIControl | |
| SmileFinishedEvent | Class | AR & Tracking › Face | Triggered when a smile ends on the tracked face. |
| SmileStartedEvent | Class | AR & Tracking › Face | Triggered when a smile begins on the tracked face. |
| SnapchatFriendUserInfo | Class | User & Friends | Details about friendship between the active user and another user. |
| SnapchatUser | Class | User & Friends | A User backed by a Snapchat account. |
| SnapcodeMarkerProvider | Class | AR & Tracking › World | Provides a marker for tracking Snapcodes. |
| SnapData | Namespace | User & Friends | |
| SnapData.addUserMention | Function | User & Friends › SnapData | If a Snap is taken, the passed in user will be included in a mention sticker. |
| SnapImageCaptureEvent | Class | Lifecycle Events | Called when the user taps on the capture button to record an image. |
| SnapOS | Namespace | Utilities › Device & Runtime | |
| SnapOS.onThrottleStateChanged | Variable | Utilities › Device & Runtime › SnapOS | Fires whenever the SnapOS Dynamic Power Manager throttle state changes, delivering the current ThrottleState. |
| SnapRecordStartEvent | Class | Lifecycle Events | Gets called when the user starts long pressing the capture button to record a Snap. |
| SnapRecordStopEvent | Class | Lifecycle Events | Gets called when the user stops long pressing the Snap button to end recording of a Snap. |
| SortOrder | Enum | SnapML | Order that inTensor will be sorted when applying TensorMath.argSortMasked(). |
| SoundSync | Class | Audio & Voice › Music & Lyrics | Represents beat synchronization data for a music track. |
| SoundSyncBeat | Class | Audio & Voice › Music & Lyrics | Represents a single musical beat used to synchronize effects with music. |
| SoundSyncTracker | Class | Audio & Voice › Music & Lyrics | Tracks music beats and provides events for beat occurrences and playback state changes. |
| SourceMaps | Namespace | Utilities › Logging & Debugging | |
| SourceMaps.applyToStackTrace | Function | Utilities › Logging & Debugging › SourceMaps | Applies the SourceMaps to the stack trace to map JavaScript to TypeScript. |
| SpatialAudio | Class | Audio & Voice › Playback & Effects | Base class for objects representing Script data. |
| SpecsInteractionModule | Class | Interaction | Entry point for the SPECS Interaction System. |
| SpecsInteractionModule.BoxOverlapProbe | Class | Interaction › SpecsInteractionModule | An OverlapProbe whose volume is an oriented box that tracks the SceneObject's world rotation (uniform scale only). |
| SpecsInteractionModule.CastHit | Class | Interaction › SpecsInteractionModule | Hit result returned by SpecsInteractionModule's cast queries. |
| SpecsInteractionModule.Cursor | Class | Interaction › SpecsInteractionModule | The latest cursor pose for an interactor. |
| SpecsInteractionModule.CursorVisualMode | Enum | Interaction › SpecsInteractionModule | Cursor visual treatment. |
| SpecsInteractionModule.CursorVisualState | Class | Interaction › SpecsInteractionModule | Cursor visual state, passed to SpecsInteractionModule.Interactor#setCursorVisualState. |
| SpecsInteractionModule.DebugVisualizerOptions | Class | Interaction › SpecsInteractionModule | Which debug visualizers the interaction system draws for this Lens's interaction content. |
| SpecsInteractionModule.FieldState | Enum | Interaction › SpecsInteractionModule | The targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), h… |
| SpecsInteractionModule.InteractableOptions | Class | Interaction › SpecsInteractionModule | Options supplied when registering an interactable. |
| SpecsInteractionModule.InteractionPlaneOptions | Class | Interaction › SpecsInteractionModule | Options supplied when registering an interaction plane. |
| SpecsInteractionModule.Interactor | Class | Interaction › SpecsInteractionModule | A live interactor. |
| SpecsInteractionModule.InteractorKind | Enum | Interaction › SpecsInteractionModule | The category of an interactor. |
| SpecsInteractionModule.Overlap | Class | Interaction › SpecsInteractionModule | One collider inside an overlap probe's volume, with an id stable from the enter to the exit of that membership. |
| SpecsInteractionModule.OverlapEnterEventArgs | Class | Interaction › SpecsInteractionModule | Args for OverlapProbe#onOverlapEnter, delivered once per frame: enteredOverlaps, every membership that entered the probe's volume this frame. |
| SpecsInteractionModule.OverlapExitEventArgs | Class | Interaction › SpecsInteractionModule | Args for OverlapProbe#onOverlapExit, delivered once per frame: exitedOverlaps, every membership that left the probe's volume this frame (or whose collider wa… |
| SpecsInteractionModule.OverlapProbe | Class | Interaction › SpecsInteractionModule | An edge-triggered overlap probe. |
| SpecsInteractionModule.OverlapProbeOptions | Class | Interaction › SpecsInteractionModule | Options supplied when creating an OverlapProbe. |
| SpecsInteractionModule.SphereOverlapProbe | Class | Interaction › SpecsInteractionModule | An OverlapProbe whose volume is a sphere. |
| SpecsInteractionModule.TargetingMode | Enum | Interaction › SpecsInteractionModule | How an interactor can target an Interactable, as a bitmask of interaction methods. |
| SpecsInteractionModule.TargetingPriority | Enum | Interaction › SpecsInteractionModule | Targeting priority for this Interactable. |
| SpecsInteractionModule.TargetingRay | Class | Interaction › SpecsInteractionModule | The latest targeting ray for an interactor. |
| SpecsInteractionModule.TargetingVisual | Enum | Interaction › SpecsInteractionModule | The targeting visual shown while an interactor targets an Interactable or InteractionPlane. |
| SpecsInteractionModule.TriangleHit | Class | Interaction › SpecsInteractionModule | Triangle hit information, available when a cast from SpecsInteractionModule intersects a collision mesh. |
| SpecsUser | Class | User & Friends | A User backed by a Specs (Spectacles) account, which may or may not have a Snapchat account linked. |
| SpectaclesHandSpecificData | Class | AR & Tracking › Hand | |
| SpectaclesMobileKitModule | Class | Cloud, Networking & Storage › Spectacles Mobile Kit | SpectaclesMobileKitModule serves as the primary entry point for the Spectacles Mobile Kit, enabling interaction with a specific mobile application, such as r… |
| SpectaclesMobileKitSession | Class | Cloud, Networking & Storage › Spectacles Mobile Kit | Spectacles Mobile Kit session allows you to initiate the connection to peer, and send data. |
| Spectrogram | Class | SnapML | Representation the signal strength over time at various frequencies present in a particular waveform. |
| SpectrogramBuilder | Class | SnapML | The builder class for Spectrogram. |
| SphereShape | Class | Physics › Shapes & Collision Meshes | A sphere collision shape. |
| SpinBoxWidget | Class | Scripting › UIControl | |
| StateInfo | Class | Commerce › Shopping › ShoppingModule | A state used in an DomainInfo used by a ShoppingModule. |
| StencilClearOption | Enum | Graphics, Materials & Particles › Rendering & Materials | Stencil buffer clear option. |
| StencilFace | Enum | Graphics, Materials & Particles › Rendering & Materials | Specifies whether the front and/or back face stencil test will be applied. |
| StencilFunction | Enum | Graphics, Materials & Particles › Rendering & Materials | Specifies the stencil test function. |
| StencilOperation | Enum | Graphics, Materials & Particles › Rendering & Materials | Options for specifying the action to take when stencil and depth tests resolve. |
| StencilState | Class | Graphics, Materials & Particles › Rendering & Materials | The stencil test state for Pass. |
| StorageOptions | Class | Connected Lenses (Multiplayer) | Settings for saving values in a MultiplayerSession. |
| StorageScope | Enum | Cloud, Networking & Storage › Storage | Specifies a scope for storing or retrieving values from a MultiplayerSession. |
| StretchMode | Enum | UI | Options for stretching a mesh to fit a ScreenTransform Used in RenderMeshVisual stretchMode property, as long as the SceneObject has a ScreenTransform attached. |
| StretchPoint | Class | AR & Tracking › Face | A point in the FaceStretchVisual feature. |
| Studio | Namespace | Utilities › Logging & Debugging | |
| Studio.log | Function | Utilities › Logging & Debugging › Studio | Prints out a message to the Logger window in Studio. |
| SupabaseModule | Class | Cloud, Networking & Storage › Snap Cloud | Provides access to Supabase authentication and database capabilities. |
| SupabaseProject | Class | Cloud, Networking & Storage › Snap Cloud | Represents a Supabase project with configuration details. |
| SurfaceClassification | Enum | AR & Tracking › World | The classification of the surface at the position where the ray intersects with the environment. |
| SurfaceOptions | Class | AR & Tracking › World › DeviceTracking | Used with DeviceTracking#surfaceOptions to change settings for Surface tracking mode. |
| SurfaceTouchDataArgs | Class | AR & Tracking › World | |
| SystemMenuModule | Namespace | Utilities › Device & Runtime | |
| TangentType | Enum | Animation | Used with AnimationKeyFrame. |
| TapEvent | Class | Interaction | This event is triggered when the user taps on the screen. |
| TapEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onTap event. |
| TargetingDataArgs | Class | Interaction | |
| TensorMath | Namespace | SnapML | |
| TensorMath.addScalar | Function | SnapML › TensorMath | Adds a scalar value to each element of inTensor and puts the result into outTensor. |
| TensorMath.addTensors | Function | SnapML › TensorMath | Adds inTensorA to inTensorB and puts the result into outTensor. |
| TensorMath.amplitudeToDb | Function | SnapML › TensorMath | Converts inTensor from the amplitude scale to the decibel scale. |
| TensorMath.applyBoxFilter | Function | SnapML › TensorMath | Blurs an image tensor using the box filter. |
| TensorMath.applyNMS | Function | SnapML › TensorMath | |
| TensorMath.applyThreshold | Function | SnapML › TensorMath | Applies a fixed-level threshold to each array element. |
| TensorMath.approximatePolygonalCurve | Function | SnapML › TensorMath | Approximates a polygonal curve with the specified precision. |
| TensorMath.argMax | Function | SnapML › TensorMath | Returns the indices of the maximum values along an the channels of inTensor, with the specified inShape. |
| TensorMath.argSort | Function | SnapML › TensorMath | Similar to numpy.argsort(), but in TensorMath, we have no kind and order parameters. |
| TensorMath.argSortMasked | Function | SnapML › TensorMath | Applies a list of indices of a tensor in sorted order of their corresponding values in the tensor to the given outTensor. |
| TensorMath.BorderType | Enum | SnapML › TensorMath | |
| TensorMath.clamp | Function | SnapML › TensorMath | Clamps all values of inTensor between minVal and maxVal, and puts the result into outTensor. |
| TensorMath.concat | Function | SnapML › TensorMath | Concatenates inTensorA and inTensorB along the specified axis and puts the result to the outTensor. |
| TensorMath.dilate | Function | SnapML › TensorMath | Dilates an image by using a specific structuring element. |
| TensorMath.divTensors | Function | SnapML › TensorMath | Divides inTensorA by inTensorB and puts the result into outTensor. |
| TensorMath.drawLine | Function | SnapML › TensorMath | Draws a line segment connecting two points. |
| TensorMath.erode | Function | SnapML › TensorMath | Erodes an image by using a specific structuring element. |
| TensorMath.fillConvexPoly | Function | SnapML › TensorMath | Fills a convex polygon. |
| TensorMath.fillPoly | Function | SnapML › TensorMath | Fills a polygon. |
| TensorMath.findContours | Function | SnapML › TensorMath | Returns contours. |
| TensorMath.findMinDistancesBetween | Function | SnapML › TensorMath | Finds minimum distances between each 2D point from one array, to 2D points in another array. |
| TensorMath.getContour | Function | SnapML › TensorMath | Looks for contour points in a grayscale texture, or any one-channel tensor. |
| TensorMath.getRotatedRectPoints | Function | SnapML › TensorMath | |
| TensorMath.getVectorsLength | Function | SnapML › TensorMath | Calculates the length of all vectors in an array. |
| TensorMath.isInRectangle | Function | SnapML › TensorMath | Checks for each 2D point whether it is inside of a rectangle. |
| TensorMath.max | Function | SnapML › TensorMath | Places the maximum values of inTensor into outTensor. |
| TensorMath.maxDistanceBetweenPoints | Function | SnapML › TensorMath | From the input points, finds the two points with the maximum distance between them and returns this distance. |
| TensorMath.maxInSlideWindow | Function | SnapML › TensorMath | If we consider the tensor as a 3D array, this function finds the indexes of the maximum element in each subarray of size window. |
| TensorMath.min | Function | SnapML › TensorMath | Places the minimum values of inTensor into outTensor. |
| TensorMath.minAreaRect | Function | SnapML › TensorMath | Return TensorMath's format of RotatedRect. |
| TensorMath.minInSlideWindow | Function | SnapML › TensorMath | If we consider the tensor as a 3D array, this function finds the indexes of the minimum element in each subarray of size window. |
| TensorMath.mulMatToPoints | Function | SnapML › TensorMath | Multiply a matrix by a set of points through an efficient batch operation. |
| TensorMath.mulScalar | Function | SnapML › TensorMath | Multiplies each element of inTensor by a scalar value and puts the result into outTensor. |
| TensorMath.mulTensors | Function | SnapML › TensorMath | Multiplies inTensorA and inTensorB and puts the result into outTensor. |
| TensorMath.opticalFlow | Function | SnapML › TensorMath | Stabilizes image objects between two consecutive frames caused by camera or object movement. |
| TensorMath.permute | Function | SnapML › TensorMath | Rearranges the inTensor of inShape according to the desired ordering and puts the result into outTensor. |
| TensorMath.polarSort2d | Function | SnapML › TensorMath | Sorts 2D points by polar angle relative to the center point. |
| TensorMath.power | Function | SnapML › TensorMath | Raises elements of inTensor to the power of val, and puts the results into outTensor. |
| TensorMath.powerToDb | Function | SnapML › TensorMath | Converts inTensor from the power scale to the decibel scale. |
| TensorMath.projectPoints | Function | SnapML › TensorMath | Project 3D points into 2D space using an efficient batch operation. |
| TensorMath.repeat | Function | SnapML › TensorMath | Duplicates inTensor elements and store result in the outTensor. |
| TensorMath.rotatePoints3d | Function | SnapML › TensorMath | Applies a rotation to each point in a set of 3D points, and places the results in outPoints. |
| TensorMath.smoothPoints | Function | SnapML › TensorMath | Smooths a polygon formed by input points. |
| TensorMath.softArgMax | Function | SnapML › TensorMath | Applies softArgMax function to the inTensor, with the specified inShape. |
| TensorMath.softMax | Function | SnapML › TensorMath | Applies softMax function to inTensor, with the specified inShape. |
| TensorMath.solvePnP | Function | SnapML › TensorMath | Estimates the object pose given a set of object points (inObjectPoints), their corresponding image projections (inImagePoints), and the intrinsic camera matr… |
| TensorMath.solvePnPExtended | Function | SnapML › TensorMath | Estimates the object pose given a set of object points (inObjectPoints), their corresponding image projections (inImagePoints), and the intrinsic camera matr… |
| TensorMath.solvePnPRansac | Function | SnapML › TensorMath | solvePnPRansac is very similar to solvePnPExtended except that it uses Random Sample Consensus ( RANSAC ) for robustly estimating the pose. |
| TensorMath.subpixelArgMax | Function | SnapML › TensorMath | Applies subpixelArgMax function to the inTensor, with the specified inShape and kernel size. |
| TensorMath.subTensors | Function | SnapML › TensorMath | Subtracts inTensorB from inTensorA and puts the result into outTensor. |
| TensorMath.sum | Function | SnapML › TensorMath | Calculate the sum of the inTensor elements and store result in the outTensor. |
| TensorMath.textureToGrayscale | Function | SnapML › TensorMath | Converts the texture to a set of 0-255 grayscale values, and outputs the result into outTensor. |
| TensorMath.ThresholdMethod | Enum | SnapML › TensorMath | |
| Text | Class | Text & Fonts | Renders 2D text with specific style and layout. |
| Text3D | Class | Text & Fonts | Renders 3D text with specific style, layout and material. |
| Text3DExtrudeDirection | Enum | Text & Fonts | Controls the direction in which Text3D meshes are extruded relative to the component's local position. |
| TextAreaWidget | Class | Scripting › UIControl | |
| TextDecoder | Class | Utilities › Data & Encoding | Contains methods for Text decoding |
| TextEncoder | Class | Utilities › Data & Encoding | Contains methods for Text encoding |
| TextFill | Class | Text & Fonts | Fill settings used by several text related classes. |
| TextFillMode | Enum | Text & Fonts | Used in TextFill's mode property. |
| TextInputModule | Class | Interaction | Declares the Input Framework (Text) permission for your Lens project. |
| TextInputSystem | Class | Interaction | Provides access to the device's input system. |
| TextInputSystem.KeyboardKind | Enum | Interaction › TextInputSystem | The kind of keyboard currently serving the text input session. |
| TextInputSystem.KeyboardOptions | Class | Interaction › TextInputSystem | The settings used for how the input keyboard should work. |
| TextInputSystem.KeyboardType | Enum | Interaction › TextInputSystem | The different input style of keyboard input. |
| TextInputSystem.ReturnKeyType | Enum | Interaction › TextInputSystem | The return key style of keyboard input. |
| TextInputSystem.TextFieldAction | Enum | Interaction › TextInputSystem | Editor action for the text field (e.g. when user presses action key on keyboard). |
| TextInputSystem.TextUpdate | Class | Interaction › TextInputSystem | Text update from the input method (text and selection range). |
| TextProvider | Class | Text & Fonts | Controls a text rendering texture. |
| TextToSpeech | Namespace | Audio & Voice › Speech | |
| TextToSpeech.VoiceNames | Namespace | Audio & Voice › Speech › TextToSpeech | |
| Texture | Class | Graphics, Materials & Particles › Textures & Video | Represents a texture file asset. |
| TextureFormat | Enum | Graphics, Materials & Particles › Textures & Video | |
| TextureProvider | Class | Graphics, Materials & Particles › Textures & Video | The base class for specialized Texture providers. |
| TextureTrackingScope | Class | AR & Tracking | Provides a Texture to do face tracking on for entities like Head, FaceStretch, and FaceMesh. |
| TextureUsage | Enum | Graphics, Materials & Particles › Textures & Video | Texture capabilities that can be queried for a TextureFormat with DeviceInfoSystem#isFormatSupported. |
| ThrottleMode | Enum | Utilities › Device & Runtime | The device's thermal/power throttle level as reported by the SnapOS Dynamic Power Manager. |
| ThrottleState | Class | Utilities › Device & Runtime | A complete snapshot of the device's Dynamic Power Manager throttle state. |
| TileZone | Enum | Text & Fonts | Defines the bounding area used for texture tiling with TextFill's tileZone property. |
| TouchDataProvider | Class | Interaction | This provider is returned by global.touchSystem and allows your lens to handle any touches on the screen, and optionally let certain touch types to pass thro… |
| TouchEndEvent | Class | Interaction | Triggered when a touch event ends. |
| TouchEndEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onTouchEnd event. |
| TouchMoveEvent | Class | Interaction | Triggered when a touch position on the screen is moved. |
| TouchMoveEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onTouchMove event. |
| TouchStartEvent | Class | Interaction | Triggered when a touch event starts. |
| TouchStartEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onTouchStart event. |
| TouchState | Enum | Interaction | |
| TrackedMesh | Class | AR & Tracking › World | Represents a mesh generated by world tracking. |
| TrackedMeshFaceClassification | Enum | AR & Tracking › World | Classifications of mesh face. |
| TrackedMeshHistogramResult | Class | AR & Tracking › World › DeviceTracking | Provides histogram information about tracked world mesh faces in a given area. |
| TrackedMeshHitTestResult | Class | AR & Tracking › World › WorldRaycast | Provides information about a TrackedMesh surface hit during a raycast. |
| TrackedPlane | Class | AR & Tracking › World | A representation for plane detected by native tracking. |
| TrackedPlaneClassification | Enum | AR & Tracking › World | The semantic class of a TrackedPlane. |
| TrackedPlaneHitTestResult | Class | AR & Tracking › World › WorldRaycast | The result of a raycast against a TrackedPlane. |
| TrackedPlaneOrientation | Enum | AR & Tracking › World | |
| TrackingScope | Class | AR & Tracking | The scope, such as the texture it should track against, in which a tracker, such as FaceMaskVisual, EyeColorVisual, BodyDepthTextureProvider, should be applied. |
| TrackingStatus | Class | AR & Tracking | TrackingStatus signals changes in data availability for the tracked object. |
| Transform | Class | Scene | Controls the position, rotation, and scale of a SceneObject. |
| Transformer | Class | SnapML | Applies additional transform processing on data for InputPlaceholders and OutputPlaceholders used with MLComponent. |
| TransformerBuilder | Class | SnapML | Builds Transformer objects for MLComponent. |
| TransformerRotation | Enum | SnapML | Rotation types used by TransformBuilder. |
| TriangleHit | Class | Physics › Ray Casts | Triangle hit information, available when a ray cast intersects a collision mesh. |
| TriggerPrimaryEvent | Class | Interaction | Gets called when the user triggers the primary input on their device. |
| TriggerPrimaryEventArgs | Class | Interaction | Arguments used with the InteractionComponent.onTriggerPrimary event. |
| TurnOffEvent | Class | Lifecycle Events | Triggered when the lens turns off. |
| typedef | Function | Scripting › Decorators | |
| typename | Function | Scripting › Decorators | |
| ui | Namespace | Scripting › Decorators | |
| ui.group_end | Function | Scripting › Decorators | |
| ui.group_start | Function | Scripting › Decorators | |
| ui.label | Function | Scripting › Decorators | |
| ui.separator | Function | Scripting › Decorators | |
| UIControl | Class | Scripting › UIControl | |
| UIWidget | Class | Scripting › UIControl | |
| UpdateEvent | Class | Lifecycle Events | Event that runs during each frame, only if a Component and its SceneObject is enabled. |
| UpperBodyRenderObjectProvider | Class | AR & Tracking › Body | Provides a render object of the upper body, without the head. |
| UpperBodyTrackingAsset | Class | AR & Tracking › Body | Configures 3D Upper Body Tracking for the ObjectTracking3D component. |
| User | Class | User & Friends | Represents a user of the current runtime. |
| UserActivityModule | Class | User & Friends | Exposes the user's current mode of action (e.g. stationary, walking) and posture (e.g. standing, sitting) to Lens developers. |
| UserActivityModule.ModeOfAction | Enum | User & Friends › UserActivityModule | An enumeration describing which activity is currently performed by the user. |
| UserActivityModule.Posture | Enum | User & Friends › UserActivityModule | An enumeration describing the user's current posture. |
| UserBirthday | Class | User & Friends | A user's birth month and day, returned by User#birthday. |
| UserContextSystem | Class | User & Friends | Provides information about the user such as display name, birthday, and current weather. |
| Utf8 | Namespace | Utilities › Data & Encoding | |
| Utf8.decode | Function | Utilities › Data & Encoding › Utf8 | Decodes a utf-8 Uint8Array to a utf-16 string |
| Utf8.encode | Function | Utilities › Data & Encoding › Utf8 | Encodes a utf-16 string as a utf-8 Uint8Array |
| VariationAxisInfo | Class | Text & Fonts › Font | Read-only metadata describing one OpenType variation axis on a variable font. |
| vec2 | Class | Math | A two dimensional vector. |
| Vec2CurveAnimationPropertyTrack | Class | Animation | Vec2CurveAnimationPropertyTrack. |
| vec3 | Class | Math | A three dimensional vector. |
| Vec3AnimationPropertyTrack | Class | Animation | Vec3AnimationPropertyTrack. |
| Vec3CurveAnimationPropertyTrack | Class | Animation | Vec3CurveAnimationPropertyTrack. |
| vec4 | Class | Math | A four dimensional vector. |
| vec4b | Class | Math | A vector containing 4 boolean values. |
| Vec4CurveAnimationPropertyTrack | Class | Animation | Vec4CurveAnimationPropertyTrack. |
| VectorComposite | Class | Graphics, Materials & Particles › Vector Graphics | A retained, tessellated vector-image asset (built from an SVG document). |
| VectorComposite.FillRule | Enum | Graphics, Materials & Particles › Vector Graphics › VectorComposite | Fill rule for closed path regions; determines which points are "inside" when fill contours overlap or self-intersect. |
| VectorComposite.GradientKind | Enum | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The kind of a built VectorGradient. |
| VectorComposite.LineCap | Enum | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The line cap style for a stroked path — how the ends of open sub-paths and dash segments are rendered. |
| VectorComposite.LineJoin | Enum | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The line join style for a stroked path — how corners between connected path segments are rendered. |
| VectorComposite.RenderRequest | Class | Graphics, Materials & Particles › Vector Graphics › VectorComposite | Per-draw options for VectorRenderer#render: where to draw (viewport), which part of the source to draw (region), and whether to clear first (clear). |
| VectorComposite.SpreadMode | Enum | Graphics, Materials & Particles › Vector Graphics › VectorComposite | How a gradient extends beyond its [0, 1] parameter range. |
| VectorCompositeBuilder | Class | Graphics, Materials & Particles › Vector Graphics | A mutable builder for a VectorComposite assembled from programmatic fills — each a path painted with a VectorPaint (a solid color or a gradient). |
| VectorGradient | Class | Graphics, Materials & Particles › Vector Graphics | An immutable gradient paint — a linear or radial color ramp with a VectorComposite.SpreadMode. |
| VectorGradientBuilder | Class | Graphics, Materials & Particles › Vector Graphics | A mutable builder for an immutable VectorGradient paint. |
| VectorPaint | Class | Graphics, Materials & Particles › Vector Graphics | An immutable fill paint for VectorCompositeBuilder#addPath — either a flat solid color or a VectorGradient. |
| VectorPath | Class | Graphics, Materials & Particles › Vector Graphics | An immutable 2D path: an ordered list of contours built from straight and curved segments. |
| VectorPathBuilder | Class | Graphics, Materials & Particles › Vector Graphics | A mutable builder for an immutable VectorPath. |
| VectorRenderer | Class | Graphics, Materials & Particles › Vector Graphics | Draws a vector composite into a caller-owned render-target Texture. |
| VectorStroke | Class | Graphics, Materials & Particles › Vector Graphics | An immutable stroke style — width, line cap, line join, miter limit, and an optional dash pattern. |
| VectorStrokeBuilder | Class | Graphics, Materials & Particles › Vector Graphics | A mutable builder for an immutable VectorStroke style. |
| VectorText | Class | Graphics, Materials & Particles › Vector Graphics | An immutable text run style — content, size, weight, italics, letter spacing, and horizontalAlignment. |
| VectorTextBuilder | Class | Graphics, Materials & Particles › Vector Graphics | A mutable builder for an immutable VectorText run. |
| VertexCache | Class | Graphics, Materials & Particles › Meshes & Effects | Used to help control vertex animations on the SceneObject. |
| VertexSimulationSettings | Class | Physics › Cloth & Hair › ClothVisual | Provides settings for vertex physics in the ClothVisual component. |
| VerticalAlignment | Enum | Text & Fonts | Used by the verticalAlignment property in MeshVisual. |
| VerticalOverflow | Enum | Text & Fonts | Options for handling vertical text overflow. |
| VFXAsset | Class | Graphics, Materials & Particles › Meshes & Effects | Defines a VFX to use with VFXComponent. |
| VFXComponent | Class | Graphics, Materials & Particles › Meshes & Effects | Renders VFXAsset in scene. |
| VideoRecorder | Class | Graphics, Materials & Particles › Textures & Video | Allows you to record a new texture (i.e video), based on on another texture. |
| VideoRecorder.Options | Class | Graphics, Materials & Particles › Textures & Video › VideoRecorder | Configuration options for VideoRecorder. |
| VideoStatus | Enum | Graphics, Materials & Particles › Textures & Video | Describes the current status of a VideoTextureProvider. |
| VideoTextureProvider | Class | Graphics, Materials & Particles › Textures & Video | Controls a video texture resource. |
| Visual | Class | Graphics, Materials & Particles › Meshes & Effects | Base class for all visual Components. |
| VoiceML | Namespace | Audio & Voice › Speech | |
| VoiceML.NlpIntentsModelOptions | Namespace | Audio & Voice › Speech › VoiceML | |
| VoiceML.NlpKeywordModelOptions | Namespace | Audio & Voice › Speech › VoiceML | |
| VoiceMLModule | Namespace | Audio & Voice › Speech | |
| VoiceMLModule.SpeechRecognizer | Namespace | Audio & Voice › Speech › VoiceMLModule | |
| WeatherCondition | Enum | User & Friends | Types of weather returned by UserContextSystem's callback. |
| WebPageTextureProvider | Class | Cloud, Networking & Storage › Web View | WebPageTextureProvider is the associated texture control that can be accessed from the texture.control property. |
| WebSocket | Class | Cloud, Networking & Storage › WebSockets | WebSocket provides an API for managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. |
| WebSocketCloseEvent | Class | Cloud, Networking & Storage › WebSockets | Event type for WebSocket close events. |
| WebSocketEvent | Class | Cloud, Networking & Storage › WebSockets | Generic event type for WebSocket. |
| WebSocketMessageEvent | Class | Cloud, Networking & Storage › WebSockets | Event type for WebSocket message events. |
| WebSocketOptions | Class | Cloud, Networking & Storage › Internet Access › InternetModule | Additional settings applied when opening a WebSocket connection with InternetModule#createWebSocket. |
| WebViewOptions | Class | Cloud, Networking & Storage › Internet Access › InternetModule | WebViewOptions allow you to specify various aspects of the WebView that will be created. |
| WebViewPolicy | Class | Cloud, Networking & Storage › Web View | WebViewPolicy allows creators to control what websites are allowed to be loaded in the WebView. |
| WeightedMode | Enum | Animation | Different coordinate representations for tangent points |
| widget | Function | Scripting › Decorators | |
| WorldComponent | Class | Physics › Bodies & Colliders | Groups Physics objects in its subtree into an independent world simulation. |
| WorldDepthTextureProvider | Class | AR & Tracking › Camera | Provides depth information of the video feed that the Lens is being applied to when available. |
| WorldOptions | Class | AR & Tracking › World › DeviceTracking | Holds settings for world mesh and point cloud tracking in DeviceTracking component. |
| WorldQueryHitTestResult | Class | AR & Tracking › World › WorldQueryModule | The result of the hitTest method call. |
| WorldQueryModule | Class | AR & Tracking › World | Provides access to various APIs which can perform hit test for real surfaces to sample the depth and normal at a certain location. |
| WorldRaycast | Namespace | AR & Tracking › World | |
| WorldRaycast.hitTestPlanes | Function | AR & Tracking › World › WorldRaycast | Performs a raycast against native AR-tracked planes from a screen position. |
| WorldRaycast.hitTestWorldMesh | Function | AR & Tracking › World › WorldRaycast | Performs a raycast against world meshes from a screen position. |
| WorldRaycast.raycastPlanes | Function | AR & Tracking › World › WorldRaycast | Performs a raycast against native AR-tracked planes along a ray from world position from to world position to. |
| WorldRaycast.raycastWorldMesh | Function | AR & Tracking › World › WorldRaycast | Performs a raycast against world meshes along a ray from world position from to world position to. |
| WorldRenderObjectProvider | Class | AR & Tracking › World | Provider for RenderMesh data representing the estimated shape of real world objects generated from depth information. |
| WorldTrackingCapabilities | Class | AR & Tracking › World | Provides information about whether certain world tracking features are supported by the device. |
| WorldTrackingMeshesAddedEvent | Class | AR & Tracking › World | Triggered when new world tracking meshes are detected. |
| WorldTrackingMeshesRemovedEvent | Class | AR & Tracking › World | Triggered when some world tracking meshes are no longer detected. |
| WorldTrackingMeshesUpdatedEvent | Class | AR & Tracking › World | Triggered when world tracking meshes are updated. |
| WorldTrackingPlanesAddedEvent | Class | AR & Tracking › World | Triggered when plane(s) are newly detected. |
| WorldTrackingPlanesRemovedEvent | Class | AR & Tracking › World | Triggered when plane(s) are no longer detected. |
| WorldTrackingPlanesUpdatedEvent | Class | AR & Tracking › World | Triggered when currently detected plane(s) are updated. |
| WorldTrackingResetEvent | Class | AR & Tracking › World | If a DeviceTracking component is present in the scene, this event is triggered when the tracking is restarted (typically when the Lens starts, or if the user… |
| WorldUnderstandingModule | Class | AR & Tracking › World | Declares permissions for your Lens project. |
| WrapMode | Enum | Graphics, Materials & Particles › Textures & Video | Describes how a texture should be sampled when using coordinates outside of the normal range. |
| Zodiac | Enum | User & Friends |