Skip to main content

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.

SymbolKindTopicDescription
AccountTypeEnumUser & FriendsThe kind of account backing a User.
allowUndefinedFunctionScripting › Decorators
AnchorClassAR & Tracking › Location & NavigationAn object containing the position of an object relative to a LocationAsset.
AnchorComponentClassAR & Tracking › WorldThe active tracker: set its AnchorModule.Anchor and it drives its SceneObject's transform, reporting per-frame tracking state.
AnchorLocationModuleClassAR & Tracking › Location & NavigationLook up the real-world geographic position of an anchor.
AnchorModuleClassAR & Tracking › WorldEntry point to the anchoring system.
AnchorModule.AnchorClassAR & Tracking › World › AnchorModuleA saved place the system can recognise and track — an identity plus metadata.
AnchorModule.AnchorScopeEnumAR & Tracking › World › AnchorModuleWho can access an anchor.
AnchorModule.AnchorSessionClassAR & Tracking › World › AnchorModuleYour connection to the anchor system for an area.
AnchorModule.AnchorSessionOptionsClassAR & Tracking › World › AnchorModuleOptions for opening an AnchorSession.
AnchorModule.AnchorTrackingStateEnumAR & Tracking › World › AnchorModuleThe tracking state of an AnchorComponent.
AnchorModule.AnchorTypeEnumAR & Tracking › World › AnchorModuleThe kind of anchor.
AnchorModule.SaveOptionsClassAR & Tracking › World › AnchorModuleOptions for saving an anchor.
AnchorModule.WorldAnchorClassAR & Tracking › World › AnchorModuleA spatial anchor fixed to a point in the user's mapped space.
AnimatedTextureFileProviderClassGraphics, Materials & Particles › Textures & VideoProvider for animated texture resource.
AnimationAssetClassAnimationRepresents animation data.
AnimationAsset.selfLayerNameVariableAnimation › AnimationAssetSpecial layer name that resolves to the SceneObject the AnimationPlayer is attached to, allowing animations to work regardless of the SceneObject's name.
AnimationClipClassAnimationAnimation Clip is what an Animation Player uses to manage playback for a specific animation.
AnimationCurveClassAnimationA curve that contains a set of keyframes and can evaluate values at specific timestamps.
AnimationCurveTrackClassAnimationContainer for one or more AnimationCurves.
AnimationKeyFrameClassAnimationA keyframe with time and respective value.
AnimationLayerBlendModeEnumAnimationHow animation layers are blended.
AnimationLayerScaleModeEnumAnimationThe method in which an Animation Layer should be scaled to other layers in an AnimationClip.
AnimationPlayerClassAnimationControls animation playback.
AnimationPlayerOnEventArgsClassAnimationArgs used for AnimationPlayer's event, which is triggered every time the animation playback passes the given time in the event.
AnimationPropertyEventRegistrationClassAnimationThe event registration returned by AnimationAsset's createEvent.
AnimationPropertyLayerClassAnimationA layer containing different properties.
AnimationPropertyLayer.BlendShapesVariableAnimation › AnimationPropertyLayerAccessor string for BlendsShapes.
AnimationPropertyLayer.TransformPositionVariableAnimation › AnimationPropertyLayerAccessor string for Transform Position property.
AnimationPropertyLayer.TransformRotationVariableAnimation › AnimationPropertyLayerAccessor string for Transform Rotation property.
AnimationPropertyLayer.TransformScaleVariableAnimation › AnimationPropertyLayerAccessor string for Transform Scale property.
AnimationPropertyLayer.VertexCacheVariableAnimation › AnimationPropertyLayerAccessor string for VertexCache.
AnimationPropertyLayer.VisibilityVariableAnimation › AnimationPropertyLayerAccessor string for Visibility.
AnimationPropertyTrackClassAnimationInterface class for typed property tracks.
AnimationTrackClassAnimationRepresents the base class for animation tracks.
AsrModuleClassAudio & Voice › SpeechAllows the Lens to incorporate voice transcription with higher quality than the VoiceMlModule and supports a vast number of different languages.
AsrModule.AsrContentTypeEnumAudio & Voice › Speech › AsrModuleThe kind of content the speech is expected to carry.
AsrModule.AsrModeEnumAudio & Voice › Speech › AsrModuleThe mode of the transcription to prioritise, between speed and accuracy.
AsrModule.AsrStatusCodeEnumAudio & Voice › Speech › AsrModuleAn enum stating the status of the transcription.
AsrModule.AsrTranscriptionOptionsClassAudio & Voice › Speech › AsrModuleProvides the options for the session.
AsrModule.TranscriptionUpdateEventClassAudio & Voice › Speech › AsrModuleArgument passed for a transcription update event.
AssetClassBase ClassesBase class for all assets used in the engine.
assetFunctionScripting › Decorators
AttachmentPointTypeEnumAR & Tracking › Face
AudioNamespaceAudio & Voice › Playback & Effects
Audio.DistanceCurveTypeEnumAudio & Voice › Playback & Effects › AudioThe curve that specifies how sound fades with the distance from Audio Component to the Audio Listener.****
Audio.PlaybackModeEnumAudio & Voice › Playback & Effects › AudioThe Playback Mode property of the AudioComponent used in Lenses targeting Spectacles.
AudioComponentClassAudio & Voice › Playback & EffectsUsed to play audio in a Lens.
AudioEffectAssetClassAudio & Voice › Playback & EffectsConfigures an audio effect for AudioEffectComponent.
AudioEffectComponentClassAudio & Voice › Playback & EffectsUsed to add effects to audio recorded by the device, such as Robot, Alien, etc.
AudioEffectProviderClassAudio & Voice › Playback & EffectsProvider for AudioEffectAsset.
AudioListenerComponentClassAudio & Voice › Playback & EffectsProcesses input from AudioComponents that use Spatial Audio.
AudioOutputProviderClassAudio & Voice › Playback & EffectsProvider of the Audio Output Audio Track asset.
AudioTrackAssetClassAudio & Voice › Playback & EffectsRepresents an audio file asset.
AudioTrackProviderClassAudio & Voice › Playback & EffectsBase class for Audio Track providers.
AxisEnumPhysics › Shapes & Collision MeshesCardinal axis enumeration.
BackgroundSettingsClassText & Fonts › TextSettings for rendering the background on a Text component.
Base64NamespaceUtilities › Data & Encoding
Base64.decodeFunctionUtilities › Data & Encoding › Base64Decode a Base64 string to a byte array (Uint8Array).
Base64.decodeTextureAsyncFunctionUtilities › Data & Encoding › Base64Decode a texture from Base64, asynchronously.
Base64.encodeFunctionUtilities › Data & Encoding › Base64Encode a byte array (Uint8Array) to Base64 string.
Base64.encodeStringFunctionUtilities › Data & Encoding › Base64Encode a string to Base64 format.
Base64.encodeTextureAsyncFunctionUtilities › Data & Encoding › Base64Encode a texture according to Base64 encoding algorithm, asynchronously.
BaseMeshVisualClassGraphics, Materials & Particles › Meshes & EffectsBase for all mesh rendering components.
BaseMultiplayerSessionOptionsClassConnected Lenses (Multiplayer)Base class for MultiplayerSession options.
BasePlaceholderClassSnapMLBase class for Input and Output Placeholders used by MLComponent.
BaseScriptComponentClassScripting › BaseScriptComponent
BasicTransformClassBase ClassesProvides basic information about a transformation.
BatteryStateArgsClassUtilities › Device & RuntimeStores the battery level and charging state of the device.
BinAssetClassBase ClassesA file based asset.
Bitmoji2DOptionsClassBitmoji › BitmojiModuleThe options used with requestBitmoji2DResource.
Bitmoji2DResourceClassBitmojiThe DynamicResource of a 2D Bitmoji which can be loaded with RemoteMediaModule.
Bitmoji3DOptionsClassBitmoji › BitmojiModuleThe options used with requestBitmoji3DResource
Bitmoji3DOptions.AnimationParamsClassBitmoji › Bitmoji3DOptionsUsed to set the animation params for the request type.
Bitmoji3DOptions.AvatarScopeEnumBitmoji › Bitmoji3DOptionsEnum representing avatar scope used in custom params of bitmoji3d options.
Bitmoji3DOptions.BaseBodyParamsClassBitmoji › Bitmoji3DOptionsBody parameters for base Bitmoji avatar customization.
Bitmoji3DOptions.BodyTypeEnumBitmoji › Bitmoji3DOptionsEnum representing different body types for the avatar.
Bitmoji3DOptions.BreastTypeEnumBitmoji › Bitmoji3DOptionsEnum representing different breast types for the avatar.
Bitmoji3DOptions.ClothingTypeEnumBitmoji › Bitmoji3DOptionsEnum representing different types of clothing
Bitmoji3DOptions.CustomParamsClassBitmoji › Bitmoji3DOptionsThe custom params can be used for requesting bitmoji assets like garments.
Bitmoji3DOptions.GenderEnumBitmoji › Bitmoji3DOptionsEnum representing the gender of the avatar.
Bitmoji3DOptions.OptimizationParamsClassBitmoji › Bitmoji3DOptionsOptimization parameters for Bitmoji 3D assets.
Bitmoji3DOptions.ParamSetClassBitmoji › Bitmoji3DOptionsSet of parameters used to customize specific parts of avatar such as garment, outerwear etc.
Bitmoji3DOptions.RequestTypeEnumBitmoji › Bitmoji3DOptionsEnum representing different request types.
Bitmoji3DResourceClassBitmojiProvides information about the current user's 3D Bitmoji avatar to be downloaded via the RemoteMediaModule.
BitmojiModuleClassBitmojiProvides access to functionalities related to Bitmoji avatar.
BlendModeEnumGraphics, Materials & Particles › Rendering & Materials
BlobClassCloud, Networking & Storage › Internet AccessRepresents a blob, which is a file-like object of immutable, raw data.
BluetoothNamespaceCloud, Networking & Storage
Bluetooth.BluetoothCentralModuleClassCloud, Networking & Storage › BluetoothProvides access to Bluetooth GATT devices.
Bluetooth.BluetoothGattClassCloud, Networking & Storage › BluetoothProvides access to the Bluetooth connection.
Bluetooth.BluetoothGattCharacteristicClassCloud, Networking & Storage › BluetoothA characteristic of the Bluetooth GATT device.
Bluetooth.BluetoothGattDescriptorClassCloud, Networking & Storage › BluetoothDescriptors contain additional information and attributes of a Bluetooth.BluetoothGattCharacteristic.
Bluetooth.BluetoothGattServiceClassCloud, Networking & Storage › BluetoothBluetooth GATT Services are collections of related Bluetooth.BluetoothGattCharacteristics representing specific functions or features of a device.
Bluetooth.BluetoothStatusEnumCloud, Networking & Storage › BluetoothThe statuses for Bluetooth availability.
Bluetooth.BluetoothStatusChangedEventClassCloud, Networking & Storage › BluetoothThe event received when Bluetooth status has changed.
Bluetooth.CharacteristicPropertyEnumCloud, Networking & Storage › BluetoothProperties of a Bluetooth.BluetoothGattCharacteristic.
Bluetooth.MtuChangedEventClassCloud, Networking & Storage › BluetoothThe event received when Maximum Transmission Unit (MTU) of a Bluetooth device has changed.
Bluetooth.ScanFilterClassCloud, Networking & Storage › BluetoothThe filters to be used with BluetoothCentralModule.startScan.
Bluetooth.ScanModeEnumCloud, Networking & Storage › BluetoothDefines how Bluetooth devices should be scanned.
Bluetooth.ScanResultClassCloud, Networking & Storage › BluetoothThe results of a Bluetooth scan.
Bluetooth.ScanSettingsClassCloud, Networking & Storage › BluetoothSettings when scanning for Bluetooth devices via BluetoothCentralModule.startScan.
BlurNoiseEstimationClassGraphics, Materials & Particles › Rendering & MaterialsUsed to analyze camera input and apply similar image artifacts to AR objects to better blend and match with the real world.
BodyComponentClassPhysics › Bodies & CollidersAllows Physics simulation to control SceneObject.
BodyDepthTextureProviderClassAR & Tracking › BodyProvides depth values of the tracked body encoded as D24_UNORM_S8_UINT in screen resolution.
BodyInstanceSegmentationTextureProviderClassAR & Tracking › BodyProvides segmentation confidence values encoded in the R channel.
BodyNormalsTextureProviderClassAR & Tracking › BodyProvides surface normal values of the tracked body encoded as RGBA (x, y, z, confidence) in R8G8B8A8_UNORM format in screen resolution.
BodyRenderObjectProviderClassAR & Tracking › BodyProvider for full Body Mesh render object.
BodyTrackingAssetClassAR & Tracking › BodyConfigures 3D Body Tracking for the ObjectTracking3D component.
BodyTrackingAsset.HeadVariableAR & Tracking › Body › BodyTrackingAssetKey for Head attachment point.
BodyTrackingAsset.HipsVariableAR & Tracking › Body › BodyTrackingAssetKey for Hips attachment point.
BodyTrackingAsset.LeftArmVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Arm attachment point.
BodyTrackingAsset.LeftFootVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Foot attachment point.
BodyTrackingAsset.LeftForeArmVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Forearm attachment point.
BodyTrackingAsset.LeftHandVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand attachment point.
BodyTrackingAsset.LeftHandIndex1VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Index 1 attachment point.
BodyTrackingAsset.LeftHandIndex2VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Index 2 attachment point.
BodyTrackingAsset.LeftHandIndex3VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Index 3 attachment point.
BodyTrackingAsset.LeftHandMiddle1VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Middle 1 attachment point.
BodyTrackingAsset.LeftHandMiddle2VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Middle 2 attachment point.
BodyTrackingAsset.LeftHandMiddle3VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Middle 3 attachment point.
BodyTrackingAsset.LeftHandPinky1VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Pinky 1 attachment point.
BodyTrackingAsset.LeftHandPinky2VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Pinky 2 attachment point.
BodyTrackingAsset.LeftHandPinky3VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Pinky 3 attachment point.
BodyTrackingAsset.LeftHandRing1VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Ring 1 attachment point.
BodyTrackingAsset.LeftHandRing2VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Ring 2 attachment point.
BodyTrackingAsset.LeftHandRing3VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Ring 3 attachment point.
BodyTrackingAsset.LeftHandThumb1VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Thumb 1 attachment point.
BodyTrackingAsset.LeftHandThumb2VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Thumb 2 attachment point.
BodyTrackingAsset.LeftHandThumb3VariableAR & Tracking › Body › BodyTrackingAssetKey for Left Hand Thumb 3 attachment point.
BodyTrackingAsset.LeftLegVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Leg attachment point.
BodyTrackingAsset.LeftShoulderVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Shoulder attachment point.
BodyTrackingAsset.LeftToeBaseVariableAR & Tracking › Body › BodyTrackingAssetKey for Left Toe Base attachment point.
BodyTrackingAsset.LeftUpLegVariableAR & Tracking › Body › BodyTrackingAssetKey for Upper Left Leg attachment point.
BodyTrackingAsset.NeckVariableAR & Tracking › Body › BodyTrackingAssetKey for Neck attachment point.
BodyTrackingAsset.RightArmVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Arm attachment point.
BodyTrackingAsset.RightFootVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Foot attachment point.
BodyTrackingAsset.RightForeArmVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Forearm attachment point.
BodyTrackingAsset.RightHandVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand attachment point.
BodyTrackingAsset.RightHandIndex1VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Index 1 attachment point.
BodyTrackingAsset.RightHandIndex2VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Index 2 attachment point.
BodyTrackingAsset.RightHandIndex3VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Index 3 attachment point.
BodyTrackingAsset.RightHandMiddle1VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Middle 1 attachment point.
BodyTrackingAsset.RightHandMiddle2VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Middle 2 attachment point.
BodyTrackingAsset.RightHandMiddle3VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Middle 3 attachment point.
BodyTrackingAsset.RightHandPinky1VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Pinky 1 attachment point.
BodyTrackingAsset.RightHandPinky2VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Pinky 2 attachment point.
BodyTrackingAsset.RightHandPinky3VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Pinky 3 attachment point.
BodyTrackingAsset.RightHandRing1VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Ring 1 attachment point.
BodyTrackingAsset.RightHandRing2VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Ring 2 attachment point.
BodyTrackingAsset.RightHandRing3VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Ring 3 attachment point.
BodyTrackingAsset.RightHandThumb1VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Thumb 1 attachment point.
BodyTrackingAsset.RightHandThumb2VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Thumb 2 attachment point.
BodyTrackingAsset.RightHandThumb3VariableAR & Tracking › Body › BodyTrackingAssetKey for Right Hand Thumb 3 attachment point.
BodyTrackingAsset.RightLegVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Leg attachment point.
BodyTrackingAsset.RightShoulderVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Shoulder attachment point.
BodyTrackingAsset.RightToeBaseVariableAR & Tracking › Body › BodyTrackingAssetKey for Right Toe Base attachment point.
BodyTrackingAsset.RightUpLegVariableAR & Tracking › Body › BodyTrackingAssetKey for Upper Right Leg attachment point.
BodyTrackingAsset.SpineVariableAR & Tracking › Body › BodyTrackingAssetKey for Spine attachment point.
BodyTrackingAsset.Spine1VariableAR & Tracking › Body › BodyTrackingAssetKey for Spine1 attachment point.
BodyTrackingAsset.Spine2VariableAR & Tracking › Body › BodyTrackingAssetKey for Spine2 attachment point.
BoxShapeClassPhysics › Shapes & Collision MeshesA box collision shape.
BrowsLoweredEventClassAR & Tracking › FaceTriggered when eyebrows are lowered on the tracked face.
BrowsRaisedEventClassAR & Tracking › FaceTriggered when eyebrows are raised on the tracked face.
BrowsReturnedToNormalEventClassAR & Tracking › FaceTriggered when eyebrows are returned to normal on the tracked face.
CameraClassGraphics, Materials & Particles › Rendering & MaterialsRenders SceneObjects to one or more Render Target textures.
Camera.BaseRenderTargetClassGraphics, Materials & Particles › Rendering & Materials › CameraThe base class from which ColorRenderTarget and DepthStencilRenderTarget are derived from
Camera.ColorRenderTargetClassGraphics, Materials & Particles › Rendering & Materials › CameraColor based RenderTarget.
Camera.CubemapFaceEnumGraphics, Materials & Particles › Rendering & Materials › CameraDifferent faces of the cubemap that a camera can render into.
Camera.DepthBufferModeEnumGraphics, Materials & Particles › Rendering & Materials › CameraUsed in Camera's depthBufferMode property.
Camera.DepthStencilRenderTargetClassGraphics, Materials & Particles › Rendering & Materials › CameraThis class inherits from the BaseRenderTarget class.
Camera.DevicePropertyEnumGraphics, Materials & Particles › Rendering & Materials › CameraUsed in Camera's devicePropertyUsage property.
Camera.TypeEnumGraphics, Materials & Particles › Rendering & Materials › CameraReturned from Camera's type property.
CameraBackEventClassAR & Tracking › CameraTriggered when the device's back facing camera becomes active.
CameraFrameClassAR & Tracking › CameraMetadata about the current camera image of a CameraTextureProvider.
CameraFrontEventClassAR & Tracking › CameraTriggered when the device's front facing camera becomes active.
CameraModuleClassAR & Tracking › CameraProvides access to the SPECS cameras.
CameraModule.CameraFacingEnumAR & Tracking › Camera › CameraModuleWhich way a camera faces, reported on CameraModule.CameraInfo#facing.
CameraModule.CameraIdEnumAR & Tracking › Camera › CameraModuleA handle to specify which camera on the Spectacles to request from.
CameraModule.CameraInfoClassAR & Tracking › Camera › CameraModuleA physical camera on SPECS, returned by CameraModule#getCameras.
CameraModule.CameraLocationEnumAR & Tracking › Camera › CameraModuleCamera position on the device, reported on CameraModule.CameraInfo#location.
CameraModule.CameraRequestClassAR & Tracking › Camera › CameraModuleAn object that is used to request the desired camera ID.
CameraModule.CameraTypeEnumAR & Tracking › Camera › CameraModuleCamera sensor type, reported on CameraModule.CameraInfo#type.
CameraModule.CaptureSessionClassAR & Tracking › Camera › CameraModuleStill-capture camera session for SPECS.
CameraModule.ConfigKeyEnumAR & Tracking › Camera › CameraModuleTyped keys for camera tuning parameters.
CameraModule.FrameClassAR & Tracking › Camera › CameraModuleA camera image, delivered by CameraModule.StreamingSession#onNewFrame or returned by CameraModule.CaptureSession#capture.
CameraModule.ImageFormatEnumAR & Tracking › Camera › CameraModuleImage format for camera image data.
CameraModule.MetadataKeyEnumAR & Tracking › Camera › CameraModuleTyped keys for querying per-frame metadata.
CameraModule.OperationEnumAR & Tracking › Camera › CameraModuleWhich session a stream capability works with, reported by CameraModule.StreamInfo#operation.
CameraModule.QualityEnumAR & Tracking › Camera › CameraModuleProcessing quality tier of a stream configuration.
CameraModule.ResultEnumAR & Tracking › Camera › CameraModuleResult codes from camera session operations.
CameraModule.StreamConfigClassAR & Tracking › Camera › CameraModuleStream configuration for creating a camera session.
CameraModule.StreamConfigOverridesClassAR & Tracking › Camera › CameraModulePer-shot overrides for CameraModule.CaptureSession#capture.
CameraModule.StreamInfoClassAR & Tracking › Camera › CameraModuleDescribes one stream capability of a camera (read-only).
CameraModule.StreamingSessionClassAR & Tracking › Camera › CameraModuleContinuous-frame camera session for SPECS.
CameraModule.StreamStatusEnumAR & Tracking › Camera › CameraModuleSession lifecycle status delivered via onStatusChanged event.
CameraRollMediaClassGraphics, Materials & Particles › Textures & VideoRepresents media selected from the device camera roll.
CameraRollMediaTypeEnumGraphics, Materials & Particles › Textures & VideoEnum representing the type of media selected from camera roll.
CameraRollModuleClassGraphics, Materials & Particles › Textures & VideoProvides an interface to the device’s camera roll and allows users to select multiple media.
CameraRollModule.ShowOptionsClassGraphics, Materials & Particles › Textures & Video › CameraRollModuleConfiguration options for displaying the camera roll media picker.
CameraTextureProviderClassAR & Tracking › Camera
CanvasClassUIA root of the 2D ScreenTransform hierarchy in 3D space.
Canvas.OffsetUnitEnumUI › CanvasThe unit system for child ScreenTransform offsets on a Canvas.
Canvas.SortingTypeEnumUI › CanvasUsed by Canvas to set how an object is sorted during rendering.
Canvas.UnitTypeEnumUI › CanvasUsed by Canvas to set how an object is positioned.
CapitalizationOverrideEnumText & FontsChanges the capitalization of the text component.
CapsuleShapeClassPhysics › Shapes & Collision MeshesA capsule collision shape.
ClearColorOptionEnumGraphics, Materials & Particles › Rendering & MaterialsSettings for how color will be cleared before rendering.
clearTimeoutFunctionUtilities › Time & TimersClears the timeout with the specified TimeoutID.
ClothVisualClassPhysics › Cloth & HairSimulates and renders cloth visuals in a Lens.
ClothVisual.BendModeEnumPhysics › Cloth & Hair › ClothVisualCloth bend mode to use for cloth simulation.
CloudStorageListOptionsClassCloud, Networking & Storage › StorageOptions associated with the listValues method call.
CloudStorageModuleClassCloud, Networking & Storage › StorageProvides access to Cloud Storage capabilities.
CloudStorageOptionsClassCloud, Networking & Storage › Storage › CloudStorageModuleUsed to configure Cloud Storage Module with various options.
CloudStorageReadOptionsClassCloud, Networking & Storage › StorageOptions associated with the getValue/deleteValue methods for Cloud Storage.
CloudStorageWriteOptionsClassCloud, Networking & Storage › StorageOptions associated with the setValue method for Cloud Storage.
CloudStoreClassCloud, Networking & Storage › StorageAn instance of Cloud Storage that can store data in a multiplayer experience.
ColliderComponentClassPhysics › Bodies & CollidersUsed to define the physical boundaries of an object, allowing it to interact with other objects in Physics, Cloth or Hair simulation.
CollisionClassPhysics › Collisions & OverlapsA state generated for ColliderComponent collision events.
CollisionEnterEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins.
CollisionExitEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionExit, which is triggered when a collision ends.
CollisionMeshClassPhysics › Shapes & Collision MeshesDefines the physical boundaries of an object for collision detection.
CollisionStayEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.
ColocatedLandmarks2DRenderObjectProviderClassConnected Lenses (Multiplayer)Not usable from JS.
ColocatedLandmarks3DRenderObjectProviderClassConnected Lenses (Multiplayer)Not usable from JS.
ColocatedLandmarksRenderObjectProviderBaseClassConnected Lenses (Multiplayer)
ColocatedTrackingComponentClassConnected Lenses (Multiplayer)Allows SceneObject to be tracked in a Connected Lens Experience.
ColorWidgetClassScripting › UIControl
ComboBoxItemClassScripting › UIControl
ComboBoxWidgetClassScripting › UIControl
CommerceNamespaceCommerce › Commerce Kit
Commerce.ClientClassCommerce › Commerce Kit › CommerceThe primary interface for interacting with the commerce system within a Lens.
Commerce.ClientOptionsClassCommerce › Commerce Kit › CommerceSpecifies the configuration for creating a commerce client.
Commerce.PriceClassCommerce › Commerce Kit › CommerceRepresents the price of a product in a Lens.
Commerce.PricingPhaseClassCommerce › Commerce Kit › CommerceDescribes one phase of a subscription offer's pricing schedule, such as a free trial, an introductory price, or the regular recurring price.
Commerce.ProductClassCommerce › Commerce Kit › CommerceContains all the essential details about an item available for purchase in a Lens.
Commerce.ProductTypeEnumCommerce › Commerce Kit › CommerceDefines the type of product that can be purchased in a Lens.
Commerce.PurchaseClassCommerce › Commerce Kit › CommerceRepresents a completed or pending transaction for a product.
Commerce.PurchaseResultClassCommerce › Commerce Kit › CommerceProvides an immediate summary of the outcome of a purchase attempt.
Commerce.PurchaseStateEnumCommerce › Commerce Kit › CommerceRepresents the state of a purchase in a Lens.
Commerce.RecurrenceModeEnumCommerce › Commerce Kit › CommerceDescribes how a subscription pricing phase repeats over time.
Commerce.ResponseCodeEnumCommerce › Commerce Kit › CommerceDefines the possible outcomes of a purchase attempt in a Lens
Commerce.SubscriptionOfferDetailsClassCommerce › Commerce Kit › CommerceDescribes a specific offer for a subscription product, such as a base plan or a promotional plan with a trial.
CommerceKitModuleClassCommerce › Commerce KitThe main entry point for integrating commerce functionalities into a Lens.
CompassTrackingDataNamespaceAR & Tracking › Location & Navigation
CompassTrackingData.AccuracyEnumAR & Tracking › Location & Navigation › CompassTrackingData
ComponentClassBase ClassesThe base class for all components.
componentFunctionScripting › Decorators
CompositionLayerNamespaceGraphics, Materials & Particles › Rendering & Materials
CompositionLayer.RenderNamespaceGraphics, Materials & Particles › Rendering & Materials › CompositionLayer
CompositionLayer.Render.UpdateModeEnumGraphics, Materials & Particles › Rendering & Materials › CompositionLayerDetermines when a composition layer should be (re-)rendered.
CompositionLayerComponentClassGraphics, Materials & Particles › Rendering & MaterialsRepresents a composition layer that is rendered independently from the main scene and composited by the system compositor.
CompositionLayerRenderComponentClassGraphics, Materials & Particles › Rendering & MaterialsControls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings.
CompressionQualityEnumGraphics, Materials & Particles › Textures & VideoEnum used to define the quality of image or texture compression.
ConeShapeClassPhysics › Shapes & Collision MeshesA cone collision shape.
ConnectedLensEnteredEventClassConnected Lenses (Multiplayer)Event fired when the "Launch connected lens" button was pressed.
ConnectedLensModuleClassConnected Lenses (Multiplayer)Enables the creation and management of networked Lens experiences, allowing for real-time communication and interaction between users through Connected Lenses.
ConnectedLensModule.ConnectionInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleInformation that is bootstrapped to the user who just connected to the session.
ConnectedLensModule.HostUpdateInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleInformation about the host update.
ConnectedLensModule.MatchmakingAvailabilityEnumConnected Lenses (Multiplayer) › ConnectedLensModuleWhether matchmaking is available, and if not, why.
ConnectedLensModule.MatchmakingConfigClassConnected Lenses (Multiplayer) › ConnectedLensModuleConfiguration for matchmaking when creating a session.
ConnectedLensModule.MatchmakingConfig.LobbyModeEnumConnected Lenses (Multiplayer) › ConnectedLensModuleHow matchmaking fills a session.
ConnectedLensModule.MatchmakingConfig.LobbyStateEnumConnected Lenses (Multiplayer) › ConnectedLensModuleOpen/close gate of an open-lobby session.
ConnectedLensModule.MultiplayerSupportInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleWhich multiplayer capabilities are available for the current Lens launch, from ConnectedLensModule#getMultiplayerSupportInfo.
ConnectedLensModule.RealtimeStoreCreationInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleProvides extra context about a RealtimeStore's creation.
ConnectedLensModule.RealtimeStoreDeleteInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleGives information about the Realtime Store delete operation.
ConnectedLensModule.RealtimeStoreKeyRemovalInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleProvides information about a key being removed from a RealtimeStore.
ConnectedLensModule.RealtimeStoreOwnershipUpdateInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleProvides information about a RealtimeStore's ownership being updated.
ConnectedLensModule.RealtimeStoreUpdateInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleGives information about the Realtime Store update operation.
ConnectedLensModule.SessionShareTypeEnumConnected Lenses (Multiplayer) › ConnectedLensModuleUsed by ConnectedLensModule to specify the session share type.
ConnectedLensModule.TurnStateNamespaceConnected Lenses (Multiplayer) › ConnectedLensModule
ConnectedLensModule.UserInfoClassConnected Lenses (Multiplayer) › ConnectedLensModuleProvides information about a user in a Connected Lens session.
ConnectedLensSessionOptionsClassConnected Lenses (Multiplayer) › ConnectedLensModuleSettings for configuring a Connected Lens session.
ConnectedLensSessionOptions.SessionCreationTypeEnumConnected Lenses (Multiplayer) › ConnectedLensSessionOptionsType of the created Connected Lens session.
consoleNamespaceUtilities › Logging & Debugging
console.debugFunctionUtilities › Logging & Debugging › consolePrints out a message to the Logger window at the debug log level.
console.errorFunctionUtilities › Logging & Debugging › consolePrints out a message to the Logger window at the error log level.
console.infoFunctionUtilities › Logging & Debugging › consolePrints out a message to the Logger window at the info log level.
console.logFunctionUtilities › Logging & Debugging › consolePrints out a message to the Logger window.
console.timeFunctionUtilities › Logging & Debugging › consoleStarts a timer named label or "default" if no label specified.
console.timeEndFunctionUtilities › Logging & Debugging › consoleEnds timer with name label or "default" if no label specified.
console.timeLogFunctionUtilities › Logging & Debugging › consoleLogs current time for timer named label or "default" if no label specified.
console.traceFunctionUtilities › Logging & Debugging › consolePrints out a stack trace to the Logger window.
console.warnFunctionUtilities › Logging & Debugging › consolePrints out a message to the Logger window at the warning log level.
ConstraintComponentClassPhysics › Bodies & CollidersUsed to apply specific restrictions on how a SceneObject with BodyComponent can move.
ContactClassPhysics › Collisions & OverlapsContact point between two colliding objects.
CropTextureProviderClassGraphics, Materials & Particles › Textures & VideoBase class for Texture Providers that crop an input texture.
cryptoNamespaceUtilities › Data & Encoding
crypto.getRandomValuesFunctionUtilities › Data & Encoding › cryptoFills a provided Uint8Array with cryptographically secure random values.
crypto.randomUUIDFunctionUtilities › Data & Encoding › cryptoGenerates a cryptographically secure UUID.
crypto.subtleNamespaceUtilities › Data & Encoding › crypto
crypto.subtle.digestFunctionUtilities › Data & Encoding › cryptoGenerates a cryptographic hash of the given data using the specified algorithm.
CullModeEnumGraphics, Materials & Particles › Rendering & MaterialsUsed with Pass's cullMode property.
CursorPositionClassText & FontsThe position of a text cursor for a given character index, returned by Text.getCursorPositions and Text3D.getCursorPositions.
CustomAssetClassBase ClassesBase class for all assets used in the engine.
CustomLocationGroupComponentClassAR & Tracking › Location & NavigationA component managing and tracking a group of Custom Locations with known relative transforms.
CustomObject3DAssetNamespaceAR & Tracking › Body
CustomObject3DSpecificDataNamespaceAR & Tracking › Body
CustomVariationStyleClassText & FontsA user-defined named style on a variable Font.
CylinderShapeClassPhysics › Shapes & Collision MeshesA cylinder collision shape.
DataStoreWithSceneClassCloud, Networking & Storage › StorageA GeneralDataStore that persists data across multiple Snaps within the same Lens session.
DebugRenderClassUtilities › Logging & DebuggingProvides methods to draw primitive visuals for debugging.
DecoratorsModuleScriptingThe Decorators typings for TypeScript Lens scripts.
DeepLinkModuleClassLifecycle EventsThe DeepLinkModule brings the concept of deep linking, familiar from mobile platforms like Android and iOS, to Spectacles.
DeepLinkUriReceivedArgsClassLifecycle EventsArguments used with the DeepLinkModule#onUriReceived event.
DeformingCollisionMeshClassPhysics › Shapes & Collision MeshesUsed for collision meshes that can change shape or form dynamically.
DelayClassSnapMLCreates a buffer for the audio data.
DelayBuilderClassSnapMLBuilder class for the Delay.
DelayedCallbackEventClassLifecycle EventsAn event that gets triggered after a delay.
DeltaClassSnapMLLocal estimate of the derivative of the input data along the selected axis.
DeltaBuilderClassSnapMLBuilder class for Delta.
DepthClearOptionEnumGraphics, Materials & Particles › Rendering & MaterialsSettings for the depth clear option modes on a DepthStencilRenderTargetProvider.
DepthFrameDataClassAR & Tracking › Camera › DepthModuleThe depth frame data as provided by the DepthFrameSession.onNewFrame.
DepthFrameSessionClassAR & Tracking › CameraUsed for receiving DepthFrameData on Spectacles device.
DepthModuleClassAR & Tracking › CameraProvides access to a DepthFrameSession on Spectacles device.
DepthStencilRenderTargetProviderClassGraphics, Materials & Particles › Rendering & MaterialsAccess to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.
DepthTextureProviderClassAR & Tracking › CameraProvides depth information of the video feed that the Lens is being applied to when available.
DeviceCameraClassAR & Tracking › CameraProvides information about the device's camera.
DeviceDependentBinFileProviderClassBase Classes
DeviceInfoSystemClassUtilities › Device & RuntimeProvides information about the device running the Lens.
DeviceLocationTrackingComponentClassAR & Tracking › Location & NavigationUsed to track a real-world location in a Lens.
DeviceTrackingClassAR & Tracking › WorldEnables a SceneObject to align with the movements and orientation of the user's device.
DeviceTrackingModeEnumAR & Tracking › WorldTracking modes used by the DeviceTracking component to specify what type of tracking to use.
DeviceTrackingModuleClassAR & Tracking › WorldThe module that allows Device Tracking capabilities in a Lens.
DialogNamespaceAudio & Voice › Speech
Dialog.AnswerClassAudio & Voice › Speech › DialogProvides answer information in response to DialogModule.askQuestions().
DirectivityEffectClassAudio & Voice › Playback & EffectsAn Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.
DirectMultiplayerSessionOptionsClassConnected Lenses (Multiplayer)
DistanceEffectClassAudio & Voice › Playback & EffectsAn audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.
DomainInfoClassCommerce › Shopping › ShoppingModuleThe domain of a ShoppingModule.
DoubleTapEventClassInteractionTriggered when a double tap event has occurred.
DoubleTapEventArgsClassInteractionBase class for objects representing Script data.
DropshadowSettingsClassText & Fonts › TextUsed in Text's dropShadowSettings property.
DynamicMeshRenderObjectProviderClassGraphics, Materials & Particles › Meshes & EffectsRenderObjectProvider for mesh objects generated procedurally.
DynamicResourceClassCloud, Networking & Storage › Remote Assets & MediaA resource that is resolved at runtime.
EditorInteractionProfileClassScriptingDeclares how stock Scene Editor Move / Rotate / Scale manipulators may interact with a SceneObject.
EncodingTypeEnumUtilities › Data & EncodingSpecifies the format for encoding textures, used with Base64.
EventRegistrationClassLifecycle Events
exportRequiredFunctionScripting › Decorators
ExpressionsEnumAR & Tracking › Face
ExternalMusicInfoClassAudio & Voice › Music & LyricsInformation about an external music track.
ExternalMusicModuleClassAudio & Voice › Music & LyricsProvides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene.
EyeColorVisualClassAR & Tracking › FaceApplies an eye color effect to a face.
EyeToRenderEnumAR & Tracking › FaceSpecifies which eye to apply an EyeColorVisual effect to.
FaceCropTextureProviderClassAR & Tracking › FaceTexture Provider giving a cropped region of the input texture, calculated based on face position.
FaceFoundEventClassAR & Tracking › FaceTriggered when a new face is detected and starts being tracked.
FaceInsetRegionEnumAR & Tracking › Face
FaceInsetVisualClassAR & Tracking › FaceProvides a 2D visual of a section of a tracked face, such as Mouth, Nose, etc.
FaceLostEventClassAR & Tracking › FaceTriggered when a face can no longer be tracked.
FaceMaskVisualClassAR & Tracking › FaceMaps a 2D texture to the user's face.
FaceRenderObjectProviderClassAR & Tracking › FaceMesh provider for a Face Mesh.
FaceStretchVisualClassAR & Tracking › FaceUsed to apply deformation effects to specific regions of a tracked face.
FaceTrackingEventClassAR & Tracking › FaceThis is the base class for all face tracking events.
FaceTrackingModuleClassAR & Tracking › FaceDeclares the face tracking permission for your Lens project.
FaceTrackingScopeClassAR & Tracking › FaceThe face that a tracker should use.
failAsyncFunctionUtilities › Logging & DebuggingUnhandled Promise rejections are silently ignored by default.
FalloffTypeEnumGraphics, Materials & Particles › Rendering & MaterialsThe types of light falloff from a LightSource.
FileAudioTrackProviderClassAudio & Voice › Playback & EffectsProvider for file based Audio Tracks.
FileBasedMarkerProviderClassAR & Tracking › WorldProvides an image marker based on an imported image file.
FileLicensedSoundProviderClassAudio & Voice › Music & LyricsA file track provider of the Licensed Sounds from Asset LIbrary.
FileTextureProviderClassGraphics, Materials & Particles › Textures & VideoA TextureProvider for textures originating from files.
FilteringModeEnumGraphics, Materials & Particles › Textures & Video
FixedCollisionMeshClassPhysics › Shapes & Collision MeshesUsed for collision meshes that remain static and do not change their shape over time.
FloatAnimationPropertyTrackClassAnimationFloatAnimationPropertyTrack.
FloatCurveAnimationPropertyTrackClassAnimationFloatCurveAnimationPropertyTrack.
FocusEndEventArgsClassInteractionArguments used with the InteractionComponent.onFocusEnd event.
FocusStartEventArgsClassInteractionArguments used with the InteractionComponent.onFocusStart event.
FontClassText & FontsA font asset used for rendering text.
FontCollectionClassText & FontsAn ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.
FontCollectionEntryClassText & Fonts › FontCollectionRepresents a single entry in a FontCollection.
FontFamilyClassText & FontsGroups multiple Font assets into a single family, mapping each to a style (weight + italic).
FontFamilyEntryClassText & Fonts › FontFamilyRepresents a single entry in a FontFamily, mapping a Font asset to a style (weight + italic).
FontStylesEnumText & Fonts
FrustumCullModeEnumGraphics, Materials & Particles › Rendering & MaterialsMode for setting frustum culling on Pass
GameControllerModuleClassInteractionProvides access to game controller input on Spectacles.
GameControllerModule.AnalogStickInputEventClassInteraction › GameControllerModuleFired when a thumbstick's axis values change.
GameControllerModule.AnalogTriggerInputEventClassInteraction › GameControllerModuleFired when a trigger's analog axis value changes.
GameControllerModule.ButtonEnumInteraction › GameControllerModuleCommon gamepad button identifiers.
GameControllerModule.ButtonEventTypeEnumInteraction › GameControllerModuleWhether a button changed to pressed or released.
GameControllerModule.ButtonInputEventClassInteraction › GameControllerModuleFired when a button is pressed or released on a connected controller.
GameControllerModule.ControllerCapabilityEnumInteraction › GameControllerModuleOptional capabilities a controller may support.
GameControllerModule.ControllerConnectedEventClassInteraction › GameControllerModuleFired when a new game controller is connected.
GameControllerModule.ControllerDisconnectedEventClassInteraction › GameControllerModuleFired when a game controller is disconnected.
GameControllerModule.ControllerInfoClassInteraction › GameControllerModuleMetadata describing a connected game controller.
GameControllerModule.ControllerTypeEnumInteraction › GameControllerModuleController family as reported by the device.
GameControllerModule.MotionInputEventClassInteraction › GameControllerModuleFired when motion sensor data (gyroscope, accelerometer) is received.
GameControllerModule.RumbleOptionsClassInteraction › GameControllerModuleOptions for a haptic feedback (rumble) request.
GameControllerModule.SideEnumInteraction › GameControllerModuleWhich side of the controller a thumbstick or trigger belongs to.
GameControllerModule.TouchInfoClassInteraction › GameControllerModuleA single touch point on the controller touchpad.
GameControllerModule.TouchpadInputEventClassInteraction › GameControllerModuleFired when touchpad input is received.
GameControllerModule.TouchStateEnumInteraction › GameControllerModuleState of a single touch point on the controller touchpad.
GameControllerSessionClassInteractionRepresents an active game controller session.
GaussianSplattingAssetClassGraphics, Materials & Particles › Meshes & EffectsAsset that contains Gaussian Splats.
GaussianSplattingVisualClassGraphics, Materials & Particles › Meshes & EffectsAllows displaying GaussianSplattingAsset and play its animation.
GeneralDataStoreClassCloud, Networking & Storage › StorageClass for storing and retrieving data based on keys.
GeoLocationNamespaceAR & Tracking › Location & Navigation
GeoLocation.createLocationServiceFunctionAR & Tracking › Location & Navigation › GeoLocationCreates a new LocationService.
GeoLocation.getGeoPositionForLocationFunctionAR & Tracking › Location & Navigation › GeoLocationReturns the GPS position of a custom location.
GeoLocation.getNorthAlignedHeadingFunctionAR & Tracking › Location & Navigation › GeoLocationCalculates heading based on north aligned device orientation.
GeoLocationAccuracyEnumAR & Tracking › Location & NavigationEnumeration of supported GPS location accuracy.
GeoPositionClassAR & Tracking › Location & NavigationThe location of the device.
GestureModuleClassInteractionAllows to detect hand gestures using machine learning algorithms.
GestureModule.HandTypeEnumInteraction › GestureModuleThe hand used in gesture detection with GestureModule.
GesturesDataArgsClassInteraction
getAbsoluteStartTimeFunctionUtilities › Time & TimersThe start time of the Lens since UNIX Epoch in seconds.
getDeltaTimeFunctionUtilities › Time & TimersReturns the time difference in seconds between the current frame and previous frame.
getRealTimeNanosFunctionUtilities › Time & TimersGet current time in nanoseconds.
getTimeFunctionUtilities › Time & TimersReturns the time in seconds since the lens was started.
globalNamespaceScripting
global.debugRenderSystemVariableScripting › globalReturns the DebugRender, which provides methods to draw primitive visuals for debugging.
global.deviceInfoSystemVariableScripting › globalReturns the global DeviceInfoSystem, which provides information about the device running the Lens.
global.hapticFeedbackSystemVariableScripting › globalReturns the HapticFeedbackSystem, which provides methods to trigger the device's haptic system.
global.launchParamsVariableScripting › globalReturns the global GeneralDataStore for Launch Params, which provides any special data passed in when the Lens is launched.
global.localizationSystemVariableScripting › globalReturns the global LocalizationSystem, which helps convert times, dates, and other units to user friendly strings.
global.persistentStorageSystemVariableScripting › globalReturns the global PersistentStorageSystem, which allows data to persist between Lens sessions.
global.sceneVariableScripting › globalReturns the global ScriptScene object, which offers information and controls for the current scene.
global.textInputSystemVariableScripting › globalReturns the TextInputSystem, which provides methods to access the device's keyboard and typing systems.
global.touchSystemVariableScripting › globalReturns the global TouchDataProvider, which controls how the Lens handles touch events.
global.userContextSystemVariableScripting › globalReturns the global UserContextSystem, which provides information about the user such as display name, birthday, and even current weather.
GltfAssetClassGraphics, Materials & Particles › Meshes & EffectsRepresents a GLTF 3D Model.
GltfSettingsClassGraphics, Materials & Particles › Meshes & Effects › GltfAssetSettings for importing a glTF Asset.
GrabBeginArgsClassInteractionThe arguments of the GrabBegin event on GestureModule.
GrabEndArgsClassInteractionThe arguments of the GrabEnd event on GestureModule.
HairDataAssetClassPhysics › Cloth & HairHair asset converted from an FBX containing splines to be used with HairVisual.
HairVisualClassPhysics › Cloth & HairUsed to simulate and render hairstyles with realistic lighting and physics.
HandRenderObjectProviderClassAR & Tracking › HandProvider for Hand Mesh render object.
HandSpecificDataClassAR & Tracking › HandProvides additional data for the tracked hand.
HandTracking3DAssetClassAR & Tracking › HandEnables Hand Tracking 3D for the ObjectTracking3D component.
HandTrackingScopeClassAR & Tracking › HandThe hand that a tracker should use.
HapticFeedbackSystemClassInteractionTriggers haptic feedback on the device.
HapticFeedbackTypeEnumInteractionThe method in which haptic feedback is provided.
HeadClassAR & Tracking › FaceUsed to move and rotate SceneObjects in sync with the user's head movements.
HeadersClassCloud, Networking & Storage › Internet AccessHeaders for the Fetch API in RemoteServiceModule.
hintFunctionScripting › Decorators
HintsComponentClassUIUsed to display text hints in a Lens.
HitTestSessionClassAR & Tracking › WorldClass responsible for detecting intersections between a virtual ray and real-world surfaces.
HitTestSessionOptionsClassAR & Tracking › World › WorldQueryModuleOptions for configuring a HitTestSession.
HorizontalAlignmentEnumText & FontsUsed by the horizontalAlignment property in MeshVisual.
HorizontalOverflowEnumText & FontsOptions for wrapping text horizontally.
HoverEndEventClassInteractionTriggered when hovering state has ended on an InteractionComponent.
HoverEndEventArgsClassInteractionThe arguments passed in by HoverEndEvent.
HoverEventClassInteractionTriggered when a mouse hover event occurs.
HoverEventArgsClassInteractionBase class for objects representing Script data.
HoverStartEventClassInteractionBase class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.).
HoverStartEventArgsClassInteractionThe arguments passed in by HoverStartEvent.
IEventParametersClassLifecycle EventsThe base class for parameter objects passed into event callbacks.
ImageClassUIUsed to display 2D textures within a scene.
ImageUploadCompressionMethodEnumCloud, Networking & Storage › Remote Assets & MediaSpecifies the compression format to use when uploading an image.
ImageUploadOptionsClassCloud, Networking & Storage › Remote Assets & Media › RemoteMediaModuleProvides configuration options for uploading images via RemoteMediaModule.uploadImage.
inputFunctionScripting › Decorators
InputBuilderClassSnapMLBuilds InputPlaceHolders for MLComponent.
InputPlaceholderClassSnapMLControls input data for a neural network used by an MLComponent.
IntAnimationPropertyTrackClassAnimationIntAnimationPropertyTrack.
InteractionComponentClassInteractionEnables invoking touch interactions with a BaseMeshVisual rendered to specific Camera.
InternetModuleClassCloud, Networking & Storage › Internet AccessProvides access to the open internet.
InternetStatusChangedArgsClassUtilities › Device & RuntimeArguments used with the onInternetStatusChanged event.
IntStepAnimationPropertyTrackClassAnimationIntAnimationPropertyTrack.
isNullFunctionScriptingReturns true if the passed in object is null or destroyed.
IsPhoneInHandBeginArgsClassInteractionThe arguments of getIsPhoneInHandBeginEvent on GestureModule.
IsPhoneInHandEndArgsClassInteractionThe arguments of getIsPhoneInHandEndEvent on GestureModule.
JsonAssetClassUtilities › Data & EncodingRepresents a JsonAsset that can be used to store JSON data in your Lens.
KeyboardManagerNamespaceInteraction
KeyboardManager.isKeyPressedFunctionInteraction › KeyboardManagerReturns true if the specified key is currently pressed.
KeyModifiersEnumInteraction
KeyPressEventClassInteractionThis event is triggered when the user presses a key.
KeyReleaseEventClassInteractionThis event is triggered when the user releases a key.
KeysEnumInteraction
KissFinishedEventClassAR & Tracking › FaceTriggered when the tracked face ends a kiss.
KissStartedEventClassAR & Tracking › FaceTriggered when the tracked face starts a kiss.
labelFunctionScripting › Decorators
LateUpdateEventClassLifecycle EventsEvent that runs during each frame, only if a Component and its SceneObject is enabled.
LayerSetClassSceneUsed to describe a set of layers that an object belongs to or interacts with.
LeaderboardClassUser & FriendsA leaderboard which can contain scores and information about participating users.
Leaderboard.CreateOptionsClassUser & Friends › LeaderboardThe options for the leaderboard to be made.
Leaderboard.OrderingTypeEnumUser & Friends › LeaderboardDescribes how the leaderboard should be ordered.
Leaderboard.RetrievalOptionsClassUser & Friends › LeaderboardDescribes the context for the leaderboard to be requested.
Leaderboard.SafeUserRecordClassUser & Friends › LeaderboardInformation for a user who submitted a score to the leaderboard, carrying only non-sensitive user data.
Leaderboard.UserRecordClassUser & Friends › LeaderboardInformation for a user who submitted a score to the leaderboard.
Leaderboard.UsersTypeEnumUser & Friends › LeaderboardThe type of user to be retrieved.
LeaderboardModuleClassUser & FriendsEnables usage of Leaderboard API within a Lens.
LevelsetColliderAssetClassPhysics › Cloth & HairCollider asset generated from a mesh to be used with the HairVisual as part of the hair simulation.
LevelsetShapeClassPhysics › Shapes & Collision MeshesA levelset collision shape.
LicensedAudioTrackAssetClassAudio & Voice › Music & LyricsA Licensed Sounds audio track from Asset LIbrary.
LightSourceClassGraphics, Materials & Particles › Rendering & MaterialsActs as a source of light in the scene.
LightTypeEnumGraphics, Materials & Particles › Rendering & MaterialsThe types of light emission from a LightSource.
LiquifyVisualClassGraphics, Materials & Particles › Meshes & EffectsApplies a liquify effect to anything rendered behind it.
LoadStatusEnumBase Classes
LocalizationsAssetClassText & FontsAsset that provides the necessary localized text for your Lens.
LocalizationSystemClassText & FontsHelps convert data types to localized string representations.
LocatedAtComponentClassAR & Tracking › Location & NavigationEnables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.
LocationAssetClassAR & Tracking › Location & NavigationProvides a frame of reference in which to localize objects to the real world.
LocationCloudStorageModuleClassCloud, Networking & Storage › StorageProvides access to location cloud storage depending upon the LocationCloudStorageOptions.
LocationCloudStorageOptionsClassCloud, Networking & Storage › Storage › LocationCloudStorageModuleUsed to configure LocationCloudStorage module with various options.
LocationCloudStoreClassCloud, Networking & Storage › StorageInstance of location cloud store which has a similar interface as cloud store.
LocationProximityStatusEnumAR & Tracking › Location & NavigationUsed by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location.
LocationRenderObjectProviderClassAR & Tracking › Location & NavigationProvides access to a location's Mesh--such as when working with City Scale AR.
LocationServiceClassAR & Tracking › Location & NavigationThe LocationService allows the user to provide their location to Lens applications if they so desire.
LocationTextureProviderClassAR & Tracking › Location & NavigationProvides access to a location's texture--such as when working with City Scale AR.
LongPressEndEventArgsClassInteractionArguments used with the InteractionComponent#onLongPressEnd event.
LongPressStartEventArgsClassInteractionArguments used with the InteractionComponent#onLonPressStart event.
LookAtComponentClassSceneOrients a SceneObject towards a target SceneObject.
LookAtComponent.AimVectorsEnumScene › LookAtComponentThe "aim" and "up" vectors used with LookAtComponent when determining rotation.
LookAtComponent.LookAtModeEnumScene › LookAtComponentModes used in LookAtComponent.lookAtMode to determine the rotation method being used.
LookAtComponent.WorldUpVectorEnumScene › LookAtComponentUsed with LookAtComponent to set the "up" vector when determining rotation.
LyricsClassAudio & Voice › Music & LyricsRepresents the full set of Lyrics data for tracked music.
LyricsLineClassAudio & Voice › Music & LyricsRepresents a single line of Lyrics.
LyricsSyncClassAudio & Voice › Music & LyricsRepresents a single sync/word of a LyricsLine.
LyricsTrackerClassAudio & Voice › Music & LyricsProvides information about lyrics data for a currently playing track.
LyricsTypeEnumAudio & Voice › Music & LyricsTypes of granularity for lyric data.
MachineLearningNamespaceSnapML
MachineLearning.createDelayBuilderFunctionSnapML › MachineLearningCreates a new DelayBuilder object.
MachineLearning.createDeltaBuilderFunctionSnapML › MachineLearningCreates a new DeltaBuilder object.
MachineLearning.createInputBuilderFunctionSnapML › MachineLearningCreates a new InputBuilder object.
MachineLearning.createMelSpectrogramBuilderFunctionSnapML › MachineLearningCreates a new MelSpectrogramBuilder object.
MachineLearning.createMFCCBuilderFunctionSnapML › MachineLearningCreates a new MFCCBuilder object.
MachineLearning.createNoiseReductionBuilderFunctionSnapML › MachineLearning
MachineLearning.createOutputBuilderFunctionSnapML › MachineLearningCreates a new OutputBuilder object.
MachineLearning.createPitchShifterBuilderFunctionSnapML › MachineLearning
MachineLearning.createSamplerBuilderFunctionSnapML › MachineLearningCreates SamplerBuilder.
MachineLearning.createSpectrogramBuilderFunctionSnapML › MachineLearningCreates a new SpectrogramBuilder object.
MachineLearning.createTransformerBuilderFunctionSnapML › MachineLearningCreates a new TransformerBuilder object.
MachineLearning.DataLayoutEnumSnapML › MachineLearningUsed with BasePlaceHolder.
MachineLearning.FrameTimingEnumSnapML › MachineLearningTiming options for when MLComponent should start or stop running.
MachineLearning.InferenceModeEnumSnapML › MachineLearningInference modes used by MLComponent.inferenceMode.
MachineLearning.ModelStateEnumSnapML › MachineLearningDescribes the current state of the MLComponent model.
MachineLearning.OutputModeEnumSnapML › MachineLearningTypes of output used by OutputPlaceholder.
ManipulateComponentClassInteractionHandles input information from user touch input via the InteractionComponent to control the Scale, Rotation, and Translation of objects.
ManipulateEndEventClassInteractionThis event is triggered when manipulation on the object ends.
ManipulateEndEventArgsClassInteractionArguments used with the ManipulateComponent.onManipulateEnd event.
ManipulateFrameIntersectResultClassInteraction › ManipulateComponentResult object returned from ManipulateComponent.intersectManipulateFrame.
ManipulateStartEventClassInteractionThis event is triggered when manipulation on the object begins.
ManipulateStartEventArgsClassInteractionArguments used with the ManipulateComponent.onManipulateStart event.
ManipulateTypeEnumInteractionEnum values specifying each type of manipulation.
MapModuleClassAR & Tracking › Location & NavigationAllows access to map texture data around a specified location.
MappingOptionsClassAR & Tracking › Location & Navigation › LocatedAtComponentUsed with MappingSession to describe the session to be created.
MappingSessionClassAR & Tracking › Location & NavigationUsed with the LocatedAtComponent to map the current physical location.
MappingSession.MappingScopeEnumAR & Tracking › Location & Navigation › MappingSessionDetermines what data is included in the checkpoint of the @MappingSession.
MappingSession.MappingThrottlingEnumAR & Tracking › Location & Navigation › MappingSessionThrottling levels for a MappingSession.
MapTextureProviderClassAR & Tracking › Location & NavigationA texture of the map at the given location of a LocationAsset.
MarkerAssetClassAR & Tracking › WorldRepresents a texture to be tracked with MarkerTrackingComponent.
MarkerProviderClassAR & Tracking › WorldBase class for marker providers.
MarkerTrackingComponentClassAR & Tracking › WorldUsed to track images in the camera.
MaskingComponentClassUIMasks out visuals and InteractionComponent touch events area within a rectangle defined by ScreenTransform component.
mat2ClassMathA 2x2 matrix.
mat3ClassMathA 3x3 matrix.
mat4ClassMathA 4x4 matrix.
MaterialClassGraphics, Materials & Particles › Rendering & MaterialsAn asset that describes how visual objects should appear.
MaterialMeshVisualClassGraphics, Materials & Particles › Meshes & EffectsInherits from BaseMeshVisual and provides access to the Material used in the rendering process.
MaterialPropertyOverridesClassGraphics, Materials & Particles › Rendering & MaterialsOverrides the passes of one material on a single visual.
MathUtilsNamespaceMath
MathUtils.clampFunctionMath › MathUtilsClamp floating-point value v in the range [lo, hi] (inclusive).
MathUtils.DegToRadVariableMath › MathUtilsConstant mapping degrees to radians.
MathUtils.lerpFunctionMath › MathUtilsLinearly interpolate from floating-point a to b, based on fraction t (where t=0.0 returns a, and t=1.0 returns b).
MathUtils.RadToDegVariableMath › MathUtilsConstant mapping radians to degrees.
MathUtils.randomRangeFunctionMath › MathUtilsGenerate a random floating-point value in the range [lo, hi).
MathUtils.remapFunctionMath › MathUtilsMap floating-point v from range [inMin, inMax] to [outMin, outMax].
MatterClassPhysics › Bodies & CollidersSettings for the physical substance, such as friction and bounciness, of a collider.
MediaPickerTextureProviderClassGraphics, Materials & Particles › Textures & VideoBase class for Texture Providers based on selectable media.
MelSpectrogramClassSnapMLComputes a mel scale spectrogram - a spectrogram where the frequencies are converted to the mel scale.
MelSpectrogramBuilderClassSnapMLA builder class for MelSpectrogram.
MeshBuilderClassGraphics, Materials & Particles › Meshes & EffectsA class for generating meshes at runtime.
MeshClassificationFormatEnumAR & Tracking › WorldFormats of mesh classification used by WorldRenderObjectProvider.
MeshIndexTypeEnumGraphics, Materials & Particles › Meshes & EffectsPossible index data types used by MeshBuilder.
MeshRenderObjectProviderClassGraphics, Materials & Particles › Meshes & Effects
MeshShadowModeEnumGraphics, Materials & Particles › Rendering & Materials
MeshShapeClassPhysics › Shapes & Collision MeshesAllows meshes to be used as collision shapes, for ColliderComponent and BodyComponent.
MeshTopologyEnumGraphics, Materials & Particles › Meshes & EffectsMesh topology types used by MeshBuilder.
MessageEventClassLifecycle EventsEvent fired when a message is received from the host (Lens Studio or an AI agent).
MFCCClassSnapMLMel-frequency cepstral coefficients.
MFCCBuilderClassSnapMLBuilder class for the MFCC (Mel Frequency Cepstral Co-efficients).
MicrophoneAudioProviderClassAudio & Voice › Playback & EffectsThe Audio Track Provider of the audio from microphone.
MLAssetClassSnapMLRepresents a machine learning model that can be integrated with an MLComponent.
MLComponentClassSnapMLUsed to integrate machine learning models into a Lens.
MotionControllerClassInteractionGives 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.HapticFeedbackEnumInteraction › MotionControllerDefines a set of haptic feedback patterns that can be requested.
MotionController.HapticRequestClassInteraction › MotionControllerDescribes a request for haptic feedback.
MotionController.MotionControllerOptionsClassInteraction › MotionControllerSettings for configuring a motion controller.
MotionController.MotionTypeEnumInteraction › MotionControllerEnum for describing the motion type.
MotionController.OptionsNamespaceInteraction › MotionController
MotionController.TouchPhaseEnumInteraction › MotionControllerEnum that defines a current state of a touch interaction with the touchpad of the motion controller.
MotionController.TrackingQualityEnumInteraction › MotionControllerDescribes Motion Controller tracking quality state, whether the data received from the Motion Controller is accurate or not.
MotionControllerModuleClassInteractionProvides access to MotionController.
MouthClosedEventClassAR & Tracking › FaceTriggered when the tracked face's mouth closes.
MouthOpenedEventClassAR & Tracking › FaceTriggered when the tracked face's mouth opens.
MultiplayerSessionClassConnected Lenses (Multiplayer)An instance of a Connected Lens session among a group of participants who were successfully invited into the experience.
NamedInstanceInfoClassText & Fonts › FontRead-only named axis preset from the font's fvar table, for example "Condensed Bold".
NamedValuesClassAR & Tracking › FaceA type containing two arrays which map positionally to each other.
NativeARTrackingStateEnumAR & Tracking › WorldDescribes the state of the native AR tracking (SLAM) system that backs DeviceTracking.
NativeLibraryAssetClassScriptingNativeLibraryAsset loads a native shared library (e.g. .so, .dylib, .dll) and exposes its exports to JavaScript.
NativePlaneTrackingTypeEnumAR & Tracking › WorldTracking type used by the DeviceTracking component to specify what type of plane to detect.
NaturalFeatureMarkerProviderClassAR & Tracking › WorldBase class for marker providers.
NoiseReductionClassSnapMLBase class for objects representing Script data.
NoiseReductionBuilderClassSnapMLBase class for objects representing Script data.
Object3DAssetClassAR & Tracking › BodyBase class for configuring object tracking in the ObjectTracking3D component.
ObjectPrefabClassSceneRepresents reusable SceneObject hierarchy stored as a resource.
ObjectSpecificDataClassAR & Tracking › BodyProvides additional data for the tracked object.
ObjectTrackingClassAR & Tracking › BodyUsed to track objects in 2D space, such as body parts, pet, hand.
ObjectTracking3DClassAR & Tracking › BodyUsed to track objects in 3D space, such as body, hands.
ObjectTracking3D.TrackingModeEnumAR & Tracking › Body › ObjectTracking3DStrategies for updating attached objects.
ObjectTrackingMaskedTextureProviderClassAR & Tracking › Body
ObjectTrackingNormalsTextureProviderClassAR & Tracking › Body
ObjectTrackingTextureProviderClassAR & Tracking › BodyControls a segmentation texture and its placement using information provided by Object tracking.
OnAwakeEventClassLifecycle EventsEvent that runs immediately when a Component is constructed or deserialized.
OnDestroyEventClassLifecycle EventsEvent that runs when a Component will be destroyed.
OnDidEnterForegroundEventClassLifecycle EventsTriggered when the Lens has entered the Foreground phase.
OnDidEnterSuspendedEventClassLifecycle EventsTriggered when the Lens has entered the Suspended phase.
OnDisableEventClassLifecycle EventsEvent that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled.
OnEnableEventClassLifecycle EventsEvent that runs when a Component becomes enabled, either directly via its own Component.enabled property or because its SceneObject becomes enabled.
OnFullScreenEnterEventClassLifecycle EventsTriggered immediately when the Lens enters full-screen mode.
OnFullScreenExitEventClassLifecycle EventsTriggered when the Lens returns to the standard UI with carousel and other Snapchat UI elements.
OnPauseEventClassLifecycle EventsTriggered when users tap the menu button in Palm UI.
OnResumeEventClassLifecycle EventsTriggered when users tap the menu button in Palm UI during pause state.
OnStartEventClassLifecycle EventsRuns on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering.
OnTimeStartEventClassLifecycle EventsThe base class for scenewide events.
OnWillEnterForegroundEventClassLifecycle EventsTriggered when the Lens is about to enter the Foreground phase.
OnWillEnterSuspendedEventClassLifecycle EventsTriggered when the Lens is about to enter the Suspended phase.
OSEnumUtilities › Device & RuntimeTypes of operating system that may be running on the device.
OutlineSettingsClassText & Fonts › TextUsed in Text's outlineSettings property.
OutputBuilderClassSnapMLBuilds OutputPlaceholders for MLComponent.
OutputPlaceholderClassSnapMLProvides output data from the neural network used by an MLComponent.
OverlapClassPhysics › Collisions & OverlapsExposes state generated for ColliderComponent overlap events.
OverlapEnterEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object.
OverlapExitEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object.
OverlapStayEventArgsClassPhysics › Collisions & OverlapsArgs used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object.
PalmTapDownArgsClassInteractionThe arguments of the PalmTapDown event on GestureModule
PalmTapUpArgsClassInteractionThe arguments of the PalmTapUp event on GestureModule
PanEndEventArgsClassInteractionArguments used with the InteractionComponent#onPanEnd event.
PanGestureEndEventClassInteractionTriggered when a pan gesture ends.
PanGestureMoveEventClassInteractionTriggered while the user is panning.
PanGestureStartEventClassInteractionTriggered when a pan gesture starts.
PanMoveEventArgsClassInteractionArguments used with the InteractionComponent#onPanMove event.
PanStartEventArgsClassInteractionArguments used with the InteractionComponent#onPanStart event.
PassClassGraphics, Materials & Particles › Rendering & MaterialsControls how a mesh will get rendered.
PassPropertyOverridesClassGraphics, Materials & Particles › Rendering & MaterialsOverrides the properties of one material pass on a single visual, without affecting other visuals that use the same material.
PassWrapperClassGraphics, Materials & Particles › Rendering & MaterialsSimilar to Pass, except used by VFXAsset.
PassWrappersClassGraphics, Materials & Particles › Meshes & EffectsAllows for retrieval of a collection of Pass objects used by VFXAsset
PerformanceIndexesClassUtilities › Device & RuntimeProvides information about the device running the Lens.
PersistentStorageSystemClassCloud, Networking & Storage › StorageAllows data to be stored and retrieved between Lens sessions.
PersonTrackingScopeClassAR & Tracking › BodyThe person that a tracker should use.
PhysicsNamespacePhysics › Bodies & Colliders
Physics.ConstraintClassPhysics › Bodies & Colliders › PhysicsConstraints body motion in configurable ways, for simulating physical objects such as joints and hinges.
Physics.ConstraintTypeEnumPhysics › Bodies & Colliders › PhysicsConstraint type used by a Constraint.
Physics.createGlobalProbeFunctionPhysics › Bodies & Colliders › PhysicsCreate an intersection probe that spans all worlds.
Physics.createRootProbeFunctionPhysics › Bodies & Colliders › PhysicsCreate an intersection probe for the implicit root world.
Physics.FilterClassPhysics › Bodies & Colliders › PhysicsScript interface for applying collision filtering to colliders and ray/shape-casts.
Physics.FixedConstraintClassPhysics › Bodies & Colliders › PhysicsFully constrain rotation and translation.
Physics.ForceModeEnumPhysics › Bodies & Colliders › PhysicsType of force to use when applying force or torque to a BodyComponent.
Physics.getRootWorldSettingsFunctionPhysics › Bodies & Colliders › PhysicsGet settings that apply to the implicit root world.
Physics.HingeConstraintClassPhysics › Bodies & Colliders › PhysicsConstraints translation and a single axis of rotation.
Physics.HingeLimitSettingsClassPhysics › Bodies & Colliders › PhysicsSettings that describe how the position of the object should be limited in respect to the applied forces.
Physics.HingeMotorSettingsClassPhysics › Bodies & Colliders › PhysicsSettings describing the independent force (motor) applied to the constraint.
Physics.HingeMotorTypeEnumPhysics › Bodies & Colliders › PhysicsEnum that defines motor type.
Physics.PointConstraintClassPhysics › Bodies & Colliders › PhysicsA type of constraint that only allows rotation.
Physics.WorldSettingsAssetClassPhysics › Bodies & Colliders › PhysicsStores reusable settings for a Physics WorldComponent such as gravity magnitude and direction.
PinchDownArgsClassInteractionThe arguments of the PinchDown event on GestureModule
PinchEndEventArgsClassInteractionArguments used with the InteractionComponent#onPinchEnd event.
PinchGestureEndEventClassInteractionTriggered when a pinch gesture ends.
PinchGestureMoveEventClassInteractionTriggered while the user is pinching.
PinchGestureStartEventClassInteractionTriggered when a pinch gesture starts.
PinchMoveEventArgsClassInteractionArguments used with the InteractionComponent#onPinchMove event.
PinchStartEventArgsClassInteractionArguments used with the InteractionComponent#onPinchStart event.
PinchStrengthArgsClassInteractionThe arguments of the PinchStrength event on GestureModule
PinchUpArgsClassInteractionThe arguments of the PinchUp event on GestureModule
PinToMeshComponentClassGraphics, Materials & Particles › Meshes & EffectsAttaches the SceneObject to the mesh surface of a specific RenderMeshVisual.
PinToMeshComponent.OrientationEnumGraphics, Materials & Particles › Meshes & Effects › PinToMeshComponentUsed with PinToMeshComponent.orientation.
PitchShifterClassSnapMLBase class for objects representing Script data.
PitchShifterBuilderClassSnapMLBase class for objects representing Script data.
PlaybackModeEnumAnimationUsed with AnimationClip to describe how the clip should be played.
PointCloudClassAR & Tracking › WorldRepresents 3D locations of stationary features in the environment.
PositionEffectClassAudio & Voice › Playback & EffectsAn Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component.
PostEffectVisualClassGraphics, Materials & Particles › Meshes & EffectsUses an input color lookup table image to adjust the coloring of the Lens.
printFunctionUtilities › Logging & DebuggingPrints out a message to the Logger window.
ProbeClassPhysics › Ray CastsPerforms collision tests (such as ray casts) in one or more world.
ProceduralMeshRenderObjectProviderClassGraphics, Materials & Particles › Meshes & EffectsRenderObjectProvider for mesh objects generated procedurally.
ProceduralTextureProviderClassGraphics, Materials & Particles › Textures & VideoProvides a texture that can be written to or read from.
ProcessedLocationModuleClassAR & Tracking › Location & NavigationDeclares the precise location tracking permission for your Lens project.
PropertiesClassGraphics, Materials & Particles › Meshes & Effects
PropertyOverridesClassGraphics, Materials & Particles › Rendering & MaterialsOverrides material properties on a single visual, without affecting other visuals that use the same material.
ProviderClassBase ClassesBase class for all resource providers.
ProxyTextureProviderClassGraphics, Materials & Particles › Textures & VideoTexture Provider used as output from other systems, for instance SnapML.
quatClassMathA quaternion, used to represent rotation.
QuatAnimationPropertyTrackClassAnimationQuatAnimationPropertyTrack.
QuatSlerpAnimationPropertyTrackClassAnimationQuatSlerpAnimationPropertyTrack.
RawLocationModuleClassAR & Tracking › Location & NavigationDeclares the coarse location tracking permission for your Lens project.
RayCastHitClassPhysics › Ray CastsHit results of a ray-cast provided to script.
RayTracingSettingsClassGraphics, Materials & Particles › Rendering & MaterialsRay Tracing settings for a camera.
RealtimeStoreCreateOptionsClassConnected Lenses (Multiplayer) › MultiplayerSessionThe options for the realtime store.
RealtimeStoreCreateOptions.OwnershipEnumConnected Lenses (Multiplayer) › RealtimeStoreCreateOptionsThe ownership model of a realtime store.
RealtimeStoreCreateOptions.PersistenceEnumConnected Lenses (Multiplayer) › RealtimeStoreCreateOptionsThe persistence model for a realtime store.
RecordingStateEnumLifecycle EventsDescribes the current recording state of the Lens.
RectClassMathAn axis aligned rectangle.
RectangleSetterClassUIPositions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider.
RectCropTextureProviderClassGraphics, Materials & Particles › Textures & VideoTexture Provider providing a cropped region of the input texture.
RemoteApiRequestClassCloud, Networking & Storage › RemoteServiceModule
RemoteApiResponseClassCloud, Networking & Storage › RemoteServiceModule
RemoteMediaModuleClassCloud, Networking & Storage › Remote Assets & MediaAllows the Lens to download and integrate remote media content such as 3D GLTF assets, images, audio tracks, and video textures into Lenses.
RemoteReferenceAssetClassCloud, Networking & Storage › Remote Assets & MediaProvides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script.
RemoteServiceHttpRequestClassCloud, Networking & Storage › Internet Access › InternetModuleA http request which can be sent using the RemoteServiceModule.
RemoteServiceHttpRequest.HttpRequestMethodEnumCloud, Networking & Storage › Internet Access › RemoteServiceHttpRequestThe http method which should be used to send this http request.
RemoteServiceHttpResponseClassCloud, Networking & Storage › Internet Access › InternetModuleThe response returned by a RemoteServiceHttpRequest call.
RemoteServiceModuleClassCloud, Networking & StorageProvides access to Snap authorized remote services.
RenderMeshClassGraphics, Materials & Particles › Meshes & EffectsRepresents a mesh asset.
RenderMeshVisualClassGraphics, Materials & Particles › Meshes & EffectsExtends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene.
RenderObjectProviderClassGraphics, Materials & Particles › Meshes & EffectsProvider for RenderMesh data.
RenderTargetProviderClassGraphics, Materials & Particles › Rendering & MaterialsControls a camera texture resource.
RenderTargetProvider.AntialiasingModeEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderThe anti-aliasing technique to use on a render target.
RenderTargetProvider.AntialiasingQualityEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderThe fidelity of the anti-aliasing technique to apply.
RenderTargetProvider.DepthBufferUsageEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderControls depth buffer usage strategy for the render target.
RenderTargetProvider.MSAAStrategyEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderHow MSAA should be applied to the render target.
RenderTargetProvider.OutputResolutionEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderControls the resolution source for the render target.
RenderTargetProvider.TextureTypeEnumGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderSpecifies what kind of render target it is.
RequestClassCloud, Networking & Storage › Internet AccessRepresents an HTTP request used by the Fetch API in RemoteServiceModule.
requireFunctionScriptingLoad a JavaScript module.
requireAssetFunctionScriptingLoad an asset like a Texture, Material, or MLAsset directly from script.
requireTypeFunctionScriptingLoad a script by name or path in order to use that type to create or get a component at runtime.
ResponseClassCloud, Networking & Storage › Internet AccessRepresents an HTTP response used by the Fetch API in RemoteServiceModule.
RestrictedResourceClassCloud, Networking & Storage › Remote Assets & MediaA DynamicResource whose raw data cannot be retrieved as bytes or string.
RetouchVisualClassAR & Tracking › FaceAdds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc.
ReverseCameraTextureProviderClassAR & Tracking › CameraTexture Provider giving the camera texture that is the opposite of CameraTextureProvider.
RotatedRectClassSnapML
RotationOptionsClassAR & Tracking › World › DeviceTrackingUsed with DeviceTracking#rotationOptions to change settings for Rotation tracking mode.
runInEditorFunctionScripting › Decorators
SafeUserClassUser & FriendsRepresents a user of the current runtime with only non-sensitive information (Bitmoji info).
SamplerClassSnapML
SamplerBuilderClassSnapMLClass for building Sampler.
SamplerWrapperClassGraphics, Materials & Particles › Rendering & MaterialsAn accessor for Pass.samplers when using PassWrappers
SamplerWrappersClassGraphics, Materials & Particles › Rendering & MaterialsA 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…
ScanModuleClassAR & Tracking › WorldProvides access to a Scan system that allows users to scan objects, places, and cars with a database of item labels within a Lens.
ScanModule.ContextsNamespaceAR & Tracking › World › ScanModule
ScanModule.Contexts.CarsVariableAR & Tracking › World › ScanModuleCategory containing cars.
ScanModule.Contexts.ObjectsVariableAR & Tracking › World › ScanModuleCategory containing objects.
ScanModule.Contexts.PlacesVariableAR & Tracking › World › ScanModuleCategory containing places.
SceneActivityPhaseEnumLifecycle EventsRepresents the current lifecycle activity phase of the Scene.
SceneEventClassLifecycle EventsThe base class for scenewide events.
SceneObjectClassSceneAn object in the scene hierarchy, containing a Transform and possibly Component.
SceneObjectEventClassLifecycle EventsBase class for all object-based Event types in Lens Studio (ManipulateStartEvent, TapEvent, etc.).
ScreenRegionComponentClassUIOverrides the settings on a local ScreenTransform to fit specific screen region on the device.
ScreenRegionTypeEnumUITypes of screen regions that can be used with ScreenRegionComponent.
ScreenTextureProviderClassGraphics, Materials & Particles › Rendering & MaterialsTexture providing the current Render Target being rendered.
ScreenTransformClassUIUsed for positioning objects in 2D screen space.
scriptVariableScripting
ScriptAssetClassScriptingRepresents a JavaScript or TypeScript script that can be used to add logic in your Lens.
ScriptComponentClassScriptingUsed to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity.
ScriptObjectClassBase ClassesBase class for objects representing Script data.
ScriptProfilerNamespaceUtilities › Logging & Debugging
ScriptProfiler.startSamplingFunctionUtilities › Logging & Debugging › ScriptProfilerStarts the sampling profiler.
ScriptProfiler.stopSamplingFunctionUtilities › Logging & Debugging › ScriptProfilerStops the sampling profiler and writes the trace to device storage.
ScriptSceneClassSceneRepresents the Lens scene.
ScrollEndEventArgsClassInteractionArguments used with the InteractionComponent#onScrollEnd event.
ScrollEventArgsClassInteractionArguments used with the InteractionComponent#onScroll event.
ScrollStartEventArgsClassInteractionArguments used with the InteractionComponent#onScrollStart event.
SegmentationModelClassAR & Tracking › CameraSegmentation model used for SegmentationTextureProvider.
SegmentationTextureProviderClassAR & Tracking › CameraControls a segmentation texture resource.
SelectEndEventArgsClassInteractionArguments used with the InteractionComponent.onSelectEnd event.
SelectStartEventArgsClassInteractionArguments used with the InteractionComponent.onSelectStart event.
SerializableWithUIDClassBase ClassesLow-level data class.
setTimeoutFunctionUtilities › Time & TimersSets a timeout to call the provided callback after the specified number of milliseconds.
ShadowMapQualityEnumGraphics, Materials & Particles › Rendering & Materials
ShadowTypeEnumGraphics, Materials & Particles › Rendering & MaterialsThe types of shadows that a LightSource can cast.
ShapeClassPhysics › Shapes & Collision MeshesBase type for collision shapes.
ShoppingLoadingIndicatorClassCommerce › ShoppingRepresents the loading state of the ShoppingModule.
ShoppingModuleClassCommerce › ShoppingAllows the creation of Shopping Lenses with an integrated Product Catalog.
showIfFunctionScripting › Decorators
SkinClassGraphics, Materials & Particles › Meshes & EffectsRepresents skinning data for rigged meshes.
SliderWidgetClassScripting › UIControl
SmileFinishedEventClassAR & Tracking › FaceTriggered when a smile ends on the tracked face.
SmileStartedEventClassAR & Tracking › FaceTriggered when a smile begins on the tracked face.
SnapchatFriendUserInfoClassUser & FriendsDetails about friendship between the active user and another user.
SnapchatUserClassUser & FriendsA User backed by a Snapchat account.
SnapcodeMarkerProviderClassAR & Tracking › WorldProvides a marker for tracking Snapcodes.
SnapDataNamespaceUser & Friends
SnapData.addUserMentionFunctionUser & Friends › SnapDataIf a Snap is taken, the passed in user will be included in a mention sticker.
SnapImageCaptureEventClassLifecycle EventsCalled when the user taps on the capture button to record an image.
SnapOSNamespaceUtilities › Device & Runtime
SnapOS.onThrottleStateChangedVariableUtilities › Device & Runtime › SnapOSFires whenever the SnapOS Dynamic Power Manager throttle state changes, delivering the current ThrottleState.
SnapRecordStartEventClassLifecycle EventsGets called when the user starts long pressing the capture button to record a Snap.
SnapRecordStopEventClassLifecycle EventsGets called when the user stops long pressing the Snap button to end recording of a Snap.
SortOrderEnumSnapMLOrder that inTensor will be sorted when applying TensorMath.argSortMasked().
SoundSyncClassAudio & Voice › Music & LyricsRepresents beat synchronization data for a music track.
SoundSyncBeatClassAudio & Voice › Music & LyricsRepresents a single musical beat used to synchronize effects with music.
SoundSyncTrackerClassAudio & Voice › Music & LyricsTracks music beats and provides events for beat occurrences and playback state changes.
SourceMapsNamespaceUtilities › Logging & Debugging
SourceMaps.applyToStackTraceFunctionUtilities › Logging & Debugging › SourceMapsApplies the SourceMaps to the stack trace to map JavaScript to TypeScript.
SpatialAudioClassAudio & Voice › Playback & EffectsBase class for objects representing Script data.
SpecsInteractionModuleClassInteractionEntry point for the SPECS Interaction System.
SpecsInteractionModule.BoxOverlapProbeClassInteraction › SpecsInteractionModuleAn OverlapProbe whose volume is an oriented box that tracks the SceneObject's world rotation (uniform scale only).
SpecsInteractionModule.CastHitClassInteraction › SpecsInteractionModuleHit result returned by SpecsInteractionModule's cast queries.
SpecsInteractionModule.CursorClassInteraction › SpecsInteractionModuleThe latest cursor pose for an interactor.
SpecsInteractionModule.CursorVisualModeEnumInteraction › SpecsInteractionModuleCursor visual treatment.
SpecsInteractionModule.CursorVisualStateClassInteraction › SpecsInteractionModuleCursor visual state, passed to SpecsInteractionModule.Interactor#setCursorVisualState.
SpecsInteractionModule.DebugVisualizerOptionsClassInteraction › SpecsInteractionModuleWhich debug visualizers the interaction system draws for this Lens's interaction content.
SpecsInteractionModule.FieldStateEnumInteraction › SpecsInteractionModuleThe targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), h…
SpecsInteractionModule.InteractableOptionsClassInteraction › SpecsInteractionModuleOptions supplied when registering an interactable.
SpecsInteractionModule.InteractionPlaneOptionsClassInteraction › SpecsInteractionModuleOptions supplied when registering an interaction plane.
SpecsInteractionModule.InteractorClassInteraction › SpecsInteractionModuleA live interactor.
SpecsInteractionModule.InteractorKindEnumInteraction › SpecsInteractionModuleThe category of an interactor.
SpecsInteractionModule.OverlapClassInteraction › SpecsInteractionModuleOne collider inside an overlap probe's volume, with an id stable from the enter to the exit of that membership.
SpecsInteractionModule.OverlapEnterEventArgsClassInteraction › SpecsInteractionModuleArgs for OverlapProbe#onOverlapEnter, delivered once per frame: enteredOverlaps, every membership that entered the probe's volume this frame.
SpecsInteractionModule.OverlapExitEventArgsClassInteraction › SpecsInteractionModuleArgs for OverlapProbe#onOverlapExit, delivered once per frame: exitedOverlaps, every membership that left the probe's volume this frame (or whose collider wa…
SpecsInteractionModule.OverlapProbeClassInteraction › SpecsInteractionModuleAn edge-triggered overlap probe.
SpecsInteractionModule.OverlapProbeOptionsClassInteraction › SpecsInteractionModuleOptions supplied when creating an OverlapProbe.
SpecsInteractionModule.SphereOverlapProbeClassInteraction › SpecsInteractionModuleAn OverlapProbe whose volume is a sphere.
SpecsInteractionModule.TargetingModeEnumInteraction › SpecsInteractionModuleHow an interactor can target an Interactable, as a bitmask of interaction methods.
SpecsInteractionModule.TargetingPriorityEnumInteraction › SpecsInteractionModuleTargeting priority for this Interactable.
SpecsInteractionModule.TargetingRayClassInteraction › SpecsInteractionModuleThe latest targeting ray for an interactor.
SpecsInteractionModule.TargetingVisualEnumInteraction › SpecsInteractionModuleThe targeting visual shown while an interactor targets an Interactable or InteractionPlane.
SpecsInteractionModule.TriangleHitClassInteraction › SpecsInteractionModuleTriangle hit information, available when a cast from SpecsInteractionModule intersects a collision mesh.
SpecsUserClassUser & FriendsA User backed by a Specs (Spectacles) account, which may or may not have a Snapchat account linked.
SpectaclesHandSpecificDataClassAR & Tracking › Hand
SpectaclesMobileKitModuleClassCloud, Networking & Storage › Spectacles Mobile KitSpectaclesMobileKitModule serves as the primary entry point for the Spectacles Mobile Kit, enabling interaction with a specific mobile application, such as r…
SpectaclesMobileKitSessionClassCloud, Networking & Storage › Spectacles Mobile KitSpectacles Mobile Kit session allows you to initiate the connection to peer, and send data.
SpectrogramClassSnapMLRepresentation the signal strength over time at various frequencies present in a particular waveform.
SpectrogramBuilderClassSnapMLThe builder class for Spectrogram.
SphereShapeClassPhysics › Shapes & Collision MeshesA sphere collision shape.
SpinBoxWidgetClassScripting › UIControl
StateInfoClassCommerce › Shopping › ShoppingModuleA state used in an DomainInfo used by a ShoppingModule.
StencilClearOptionEnumGraphics, Materials & Particles › Rendering & MaterialsStencil buffer clear option.
StencilFaceEnumGraphics, Materials & Particles › Rendering & MaterialsSpecifies whether the front and/or back face stencil test will be applied.
StencilFunctionEnumGraphics, Materials & Particles › Rendering & MaterialsSpecifies the stencil test function.
StencilOperationEnumGraphics, Materials & Particles › Rendering & MaterialsOptions for specifying the action to take when stencil and depth tests resolve.
StencilStateClassGraphics, Materials & Particles › Rendering & MaterialsThe stencil test state for Pass.
StorageOptionsClassConnected Lenses (Multiplayer)Settings for saving values in a MultiplayerSession.
StorageScopeEnumCloud, Networking & Storage › StorageSpecifies a scope for storing or retrieving values from a MultiplayerSession.
StretchModeEnumUIOptions for stretching a mesh to fit a ScreenTransform Used in RenderMeshVisual stretchMode property, as long as the SceneObject has a ScreenTransform attached.
StretchPointClassAR & Tracking › FaceA point in the FaceStretchVisual feature.
StudioNamespaceUtilities › Logging & Debugging
Studio.logFunctionUtilities › Logging & Debugging › StudioPrints out a message to the Logger window in Studio.
SupabaseModuleClassCloud, Networking & Storage › Snap CloudProvides access to Supabase authentication and database capabilities.
SupabaseProjectClassCloud, Networking & Storage › Snap CloudRepresents a Supabase project with configuration details.
SurfaceClassificationEnumAR & Tracking › WorldThe classification of the surface at the position where the ray intersects with the environment.
SurfaceOptionsClassAR & Tracking › World › DeviceTrackingUsed with DeviceTracking#surfaceOptions to change settings for Surface tracking mode.
SurfaceTouchDataArgsClassAR & Tracking › World
SystemMenuModuleNamespaceUtilities › Device & Runtime
TangentTypeEnumAnimationUsed with AnimationKeyFrame.
TapEventClassInteractionThis event is triggered when the user taps on the screen.
TapEventArgsClassInteractionArguments used with the InteractionComponent.onTap event.
TargetingDataArgsClassInteraction
TensorMathNamespaceSnapML
TensorMath.addScalarFunctionSnapML › TensorMathAdds a scalar value to each element of inTensor and puts the result into outTensor.
TensorMath.addTensorsFunctionSnapML › TensorMathAdds inTensorA to inTensorB and puts the result into outTensor.
TensorMath.amplitudeToDbFunctionSnapML › TensorMathConverts inTensor from the amplitude scale to the decibel scale.
TensorMath.applyBoxFilterFunctionSnapML › TensorMathBlurs an image tensor using the box filter.
TensorMath.applyNMSFunctionSnapML › TensorMath
TensorMath.applyThresholdFunctionSnapML › TensorMathApplies a fixed-level threshold to each array element.
TensorMath.approximatePolygonalCurveFunctionSnapML › TensorMathApproximates a polygonal curve with the specified precision.
TensorMath.argMaxFunctionSnapML › TensorMathReturns the indices of the maximum values along an the channels of inTensor, with the specified inShape.
TensorMath.argSortFunctionSnapML › TensorMathSimilar to numpy.argsort(), but in TensorMath, we have no kind and order parameters.
TensorMath.argSortMaskedFunctionSnapML › TensorMathApplies a list of indices of a tensor in sorted order of their corresponding values in the tensor to the given outTensor.
TensorMath.BorderTypeEnumSnapML › TensorMath
TensorMath.clampFunctionSnapML › TensorMathClamps all values of inTensor between minVal and maxVal, and puts the result into outTensor.
TensorMath.concatFunctionSnapML › TensorMathConcatenates inTensorA and inTensorB along the specified axis and puts the result to the outTensor.
TensorMath.dilateFunctionSnapML › TensorMathDilates an image by using a specific structuring element.
TensorMath.divTensorsFunctionSnapML › TensorMathDivides inTensorA by inTensorB and puts the result into outTensor.
TensorMath.drawLineFunctionSnapML › TensorMathDraws a line segment connecting two points.
TensorMath.erodeFunctionSnapML › TensorMathErodes an image by using a specific structuring element.
TensorMath.fillConvexPolyFunctionSnapML › TensorMathFills a convex polygon.
TensorMath.fillPolyFunctionSnapML › TensorMathFills a polygon.
TensorMath.findContoursFunctionSnapML › TensorMathReturns contours.
TensorMath.findMinDistancesBetweenFunctionSnapML › TensorMathFinds minimum distances between each 2D point from one array, to 2D points in another array.
TensorMath.getContourFunctionSnapML › TensorMathLooks for contour points in a grayscale texture, or any one-channel tensor.
TensorMath.getRotatedRectPointsFunctionSnapML › TensorMath
TensorMath.getVectorsLengthFunctionSnapML › TensorMathCalculates the length of all vectors in an array.
TensorMath.isInRectangleFunctionSnapML › TensorMathChecks for each 2D point whether it is inside of a rectangle.
TensorMath.maxFunctionSnapML › TensorMathPlaces the maximum values of inTensor into outTensor.
TensorMath.maxDistanceBetweenPointsFunctionSnapML › TensorMathFrom the input points, finds the two points with the maximum distance between them and returns this distance.
TensorMath.maxInSlideWindowFunctionSnapML › TensorMathIf we consider the tensor as a 3D array, this function finds the indexes of the maximum element in each subarray of size window.
TensorMath.minFunctionSnapML › TensorMathPlaces the minimum values of inTensor into outTensor.
TensorMath.minAreaRectFunctionSnapML › TensorMathReturn TensorMath's format of RotatedRect.
TensorMath.minInSlideWindowFunctionSnapML › TensorMathIf we consider the tensor as a 3D array, this function finds the indexes of the minimum element in each subarray of size window.
TensorMath.mulMatToPointsFunctionSnapML › TensorMathMultiply a matrix by a set of points through an efficient batch operation.
TensorMath.mulScalarFunctionSnapML › TensorMathMultiplies each element of inTensor by a scalar value and puts the result into outTensor.
TensorMath.mulTensorsFunctionSnapML › TensorMathMultiplies inTensorA and inTensorB and puts the result into outTensor.
TensorMath.opticalFlowFunctionSnapML › TensorMathStabilizes image objects between two consecutive frames caused by camera or object movement.
TensorMath.permuteFunctionSnapML › TensorMathRearranges the inTensor of inShape according to the desired ordering and puts the result into outTensor.
TensorMath.polarSort2dFunctionSnapML › TensorMathSorts 2D points by polar angle relative to the center point.
TensorMath.powerFunctionSnapML › TensorMathRaises elements of inTensor to the power of val, and puts the results into outTensor.
TensorMath.powerToDbFunctionSnapML › TensorMathConverts inTensor from the power scale to the decibel scale.
TensorMath.projectPointsFunctionSnapML › TensorMathProject 3D points into 2D space using an efficient batch operation.
TensorMath.repeatFunctionSnapML › TensorMathDuplicates inTensor elements and store result in the outTensor.
TensorMath.rotatePoints3dFunctionSnapML › TensorMathApplies a rotation to each point in a set of 3D points, and places the results in outPoints.
TensorMath.smoothPointsFunctionSnapML › TensorMathSmooths a polygon formed by input points.
TensorMath.softArgMaxFunctionSnapML › TensorMathApplies softArgMax function to the inTensor, with the specified inShape.
TensorMath.softMaxFunctionSnapML › TensorMathApplies softMax function to inTensor, with the specified inShape.
TensorMath.solvePnPFunctionSnapML › TensorMathEstimates the object pose given a set of object points (inObjectPoints), their corresponding image projections (inImagePoints), and the intrinsic camera matr…
TensorMath.solvePnPExtendedFunctionSnapML › TensorMathEstimates the object pose given a set of object points (inObjectPoints), their corresponding image projections (inImagePoints), and the intrinsic camera matr…
TensorMath.solvePnPRansacFunctionSnapML › TensorMathsolvePnPRansac is very similar to solvePnPExtended except that it uses Random Sample Consensus ( RANSAC ) for robustly estimating the pose.
TensorMath.subpixelArgMaxFunctionSnapML › TensorMathApplies subpixelArgMax function to the inTensor, with the specified inShape and kernel size.
TensorMath.subTensorsFunctionSnapML › TensorMathSubtracts inTensorB from inTensorA and puts the result into outTensor.
TensorMath.sumFunctionSnapML › TensorMathCalculate the sum of the inTensor elements and store result in the outTensor.
TensorMath.textureToGrayscaleFunctionSnapML › TensorMathConverts the texture to a set of 0-255 grayscale values, and outputs the result into outTensor.
TensorMath.ThresholdMethodEnumSnapML › TensorMath
TextClassText & FontsRenders 2D text with specific style and layout.
Text3DClassText & FontsRenders 3D text with specific style, layout and material.
Text3DExtrudeDirectionEnumText & FontsControls the direction in which Text3D meshes are extruded relative to the component's local position.
TextAreaWidgetClassScripting › UIControl
TextDecoderClassUtilities › Data & EncodingContains methods for Text decoding
TextEncoderClassUtilities › Data & EncodingContains methods for Text encoding
TextFillClassText & FontsFill settings used by several text related classes.
TextFillModeEnumText & FontsUsed in TextFill's mode property.
TextInputModuleClassInteractionDeclares the Input Framework (Text) permission for your Lens project.
TextInputSystemClassInteractionProvides access to the device's input system.
TextInputSystem.KeyboardKindEnumInteraction › TextInputSystemThe kind of keyboard currently serving the text input session.
TextInputSystem.KeyboardOptionsClassInteraction › TextInputSystemThe settings used for how the input keyboard should work.
TextInputSystem.KeyboardTypeEnumInteraction › TextInputSystemThe different input style of keyboard input.
TextInputSystem.ReturnKeyTypeEnumInteraction › TextInputSystemThe return key style of keyboard input.
TextInputSystem.TextFieldActionEnumInteraction › TextInputSystemEditor action for the text field (e.g. when user presses action key on keyboard).
TextInputSystem.TextUpdateClassInteraction › TextInputSystemText update from the input method (text and selection range).
TextProviderClassText & FontsControls a text rendering texture.
TextToSpeechNamespaceAudio & Voice › Speech
TextToSpeech.VoiceNamesNamespaceAudio & Voice › Speech › TextToSpeech
TextureClassGraphics, Materials & Particles › Textures & VideoRepresents a texture file asset.
TextureFormatEnumGraphics, Materials & Particles › Textures & Video
TextureProviderClassGraphics, Materials & Particles › Textures & VideoThe base class for specialized Texture providers.
TextureTrackingScopeClassAR & TrackingProvides a Texture to do face tracking on for entities like Head, FaceStretch, and FaceMesh.
TextureUsageEnumGraphics, Materials & Particles › Textures & VideoTexture capabilities that can be queried for a TextureFormat with DeviceInfoSystem#isFormatSupported.
ThrottleModeEnumUtilities › Device & RuntimeThe device's thermal/power throttle level as reported by the SnapOS Dynamic Power Manager.
ThrottleStateClassUtilities › Device & RuntimeA complete snapshot of the device's Dynamic Power Manager throttle state.
TileZoneEnumText & FontsDefines the bounding area used for texture tiling with TextFill's tileZone property.
TouchDataProviderClassInteractionThis 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…
TouchEndEventClassInteractionTriggered when a touch event ends.
TouchEndEventArgsClassInteractionArguments used with the InteractionComponent.onTouchEnd event.
TouchMoveEventClassInteractionTriggered when a touch position on the screen is moved.
TouchMoveEventArgsClassInteractionArguments used with the InteractionComponent.onTouchMove event.
TouchStartEventClassInteractionTriggered when a touch event starts.
TouchStartEventArgsClassInteractionArguments used with the InteractionComponent.onTouchStart event.
TouchStateEnumInteraction
TrackedMeshClassAR & Tracking › WorldRepresents a mesh generated by world tracking.
TrackedMeshFaceClassificationEnumAR & Tracking › WorldClassifications of mesh face.
TrackedMeshHistogramResultClassAR & Tracking › World › DeviceTrackingProvides histogram information about tracked world mesh faces in a given area.
TrackedMeshHitTestResultClassAR & Tracking › World › WorldRaycastProvides information about a TrackedMesh surface hit during a raycast.
TrackedPlaneClassAR & Tracking › WorldA representation for plane detected by native tracking.
TrackedPlaneClassificationEnumAR & Tracking › WorldThe semantic class of a TrackedPlane.
TrackedPlaneHitTestResultClassAR & Tracking › World › WorldRaycastThe result of a raycast against a TrackedPlane.
TrackedPlaneOrientationEnumAR & Tracking › World
TrackingScopeClassAR & TrackingThe scope, such as the texture it should track against, in which a tracker, such as FaceMaskVisual, EyeColorVisual, BodyDepthTextureProvider, should be applied.
TrackingStatusClassAR & TrackingTrackingStatus signals changes in data availability for the tracked object.
TransformClassSceneControls the position, rotation, and scale of a SceneObject.
TransformerClassSnapMLApplies additional transform processing on data for InputPlaceholders and OutputPlaceholders used with MLComponent.
TransformerBuilderClassSnapMLBuilds Transformer objects for MLComponent.
TransformerRotationEnumSnapMLRotation types used by TransformBuilder.
TriangleHitClassPhysics › Ray CastsTriangle hit information, available when a ray cast intersects a collision mesh.
TriggerPrimaryEventClassInteractionGets called when the user triggers the primary input on their device.
TriggerPrimaryEventArgsClassInteractionArguments used with the InteractionComponent.onTriggerPrimary event.
TurnOffEventClassLifecycle EventsTriggered when the lens turns off.
typedefFunctionScripting › Decorators
typenameFunctionScripting › Decorators
uiNamespaceScripting › Decorators
ui.group_endFunctionScripting › Decorators
ui.group_startFunctionScripting › Decorators
ui.labelFunctionScripting › Decorators
ui.separatorFunctionScripting › Decorators
UIControlClassScripting › UIControl
UIWidgetClassScripting › UIControl
UpdateEventClassLifecycle EventsEvent that runs during each frame, only if a Component and its SceneObject is enabled.
UpperBodyRenderObjectProviderClassAR & Tracking › BodyProvides a render object of the upper body, without the head.
UpperBodyTrackingAssetClassAR & Tracking › BodyConfigures 3D Upper Body Tracking for the ObjectTracking3D component.
UserClassUser & FriendsRepresents a user of the current runtime.
UserActivityModuleClassUser & FriendsExposes the user's current mode of action (e.g. stationary, walking) and posture (e.g. standing, sitting) to Lens developers.
UserActivityModule.ModeOfActionEnumUser & Friends › UserActivityModuleAn enumeration describing which activity is currently performed by the user.
UserActivityModule.PostureEnumUser & Friends › UserActivityModuleAn enumeration describing the user's current posture.
UserBirthdayClassUser & FriendsA user's birth month and day, returned by User#birthday.
UserContextSystemClassUser & FriendsProvides information about the user such as display name, birthday, and current weather.
Utf8NamespaceUtilities › Data & Encoding
Utf8.decodeFunctionUtilities › Data & Encoding › Utf8Decodes a utf-8 Uint8Array to a utf-16 string
Utf8.encodeFunctionUtilities › Data & Encoding › Utf8Encodes a utf-16 string as a utf-8 Uint8Array
VariationAxisInfoClassText & Fonts › FontRead-only metadata describing one OpenType variation axis on a variable font.
vec2ClassMathA two dimensional vector.
Vec2CurveAnimationPropertyTrackClassAnimationVec2CurveAnimationPropertyTrack.
vec3ClassMathA three dimensional vector.
Vec3AnimationPropertyTrackClassAnimationVec3AnimationPropertyTrack.
Vec3CurveAnimationPropertyTrackClassAnimationVec3CurveAnimationPropertyTrack.
vec4ClassMathA four dimensional vector.
vec4bClassMathA vector containing 4 boolean values.
Vec4CurveAnimationPropertyTrackClassAnimationVec4CurveAnimationPropertyTrack.
VectorCompositeClassGraphics, Materials & Particles › Vector GraphicsA retained, tessellated vector-image asset (built from an SVG document).
VectorComposite.FillRuleEnumGraphics, Materials & Particles › Vector Graphics › VectorCompositeFill rule for closed path regions; determines which points are "inside" when fill contours overlap or self-intersect.
VectorComposite.GradientKindEnumGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe kind of a built VectorGradient.
VectorComposite.LineCapEnumGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe line cap style for a stroked path — how the ends of open sub-paths and dash segments are rendered.
VectorComposite.LineJoinEnumGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe line join style for a stroked path — how corners between connected path segments are rendered.
VectorComposite.RenderRequestClassGraphics, Materials & Particles › Vector Graphics › VectorCompositePer-draw options for VectorRenderer#render: where to draw (viewport), which part of the source to draw (region), and whether to clear first (clear).
VectorComposite.SpreadModeEnumGraphics, Materials & Particles › Vector Graphics › VectorCompositeHow a gradient extends beyond its [0, 1] parameter range.
VectorCompositeBuilderClassGraphics, Materials & Particles › Vector GraphicsA mutable builder for a VectorComposite assembled from programmatic fills — each a path painted with a VectorPaint (a solid color or a gradient).
VectorGradientClassGraphics, Materials & Particles › Vector GraphicsAn immutable gradient paint — a linear or radial color ramp with a VectorComposite.SpreadMode.
VectorGradientBuilderClassGraphics, Materials & Particles › Vector GraphicsA mutable builder for an immutable VectorGradient paint.
VectorPaintClassGraphics, Materials & Particles › Vector GraphicsAn immutable fill paint for VectorCompositeBuilder#addPath — either a flat solid color or a VectorGradient.
VectorPathClassGraphics, Materials & Particles › Vector GraphicsAn immutable 2D path: an ordered list of contours built from straight and curved segments.
VectorPathBuilderClassGraphics, Materials & Particles › Vector GraphicsA mutable builder for an immutable VectorPath.
VectorRendererClassGraphics, Materials & Particles › Vector GraphicsDraws a vector composite into a caller-owned render-target Texture.
VectorStrokeClassGraphics, Materials & Particles › Vector GraphicsAn immutable stroke style — width, line cap, line join, miter limit, and an optional dash pattern.
VectorStrokeBuilderClassGraphics, Materials & Particles › Vector GraphicsA mutable builder for an immutable VectorStroke style.
VectorTextClassGraphics, Materials & Particles › Vector GraphicsAn immutable text run style — content, size, weight, italics, letter spacing, and horizontalAlignment.
VectorTextBuilderClassGraphics, Materials & Particles › Vector GraphicsA mutable builder for an immutable VectorText run.
VertexCacheClassGraphics, Materials & Particles › Meshes & EffectsUsed to help control vertex animations on the SceneObject.
VertexSimulationSettingsClassPhysics › Cloth & Hair › ClothVisualProvides settings for vertex physics in the ClothVisual component.
VerticalAlignmentEnumText & FontsUsed by the verticalAlignment property in MeshVisual.
VerticalOverflowEnumText & FontsOptions for handling vertical text overflow.
VFXAssetClassGraphics, Materials & Particles › Meshes & EffectsDefines a VFX to use with VFXComponent.
VFXComponentClassGraphics, Materials & Particles › Meshes & EffectsRenders VFXAsset in scene.
VideoRecorderClassGraphics, Materials & Particles › Textures & VideoAllows you to record a new texture (i.e video), based on on another texture.
VideoRecorder.OptionsClassGraphics, Materials & Particles › Textures & Video › VideoRecorderConfiguration options for VideoRecorder.
VideoStatusEnumGraphics, Materials & Particles › Textures & VideoDescribes the current status of a VideoTextureProvider.
VideoTextureProviderClassGraphics, Materials & Particles › Textures & VideoControls a video texture resource.
VisualClassGraphics, Materials & Particles › Meshes & EffectsBase class for all visual Components.
VoiceMLNamespaceAudio & Voice › Speech
VoiceML.NlpIntentsModelOptionsNamespaceAudio & Voice › Speech › VoiceML
VoiceML.NlpKeywordModelOptionsNamespaceAudio & Voice › Speech › VoiceML
VoiceMLModuleNamespaceAudio & Voice › Speech
VoiceMLModule.SpeechRecognizerNamespaceAudio & Voice › Speech › VoiceMLModule
WeatherConditionEnumUser & FriendsTypes of weather returned by UserContextSystem's callback.
WebPageTextureProviderClassCloud, Networking & Storage › Web ViewWebPageTextureProvider is the associated texture control that can be accessed from the texture.control property.
WebSocketClassCloud, Networking & Storage › WebSocketsWebSocket provides an API for managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
WebSocketCloseEventClassCloud, Networking & Storage › WebSocketsEvent type for WebSocket close events.
WebSocketEventClassCloud, Networking & Storage › WebSocketsGeneric event type for WebSocket.
WebSocketMessageEventClassCloud, Networking & Storage › WebSocketsEvent type for WebSocket message events.
WebSocketOptionsClassCloud, Networking & Storage › Internet Access › InternetModuleAdditional settings applied when opening a WebSocket connection with InternetModule#createWebSocket.
WebViewOptionsClassCloud, Networking & Storage › Internet Access › InternetModuleWebViewOptions allow you to specify various aspects of the WebView that will be created.
WebViewPolicyClassCloud, Networking & Storage › Web ViewWebViewPolicy allows creators to control what websites are allowed to be loaded in the WebView.
WeightedModeEnumAnimationDifferent coordinate representations for tangent points
widgetFunctionScripting › Decorators
WorldComponentClassPhysics › Bodies & CollidersGroups Physics objects in its subtree into an independent world simulation.
WorldDepthTextureProviderClassAR & Tracking › CameraProvides depth information of the video feed that the Lens is being applied to when available.
WorldOptionsClassAR & Tracking › World › DeviceTrackingHolds settings for world mesh and point cloud tracking in DeviceTracking component.
WorldQueryHitTestResultClassAR & Tracking › World › WorldQueryModuleThe result of the hitTest method call.
WorldQueryModuleClassAR & Tracking › WorldProvides access to various APIs which can perform hit test for real surfaces to sample the depth and normal at a certain location.
WorldRaycastNamespaceAR & Tracking › World
WorldRaycast.hitTestPlanesFunctionAR & Tracking › World › WorldRaycastPerforms a raycast against native AR-tracked planes from a screen position.
WorldRaycast.hitTestWorldMeshFunctionAR & Tracking › World › WorldRaycastPerforms a raycast against world meshes from a screen position.
WorldRaycast.raycastPlanesFunctionAR & Tracking › World › WorldRaycastPerforms a raycast against native AR-tracked planes along a ray from world position from to world position to.
WorldRaycast.raycastWorldMeshFunctionAR & Tracking › World › WorldRaycastPerforms a raycast against world meshes along a ray from world position from to world position to.
WorldRenderObjectProviderClassAR & Tracking › WorldProvider for RenderMesh data representing the estimated shape of real world objects generated from depth information.
WorldTrackingCapabilitiesClassAR & Tracking › WorldProvides information about whether certain world tracking features are supported by the device.
WorldTrackingMeshesAddedEventClassAR & Tracking › WorldTriggered when new world tracking meshes are detected.
WorldTrackingMeshesRemovedEventClassAR & Tracking › WorldTriggered when some world tracking meshes are no longer detected.
WorldTrackingMeshesUpdatedEventClassAR & Tracking › WorldTriggered when world tracking meshes are updated.
WorldTrackingPlanesAddedEventClassAR & Tracking › WorldTriggered when plane(s) are newly detected.
WorldTrackingPlanesRemovedEventClassAR & Tracking › WorldTriggered when plane(s) are no longer detected.
WorldTrackingPlanesUpdatedEventClassAR & Tracking › WorldTriggered when currently detected plane(s) are updated.
WorldTrackingResetEventClassAR & Tracking › WorldIf 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…
WorldUnderstandingModuleClassAR & Tracking › WorldDeclares permissions for your Lens project.
WrapModeEnumGraphics, Materials & Particles › Textures & VideoDescribes how a texture should be sampled when using coordinates outside of the normal range.
ZodiacEnumUser & Friends