Full API List
Every symbol in the Editor Scripting API in one list, with its kind and topic.
Generated from the Lens Studio typings: Lens Studio 5.25.0. 735 symbols.
Topic says where the sidebar lists a symbol. A module's classes and a namespace's nested types sit under it. Use your browser's find to jump to a name.
| Symbol | Kind | Topic | Description |
|---|---|---|---|
| Base64 | Class | Globals & Utilities | Utility class for encoding and decoding data in base64 format. |
| BaseDescriptor | Class | Plugins | Base class for plugin descriptors containing metadata and interface requirements. |
| clearInterval | Function | Globals & Utilities | Remove the interval calls. |
| clearTimeout | Function | Globals & Utilities | Cancels the timeout. |
| console | Class | Globals & Utilities | Output logging utilities for plugin scripts. |
| console.Category | Class | Globals & Utilities › console | Enum-like type for log categories (console.None, console.User). |
| createFunctionObject | Function | Globals & Utilities | Dynamically creates a function object from a string of JavaScript code. |
| Editor | Class | Plugins | Namespace that provides access to the components of Lens Studio. |
| Editor.Ai | Class | AI & Chat Tools | Access AI chat functionality and message history. |
| Editor.Ai.Storage | Class | AI & Chat Tools › Editor.Ai | Manage AI chat history and sessions. |
| Editor.Alignment | Namespace | User Interface | |
| Editor.Alignment.Horizontal | Enum | User Interface › Editor.Alignment | The options for horizontal alignment, for example when using Editor.Components.BaseMeshVisual |
| Editor.Alignment.Vertical | Enum | User Interface › Editor.Alignment | The options for vertical alignment, for example when using Editor.Components.BaseMeshVisual |
| Editor.AnimationClip | Class | Assets | Represents an animation clip instance with playback configuration. |
| Editor.AnimationLayerBlendMode | Enum | Assets | Enum defining how animation layers blend with the base animation. |
| Editor.AnimationLayerScaleMode | Enum | Assets | Defines how animation layer scaling is applied to the base animation. |
| Editor.Assets | Class | Assets | Namespace containing all asset types for Lens Studio projects. |
| Editor.Assets.AnimationAsset | Class | Assets | Represents an animation asset with playback timing information. |
| Editor.Assets.AntialiasingMode | Enum | Assets | The aliasing mode of Editor.Assets.RenderTarget. |
| Editor.Assets.AntialiasingQuality | Enum | Assets | Enum for antialiasing quality levels. |
| Editor.Assets.Asset | Class | Assets | Represents an imported asset with cached file and metadata. |
| Editor.Assets.AssetCompressionSettings | Class | Assets | Base type assigned to AssetImportMetadata.compressionSettings to set how an asset is compressed during import. |
| Editor.Assets.AssetImporterSettings | Class | Assets | Entity subclass representing the structural organization of entities within a scene. |
| Editor.Assets.AudioTrackAsset | Class | Assets | Represents an audio track asset. |
| Editor.Assets.BlendMode | Enum | Assets | The blendmode of a Editor.Assets.PassInfo. |
| Editor.Assets.BodyTracking3DAsset | Class | Assets | 3D body tracking asset with optional hand tracking support. |
| Editor.Assets.ClearColorOption | Enum | Assets | How a Render Target should be cleared every frame Editor.Assets.RenderTarget. |
| Editor.Assets.CullMode | Enum | Assets | Enum that specifies which faces of a mesh to cull during rendering. |
| Editor.Assets.CustomAsset | Class | Assets | An instance of a custom asset type defined by an @asset script. |
| Editor.Assets.CustomCodeNodeAsset | Class | Assets | Asset representing a custom code node in a visual graph. |
| Editor.Assets.CustomVariationStyle | Class | Assets | A user-defined named style on a variable Editor.Assets.Font. |
| Editor.Assets.DepthBufferStrategy | Enum | Assets | The depth buffer strategy of a Editor.Assets.RenderTarget. |
| Editor.Assets.DepthFunction | Enum | Assets | How a Editor.Assets.PassInfo should determine its depth compared to others. |
| Editor.Assets.DeviceCameraTexture | Class | Assets | A native asset that provides the texture from the camera feed. |
| Editor.Assets.DracoCompressionSettings | Class | Assets | Sets Google Draco geometry compression on a mesh asset; assign to AssetImportMetadata.compressionSettings. |
| Editor.Assets.FaceCropTexture | Class | Assets | A native asset that provides a cropped region of the input texture, calculated based on face position. |
| Editor.Assets.FaceMesh | Class | Assets | A native asset that provides a 3D mesh of the user's face. |
| Editor.Assets.FileCompressionSettings | Class | Assets | Base type for file-backed compression strategies, assigned to AssetImportMetadata.compressionSettings to set the compression applied at import. |
| Editor.Assets.FileMesh | Class | Assets | An asset for 3D meshes. |
| Editor.Assets.FileTexture | Class | Assets | An asset for textures. |
| Editor.Assets.FileTexture2DArray | Class | Assets | A 2D texture array asset loaded from file containing multiple 2D texture layers. |
| Editor.Assets.FileTexture3D | Class | Assets | 3D texture asset imported from an external file. |
| Editor.Assets.FileTextureCubemap | Class | Assets | Cubemap texture asset with per-face texture information. |
| Editor.Assets.FileTextureInfo | Class | Assets | Holds texture file dimensions. |
| Editor.Assets.FileTextureInfo3D | Class | Assets | 3D texture file information including depth. |
| Editor.Assets.FilteringMode | Enum | Assets | How a texture should be sampled. |
| Editor.Assets.Font | Class | Assets | Font asset for text rendering. |
| Editor.Assets.FontCollection | Class | Assets | An ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families. |
| Editor.Assets.FontCollectionEntry | Class | Assets | Single entry within a FontCollection, pairing a Font or FontFamily asset with weight and italic style attributes. |
| Editor.Assets.FontFamily | Class | Assets | Groups multiple Font assets into a single family, mapping each to a style (weight + italic). |
| Editor.Assets.FontFamilyEntry | Class | Assets | Maps a single Font asset to a specific style (weight and italic flag) within a FontFamily. |
| Editor.Assets.FrustumCullMode | Enum | Assets | The same entity as in Lens Scripting. |
| Editor.Assets.GaussianSplattingAsset | Class | Assets | Asset containing Gaussian splats for use with GaussianSplattingVisual. |
| Editor.Assets.HairDataAsset | Class | Assets | Native asset providing data for hair rendering. |
| Editor.Assets.HandMesh | Class | Assets | A render mesh that follows a tracked hand. |
| Editor.Assets.HandTracking3DAsset | Class | Assets | 3D hand tracking asset for hand pose and gesture recognition. |
| Editor.Assets.HandTracking3DHandType | Enum | Assets | Used with {Editor.Assets.HandTracking3DAsset}. |
| Editor.Assets.ImageMarker | Class | Assets | A LensScripting.MarkerAsset for use with Editor.Components.MarkerTrackingComponent |
| Editor.Assets.JavaScriptAsset | Class | Assets | A script asset that is written in JavaScript. |
| Editor.Assets.JsonAsset | Class | Assets | Asset wrapping JSON data. |
| Editor.Assets.LicensedAudioTrack | Class | Assets | Licensed audio track asset with metadata and runtime source paths. |
| Editor.Assets.LocationAsset | Class | Assets | Asset representing a named location with an identifier and type. |
| Editor.Assets.LocationMesh | Class | Assets | A native asset that provides data for LensScripting.LocationAsset. |
| Editor.Assets.LocationType | Enum | Assets | Used with {Editor.Assets.Location}. |
| Editor.Assets.MarkdownAsset | Class | Assets | Native asset for markdown content. |
| Editor.Assets.MarkerAsset | Class | Assets | Base asset for marker tracking with configurable height. |
| Editor.Assets.Material | Class | Assets | Material asset defining rendering passes and their properties. |
| Editor.Assets.MeshInfo | Class | Assets | Read-only metadata describing the geometry and rigging of a mesh asset. |
| Editor.Assets.MLAsset | Class | Assets | Machine learning model asset. |
| Editor.Assets.MSAAStrategy | Enum | Assets | Enum for multisample anti-aliasing strategy selection. |
| Editor.Assets.NamedInstanceInfo | Class | Assets | Read-only named axis preset from the font's fvar table, for example "Condensed Bold". |
| Editor.Assets.NativePackageDescriptor | Class | Assets | Metadata descriptor for a native package asset. |
| Editor.Assets.Object3DAsset | Class | Assets | Base asset type for 3D object models. |
| Editor.Assets.ObjectOwner | Class | Assets | Base class for entities which has object and component relationship such as Editor.Assets.Scene and Editor.Assets.ObjectPrefab. |
| Editor.Assets.ObjectPrefab | Class | Assets | Reusable object template that can be instantiated in scenes. |
| Editor.Assets.ObjectTrackingTexture | Class | Assets | A native asset that provides information for object tracking texture. |
| Editor.Assets.ObjectTrackingTextureType | Enum | Assets | Used with Editor.Assets.ObjectTrackingTexture. |
| Editor.Assets.PackagePolicy | Enum | Assets | Enum defining how asset packages can be unpacked and their transparency handling. |
| Editor.Assets.Pass | Class | Assets | Rendering pass asset used within a material. |
| Editor.Assets.PassBinding | Class | Assets | Defines a binding parameter for a render pass with metadata for UI presentation and value constraints. |
| Editor.Assets.PassBindingType | Enum | Assets | Enum defining types of bindings for render passes. |
| Editor.Assets.PassConfiguration | Class | Assets | Plain configuration object describing a Pass asset, blend mode, and shader defines to apply to a PassInfo via setPassConfiguration. |
| Editor.Assets.PassInfo | Class | Assets | The Editor.Assets.Pass on a Editor.Assets.Material. |
| Editor.Assets.PassUiData | Class | Assets | Shader pass UI configuration data. |
| Editor.Assets.PerformanceCompressionSettings | Class | Assets | Sets runtime-performance-tuned texture compression with optional mipmaps; assign to AssetImportMetadata.compressionSettings. |
| Editor.Assets.Physics | Class | Assets | Namespace for physics-related assets and configuration. |
| Editor.Assets.Physics.Filter | Class | Assets › Editor.Assets.Physics | Defines collision filtering rules for physics queries and interactions. |
| Editor.Assets.Physics.LevelsetColliderAsset | Class | Assets › Editor.Assets.Physics | Levelset-based collision shape asset. |
| Editor.Assets.Physics.Matter | Class | Assets › Editor.Assets.Physics | Physics material asset defining bounce and friction properties. |
| Editor.Assets.Physics.WorldSettingsAsset | Class | Assets › Editor.Assets.Physics | Asset configuring global physics simulation settings. |
| Editor.Assets.Physics.WorldSettingsBase | Class | Assets › Editor.Assets.Physics | Base class for physics world settings assets, such as WorldSettingsAsset. |
| Editor.Assets.RemoteAssetMetadata | Class | Assets | |
| Editor.Assets.RemoteAssetOrganization | Class | Assets | |
| Editor.Assets.RemoteAssetResource | Class | Assets | |
| Editor.Assets.RemoteAssetType | Enum | Assets | |
| Editor.Assets.RemoteMLAsset | Class | Assets | ML asset backed by a remote device-dependent resource. |
| Editor.Assets.RemoteReferenceAsset | Class | Assets | Reference to a remote asset identified by an asset ID. |
| Editor.Assets.RenderMesh | Class | Assets | 3D mesh asset for rendering geometry. |
| Editor.Assets.RenderTarget | Class | Assets | A native asset that provides the target for a camera to provide its output to. |
| Editor.Assets.Sampler | Class | Assets | Texture sampling configuration for filtering, mipmapping, and wrapping modes. |
| Editor.Assets.Scene | Class | Assets | The entity which will be converted into the Lens scene during project export. |
| Editor.Assets.ScriptAsset | Class | Assets | Script asset that can be attached to scene objects, containing inputs, attachments, and metadata. |
| Editor.Assets.ScriptInputInfo | Class | Assets | Metadata about a script input parameter. |
| Editor.Assets.ScriptType | Enum | Assets | The kind of script a Editor.Assets.ScriptAsset defines: a component that can be attached to a scene object, a module that other scripts import, or a custom a… |
| Editor.Assets.SegmentationTexture | Class | Assets | A native asset that provides information for segmentation texture. |
| Editor.Assets.SegmentationType | Enum | Assets | Built in segmentation textures to be used with Editor.Assets.SegmentationTexture. |
| Editor.Assets.SetupScript | Class | Assets | Script executed during asset package setup. |
| Editor.Assets.ShaderType | Enum | Assets | Enum of shader type categories. |
| Editor.Assets.SizeCompressionSettings | Class | Assets | Sets size-prioritized texture compression at a configurable quality level; assign to AssetImportMetadata.compressionSettings. |
| Editor.Assets.SnapcodeMarker | Class | Assets | A native asset that can be used with LensScripting.MarkerTrackingComponent Learn more at LensScripting.SnapcodeMarkerProvider. |
| Editor.Assets.SubgraphAsset | Class | Assets | Asset representing a subgraph embeddable in other graphs. |
| Editor.Assets.SupabaseProject | Class | Assets | Supabase project asset with connection credentials. |
| Editor.Assets.Texture | Class | Assets | Base texture asset. |
| Editor.Assets.TextureCompressionLevel | Enum | Assets | Quality preset selecting how aggressively a texture is compressed. |
| Editor.Assets.TextureParameter | Class | Assets | Associates a texture with a sampler for use in a material pass. |
| Editor.Assets.TypeScriptAsset | Class | Assets | TypeScript script asset for Lens Studio plugins. |
| Editor.Assets.VariationAxisInfo | Class | Assets | Read-only metadata describing one OpenType variation axis on a variable font. |
| Editor.Assets.VectorComposite | Class | Assets | Vector graphics asset created by importing an SVG file. |
| Editor.Assets.Version | Class | Assets | Used to set the version of script assets. |
| Editor.Assets.VertexAttribute | Enum | Assets | Used witih Editor.Assets.FaceMesh |
| Editor.Assets.VideoTexture | Class | Assets | Texture asset created by importing a video file. |
| Editor.Assets.WrapMode | Enum | Assets | Options for what value is returned when a fetch falls outside the bounds of a texture. |
| Editor.Axis | Enum | Globals & Utilities | Enum of spatial axes. |
| Editor.Buffer | Class | Files & System | Wraps a byte array for data serialization and deserialization. |
| Editor.Components | Class | Components | Container for all scene component types and related enums. |
| Editor.Components.AnimationPlayer | Class | Components | Component that manages animation playback with clips and autoplay settings. |
| Editor.Components.AudioComponent | Class | Components | Manages audio playback and spatial audio properties for a scene object. |
| Editor.Components.BackgroundSettings | Class | Components | Configures background styling for UI components. |
| Editor.Components.BarycentricVertex | Class | Components | Settings used with Editor.Components.Head to set position on the face. |
| Editor.Components.BaseMeshVisual | Class | Components | Base class for mesh-based visual components. |
| Editor.Components.Camera | Class | Components | Renders the scene from a viewpoint with configurable projection and output. |
| Editor.Components.CameraAspectPreset | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraClearColor | Class | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraClearColor.Mode | Enum | Components › Editor.Components.CameraClearColor | The same entity as in Lens Scripting. |
| Editor.Components.CameraClearDepth | Class | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraClearDepth.Mode | Enum | Components › Editor.Components.CameraClearDepth | The same entity as in Lens Scripting. |
| Editor.Components.CameraDepthBufferMode | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraDeviceProperty | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraOitLayers | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.CameraType | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.Canvas | Class | Components | Manages 2D canvas rendering and layout properties for a scene object. |
| Editor.Components.CapitalizationOverride | Enum | Components | Enum for text capitalization override options. |
| Editor.Components.ClipRangeType | Enum | Components | Enum for specifying clip range units. |
| Editor.Components.ClothVisual | Class | Components | Simulates cloth physics with stretching, bending, and collision interactions. |
| Editor.Components.ClothVisual.BendMode | Enum | Components › Editor.Components.ClothVisual | The same entity as in Lens Scripting. |
| Editor.Components.ClothVisual.VertexBinding | Class | Components › Editor.Components.ClothVisual | The same entity as in Lens Scripting. |
| Editor.Components.Component | Class | Components | Base class for components attached to scene objects. |
| Editor.Components.CompositionLayerComponent | Class | Components | Base class for components attached to scene objects. |
| Editor.Components.CompositionLayerRenderComponent | Class | Components | Base class for components attached to scene objects. |
| Editor.Components.CompositionLayerRenderUpdateMode | Enum | Components | |
| Editor.Components.DeviceTracking | Class | Components | Component that configures device tracking behavior and options. |
| Editor.Components.DeviceTrackingMode | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.DistanceEffectCurveType | Enum | Components | Curve type options for distance-based effects. |
| Editor.Components.DropshadowSettings | Class | Components | Drop shadow settings for text rendering. |
| Editor.Components.EnvmapFromCameraMode | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.ExtrudeDirection | Enum | Components | Settings used with Editor.Components.Text3D. |
| Editor.Components.EyeColorVisual | Class | Components | Visual component for rendering eye color on a face mesh. |
| Editor.Components.EyeToRender | Enum | Components | Settings used with Editor.Components.EyeColorVisual. |
| Editor.Components.FaceInsetRegion | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.FaceInsetVisual | Class | Components | Visual component for rendering an inset region of a face mesh with customizable borders. |
| Editor.Components.FaceMaskVisual | Class | Components | Visual component for rendering face masks with optional mouth and teeth correction. |
| Editor.Components.FaceStretchVisual | Class | Components | Visual component for stretching and deforming face meshes with named features. |
| Editor.Components.FalloffType | Enum | Components | Falloff curve type options for light and effect components. |
| Editor.Components.FontStyles | Class | Components | Standard font style names for the preferredStyle property of Editor.Components.Text and Editor.Components.Text3D. |
| Editor.Components.GaussianSplattingVisual | Class | Components | Renders a Gaussian Splatting asset with optional frame selection for animated content. |
| Editor.Components.HairVisual | Class | Components | Renders and simulates hair with physics, collision, and material properties. |
| Editor.Components.Head | Class | Components | Component that attaches a scene object to a tracked head position. |
| Editor.Components.HeadAttachmentPointType | Enum | Components | Settings used with Editor.Components.Head. |
| Editor.Components.HorizontalOverflow | Enum | Components | Settings used with Editor.Components.Text and Editor.Components.Text3D. |
| Editor.Components.Image | Class | Components | Renders a 2D image with optional flip, pivot, and rotation. |
| Editor.Components.InteractionComponent | Class | Components | Handles touch and interaction detection on 3D meshes. |
| Editor.Components.LightSource | Class | Components | Component controlling light properties, shadows, and environment mapping. |
| Editor.Components.LightType | Enum | Components | Settings used with Editor.Components.LightSource. |
| Editor.Components.LiquifyVisual | Class | Components | Visual component applying liquify distortion to face mesh geometry. |
| Editor.Components.LocatedAtComponent | Class | Components | Pins a scene object to a real-world location asset. |
| Editor.Components.LookAtComponent | Class | Components | Rotates an object to face a target point or direction. |
| Editor.Components.LookAtComponent.AimVectors | Enum | Components › Editor.Components.LookAtComponent | Settings used with Editor.Components.LookAtComponent. |
| Editor.Components.LookAtComponent.LookAtMode | Enum | Components › Editor.Components.LookAtComponent | Settings used with Editor.Components.LookAtComponent. |
| Editor.Components.LookAtComponent.WorldUpVector | Enum | Components › Editor.Components.LookAtComponent | Settings used with Editor.Components.LookAtComponent. |
| Editor.Components.ManipulateComponent | Class | Components | Enables drag, rotate, and scale interactions on a scene object. |
| Editor.Components.MarkerTrackingComponent | Class | Components | Tracks a marker asset for marker-based AR anchoring. |
| Editor.Components.MaskingComponent | Class | Components | Applies a rounded-corner mask to a scene object. |
| Editor.Components.MaterialMeshVisual | Class | Components | Base class for mesh visual components that render with materials. |
| Editor.Components.MeshShadowMode | Enum | Components | The same entity as in Lens Scripting. |
| Editor.Components.ObjectTracking | Class | Components | Tracks 2D objects in the camera feed using ML classification. |
| Editor.Components.ObjectTracking3D | Class | Components | Tracks and matches 3D objects in the scene using pose estimation. |
| Editor.Components.ObjectTracking3D.TrackingMode | Enum | Components › Editor.Components.ObjectTracking3D | Enum specifying how 3D object tracking data is interpreted. |
| Editor.Components.ObjectTrackingType | Enum | Components | Settings used with Editor.Components.ObjectTracking. |
| Editor.Components.OutlineSettings | Class | Components | Settings for outline rendering on a component. |
| Editor.Components.Physics | Class | Components | Namespace containing physics simulation components, shapes, and constraints for rigid bodies and colliders. |
| Editor.Components.Physics.BodyComponent | Class | Components › Editor.Components.Physics | Rigid body physics component for dynamic objects. |
| Editor.Components.Physics.BodySetting | Enum | Components › Editor.Components.Physics | Enum specifying how a physics body's mass is calculated. |
| Editor.Components.Physics.Box | Class | Components › Editor.Components.Physics | Box-shaped physics collider component. |
| Editor.Components.Physics.Capsule | Class | Components › Editor.Components.Physics | A capsule-shaped physics collider. |
| Editor.Components.Physics.ColliderComponent | Class | Components › Editor.Components.Physics | Defines collision geometry and physics properties for an object. |
| Editor.Components.Physics.Cone | Class | Components › Editor.Components.Physics | Cone-shaped physics collider. |
| Editor.Components.Physics.Constraint | Enum | Components › Editor.Components.Physics | Physics constraint types for rigidbody connections. |
| Editor.Components.Physics.ConstraintComponent | Class | Components › Editor.Components.Physics | Component that applies physics constraints to a scene object. |
| Editor.Components.Physics.Cylinder | Class | Components › Editor.Components.Physics | Cylindrical physics shape with configurable axis, length, and radius. |
| Editor.Components.Physics.LevelSet | Class | Components › Editor.Components.Physics | A physics shape using a level set asset for complex collision geometry. |
| Editor.Components.Physics.Mesh | Class | Components › Editor.Components.Physics | Physics mesh shape component for collision detection using custom meshes. |
| Editor.Components.Physics.Shape | Class | Components › Editor.Components.Physics | Base class for physics shapes attached to entities. |
| Editor.Components.Physics.Sphere | Class | Components › Editor.Components.Physics | A spherical physics shape component. |
| Editor.Components.Physics.WorldComponent | Class | Components › Editor.Components.Physics | Physics world container managing simulation and settings. |
| Editor.Components.PinToMesh | Namespace | Components | |
| Editor.Components.PinToMesh.Orientation | Enum | Components › Editor.Components.PinToMesh | Specifies how the pin aligns to the mesh. |
| Editor.Components.PinToMeshComponent | Class | Components | Component that pins a SceneObject to a point on a mesh surface. |
| Editor.Components.PostEffectVisual | Class | Components | Visual component for rendering post-effect materials. |
| Editor.Components.RectangleSetter | Class | Components | Component for setting rectangular regions on textures. |
| Editor.Components.RenderLayerOwner | Class | Components | The render layer which the component will be on. |
| Editor.Components.RenderMeshVisual | Class | Components | Renders a mesh with customizable blend shapes and normals. |
| Editor.Components.RetouchVisual | Class | Components | Visual component for applying retouching effects to faces. |
| Editor.Components.RotationOptions | Class | Components | Configures rotation behavior for entities. |
| Editor.Components.ScreenRegionComponent | Class | Components | Component that defines a rectangular region on screen. |
| Editor.Components.ScreenRegionType | Enum | Components | Used with Editor.Components.ScreenRegionComponent. |
| Editor.Components.ScreenTransform | Class | Components | Component for positioning and scaling UI elements relative to screen dimensions. |
| Editor.Components.ScreenTransformConstraints | Class | Components | Used with Editor.Components.ScreenTransformConstraints. |
| Editor.Components.ScriptComponent | Class | Components | Component that runs a script asset. |
| Editor.Components.ShadowType | Enum | Components | Enum specifying shadow rendering technique for light sources. |
| Editor.Components.Skin | Class | Components | Represents a skeletal rigging component that controls deformation of mesh geometry through bone transformations. |
| Editor.Components.SortingType | Enum | Components | Used with Editor.Components.Canvas. |
| Editor.Components.StretchMode | Enum | Components | Used with Editor.Components.BaseMeshVisual. |
| Editor.Components.StretchPoint | Class | Components | Defines a mesh vertex stretch point for FaceStretchVisual deformation. |
| Editor.Components.SurfaceOptions | Class | Components | Configuration for surface rendering options. |
| Editor.Components.Text | Class | Components | Renders and manages text in the scene with customizable font, size, layout, and visual effects. |
| Editor.Components.Text3D | Class | Components | 3D text rendering component with font, layout, and styling options. |
| Editor.Components.TextAdvancedLayout | Class | Components | Advanced text layout configuration for controlling text appearance and spacing. |
| Editor.Components.TextFill | Class | Components | Configures fill properties for text rendering. |
| Editor.Components.TextFillMode | Enum | Components | Settings used with Editor.Components.Text. |
| Editor.Components.TextFillTileZone | Enum | Components | Specifies the coordinate system for text fill tile positioning. |
| Editor.Components.UnitType | Enum | Components | Settings used with Editor.Components.Canvas. |
| Editor.Components.VerticalOverflow | Enum | Components | Settings used with Editor.Components.Text. |
| Editor.Components.Visual | Class | Components | Base class for visual components that control rendering order and appearance. |
| Editor.Compression | Class | Files & System | Provides compression and decompression utilities. |
| Editor.Compression.GZip | Class | Files & System › Editor.Compression | GZip compression utility for packing and unpacking files. |
| Editor.Compression.Zip | Class | Files & System › Editor.Compression | Module to zip and unzip files. |
| Editor.ContextAction | Class | Plugins | An action in a Editor.IContextActionRegistry. |
| Editor.Dock | Class | User Interface | Container for dock panel management functionality. |
| Editor.Dock.IDockManager | Class | User Interface › Editor.Dock | Manages the states of Lens Studio panels. |
| Editor.GaussianSplatting | Class | Assets | Namespace providing utilities to create and import Gaussian splatting (GSAF) assets from PLY input files. |
| Editor.GaussianSplatting.GaussianSplattingImporterSettings | Class | Assets › Editor.GaussianSplatting | Entity subclass representing the structural organization of entities within a scene. |
| Editor.GaussianSplatting.GsafCreationInfo | Class | Assets › Editor.GaussianSplatting | Read-only metadata returned by createGsafFromPlyFiles describing the bit rate and quantization characteristics of the resulting GSAF asset. |
| Editor.GaussianSplatting.GsafImporterSettings | Class | Assets › Editor.GaussianSplatting | Configuration entity controlling how PLY files are compressed and packed into a GSAF asset by createGsafFromPlyFiles. |
| Editor.GaussianSplatting.GsCompressionProfile | Enum | Assets › Editor.GaussianSplatting | Enum of preset compression profiles consumed by GsafImporterSettings.compressionProfile, trading file size against visual quality. |
| Editor.GaussianSplatting.GsQuatPackingMethod | Enum | Assets › Editor.GaussianSplatting | Enum selecting how splat rotation quaternions are packed when encoding a GSAF asset, consumed by GsafImporterSettings.quatPackingMethod. |
| Editor.Graph | Class | Assets | Utility class for converting between binary and YAML representations of graph files. |
| Editor.IAuthorization | Class | Plugins | Component that allows you to check whether Lens Studio is authorized, as well as get authorization. |
| Editor.Icon | Class | User Interface | An icon to be used in the Editor UI. |
| Editor.IContext | Class | Plugins | Editor context passed to context action callbacks when a right-click menu is triggered. |
| Editor.IContextActionRegistry | Class | Plugins | A registry of Editor.ContextAction which will be shown in a contextual menu (i.e. right click). |
| Editor.IEntityPicker | Class | User Interface | Popup window that allows the user to choose specific objects in the Scene hierarchy, or assets in the Asset Browser. |
| Editor.IGuard | Class | Plugins | Represents ownership of a resource. |
| Editor.IInterface | Class | Plugins | Base interface type for Editor plugin system objects. |
| Editor.InterfaceId | Class | Plugins | Unique identifier for plugin interfaces. |
| Editor.IPackageActions | Class | Plugins | Interface for package-level actions. |
| Editor.IPackageRegistry | Class | Plugins | Interface for package discovery and registration. |
| Editor.IPlugin | Class | Plugins | Interface representing a plugin. |
| Editor.IPluginComponent | Class | Plugins | Interface for plugin component registration. |
| Editor.IRuntimeBundleExporter | Class | Preview & Publishing | Interface for exporting an asset, together with the assets it references, as a runtime bundle file. |
| Editor.Model | Class | Project & Scene | The model object is a core concept in the plugin development environment. |
| Editor.Model.AssetContext | Class | Project & Scene | Context object holding the current asset selection, providing access to selected assets and their paths. |
| Editor.Model.AssetContext.Item | Class | Project & Scene › Editor.Model.AssetContext | Represents a single selected asset entry, pairing an asset reference with its file path. |
| Editor.Model.AssetImportMetadata | Class | Project & Scene | A handle for the metadata of an asset. |
| Editor.Model.AssetImportMetadata.PackageIterate | Enum | Project & Scene › Editor.Model.AssetImportMetadata | Enum controlling whether native package iteration is shallow or deep. |
| Editor.Model.AssetManager | Class | Project & Scene | Manages project assets — creating, importing, finding, and organizing assets within the project. |
| Editor.Model.AssetMeta | Class | Project & Scene | Stores metadata for an asset, including type information and associated properties. |
| Editor.Model.BaseChangesStream | Class | Project & Scene | Base class for streams that track and apply model changes. |
| Editor.Model.DeviceType | Enum | Project & Scene | Enum representing the target device type for a Lens Studio project. |
| Editor.Model.Entity | Class | Project & Scene | An object in the scene, or asset in the Editor.Model.AssetManager |
| Editor.Model.EntityBaseType | Enum | Project & Scene | Enum defining the base types an entity prototype can represent. |
| Editor.Model.EntityPrototypeData | Class | Project & Scene | Defines prototype data for an entity type, including its display metadata and factory function. |
| Editor.Model.EntityStructure | Class | Project & Scene | Entity subclass representing the structural organization of entities within a scene. |
| Editor.Model.ExportOptions | Class | Project & Scene | Options controlling how a model is exported, including dependency handling and packaging policy. |
| Editor.Model.ExternalPackageDependency | Class | Project & Scene | Represents an external package dependency, including its import metadata and version configuration. |
| Editor.Model.FindOption | Enum | Project & Scene | Enum of options controlling model lookup behavior. |
| Editor.Model.IEntityPrototypeRegistry | Class | Project & Scene | Registry for entity prototypes, providing methods to create, query, and register entity types within the Editor model. |
| Editor.Model.IEntityRegistry | Class | Project & Scene | A registry of various entities. |
| Editor.Model.IModel | Class | Project & Scene | Core plugin component interface providing access to the current Lens Studio project and its lifecycle events. |
| Editor.Model.ImportResult | Class | Project & Scene | The result of Editor.Model.AssetManager.importExternalFile and Editor.Model.AssetManager.importExternalFileAsync. |
| Editor.Model.ImportSettings | Class | Project & Scene | Settings object describing how a model import operation was configured. |
| Editor.Model.InspectableMeta | Class | Project & Scene | Metadata for an inspectable object, providing display caption and icon for use in the Editor UI. |
| Editor.Model.InstantiationParams | Class | Project & Scene | Parameters used when instantiating a scene object, including its parent hierarchy. |
| Editor.Model.Layer | Class | Project & Scene | The layers within a Editor.Model.LayerSet. |
| Editor.Model.LayerId | Class | Project & Scene | The id of a Editor.Model.Layer. |
| Editor.Model.Layers | Class | Project & Scene | The layers of a {@Editor.Assets.Scene}. |
| Editor.Model.LayerSet | Class | Project & Scene | Represents an immutable set of scene layers, supporting set operations like union, intersection, and difference. |
| Editor.Model.LensActivationCamera | Enum | Project & Scene | The various cameras which will be activated when this project's Lens turns on. |
| Editor.Model.LensApplicability | Enum | Project & Scene | The various contexts in which this Lens can be used. |
| Editor.Model.LensClientCompatibility | Enum | Project & Scene | Enumerates the client surfaces a Lens can target for distribution. |
| Editor.Model.Meta | Class | Project & Scene | The metadata of an entity. |
| Editor.Model.MetaInfo | Class | Project & Scene | Metadata of the current project's Lens. |
| Editor.Model.ObjectContext | Class | Project & Scene | Context scoped to a set of scene objects, providing access to the current object selection. |
| Editor.Model.PackageOption | Enum | Project & Scene | Enum representing the packaging state of an asset or resource. |
| Editor.Model.Prefabable | Class | Project & Scene | An entity which can be turned into a prefab, such as Editor.Model.SceneObject. |
| Editor.Model.Project | Class | Project & Scene | Represents the open Lens Studio project, providing access to the scene, asset manager, and project settings. |
| Editor.Model.ProjectSaveMode | Enum | Project & Scene | Enum controlling how and when a project is saved. |
| Editor.Model.ResultType | Enum | Project & Scene | How a file should be imported into the project. |
| Editor.Model.SceneObject | Class | Project & Scene | A node in the scene hierarchy, holding components and child scene objects. |
| Editor.Model.SourcePath | Class | Project & Scene | Represents a file path within a Lens Studio project, combining a root-relative path with a source root directory. |
| Editor.Model.SourceRootDirectory | Enum | Project & Scene | Enum identifying the root directory context for resolving source paths within a Lens Studio project. |
| Editor.Model.TransformEntity | Class | Project & Scene | Entity that carries a spatial transform, representing position, rotation, and scale in the scene. |
| Editor.Model.WorldTransformAccessor | Class | Project & Scene | Provides read and write access to an entity's world-space transform. |
| Editor.MyLenses | Class | Networking | Namespace for Lens Studio's My Lenses account integration. |
| Editor.PackageMetadata | Class | Plugins | Metadata information about a package. |
| Editor.Path | Class | Files & System | A path in the filesystem, or Asset Manager. |
| Editor.PlaybackMode | Enum | Assets | Enumeration of animation playback modes. |
| Editor.PluginSystem | Class | Plugins | Provides access to the Lens Studio editor plugins, components, and interfaces |
| Editor.Point | Class | User Interface | Represents a 2D point with x and y coordinates. |
| Editor.Rect | Class | User Interface | Represents a 2D rectangle with position and dimensions. |
| Editor.RuntimeBundleExporter | Class | Preview & Publishing | Lens Studio's built-in implementation of Editor.IRuntimeBundleExporter. |
| Editor.ScopedConnection | Class | Globals & Utilities | Stores event listener connections, automatically cleaned up on scope exit. |
| Editor.Shape | Class | Globals & Utilities | Represents a 2D or 3D shape object. |
| Editor.Size | Class | User Interface | Used with Editor.Assets.RenderTarget. |
| Editor.TargetPlatform | Enum | Plugins | Enum of platforms a Lens Studio plugin or project can target. |
| Editor.Transform | Class | Project & Scene | Represents position, rotation, and scale in 3D space. |
| Editor.Version | Class | Globals & Utilities | Version information for the editor or plugin. |
| global | Namespace | Globals & Utilities | |
| global.secureLocalStorage | Variable | Globals & Utilities › global | Provides access to the plugin's SecureLocalStorage. |
| IPanelPlugin | Class | Plugins | Plugin base class for plugins that contribute a titled UI panel widget to the editor. |
| IPluginDescriptor | Class | Plugins | Descriptor exposing a plugin's id, name, description, dependencies, and exported interfaces. |
| LensStudio:Analytics | Module | Files & System | Provides analytics functionality for logging events from within a Lens. |
| LensStudio:App | Module | Files & System | |
| LensStudio:App.AppState | Enum | Files & System › LensStudio:App | |
| LensStudio:App.env | Variable | Files & System › LensStudio:App | A map containing the PATH and PWD environment variables of the current Lens Studio process. |
| LensStudio:App.executablePath | Variable | Files & System › LensStudio:App | |
| LensStudio:App.onStateChanged | Variable | Files & System › LensStudio:App | Signal emitted with the new AppState whenever the application-wide state of Lens Studio changes. |
| LensStudio:App.state | Function | Files & System › LensStudio:App | Returns the current application-wide state of Lens Studio. |
| LensStudio:App.version | Variable | Files & System › LensStudio:App | The Lens Studio version. |
| LensStudio:AssetInstantiator | Module | Assets | Module providing asset instantiation capabilities for Lens Studio plugins. |
| LensStudio:AssetInstantiator.AssetInstantiator | Class | Assets › LensStudio:AssetInstantiator | Plugin class that manages asset instantiation, initialized with a PluginSystem and optional Descriptor. |
| LensStudio:AssetInstantiator.Descriptor | Class | Assets › LensStudio:AssetInstantiator | Configuration descriptor for the AssetInstantiator plugin, extending BaseDescriptor. |
| LensStudio:AssetLibrary | Module | Assets | |
| LensStudio:AssetLibrary.Asset | Class | Assets › LensStudio:AssetLibrary | A handle for an asset from the Asset Library. |
| LensStudio:AssetLibrary.AssetFilter | Class | Assets › LensStudio:AssetLibrary | A filter used to narrow down an AssetListRequest. |
| LensStudio:AssetLibrary.AssetListRequest | Class | Assets › LensStudio:AssetLibrary | A request object for finding assets in the Asset Library. |
| LensStudio:AssetLibrary.AssetListResponse | Class | Assets › LensStudio:AssetLibrary | A handle returned by the "LensStudio:AssetLibrary".AssetListService. |
| LensStudio:AssetLibrary.AssetListService | Class | Assets › LensStudio:AssetLibrary | A handle to the "LensStudio:AssetLibrary".AssetListService which can provide a list of assets based on the passed in parameters. |
| LensStudio:AssetLibrary.AssetListSuccess | Class | Assets › LensStudio:AssetLibrary | The result of a fetch call by the "LensStudio:AssetLibrary".AssetListService, which provides you a list of matching assets in the Asset Library. |
| LensStudio:AssetLibrary.AssetType | Enum | Assets › LensStudio:AssetLibrary | The types of assets that might be provided by the "LensStudio:AssetLibrary". |
| LensStudio:AssetLibrary.Creator | Class | Assets › LensStudio:AssetLibrary | Information about the creator or author of an Asset Library asset. |
| LensStudio:AssetLibrary.Environment | Enum | Assets › LensStudio:AssetLibrary | The Asset Library environment which assets should be searched within. |
| LensStudio:AssetLibrary.EnvironmentSetting | Class | Assets › LensStudio:AssetLibrary | A configuration object that describes what Asset Library environment should be accessed. |
| LensStudio:AssetLibrary.GetAssetsByIdsRequest | Class | Assets › LensStudio:AssetLibrary | Request object for fetching specific assets by their unique identifiers. |
| LensStudio:AssetLibrary.GetAssetsByIdsResponse | Class | Assets › LensStudio:AssetLibrary | Response returned when fetching assets by IDs, containing matched assets or an error. |
| LensStudio:AssetLibrary.GetAssetsByIdsService | Class | Assets › LensStudio:AssetLibrary | Service interface for submitting get-assets-by-IDs requests. |
| LensStudio:AssetLibrary.IAssetLibraryProvider | Class | Assets › LensStudio:AssetLibrary | A handle that provides access to the AssetLibraryListService. |
| LensStudio:AssetLibrary.LicensedMusic | Class | Assets › LensStudio:AssetLibrary | Provides access to licensed music import functionality for adding music assets to a project. |
| LensStudio:AssetLibrary.MusicAsset | Class | Assets › LensStudio:AssetLibrary | Handle for a music asset from the Asset Library. |
| LensStudio:AssetLibrary.MusicListResponse | Class | Assets › LensStudio:AssetLibrary | Response returned from a music list query, containing either a success result or a service error. |
| LensStudio:AssetLibrary.MusicListService | Class | Assets › LensStudio:AssetLibrary | Service interface for submitting and managing music list requests. |
| LensStudio:AssetLibrary.MusicListSuccess | Class | Assets › LensStudio:AssetLibrary | Successful result of a music list request, containing the returned music assets. |
| LensStudio:AssetLibrary.Pagination | Class | Assets › LensStudio:AssetLibrary | Configuration for the page to be accessed in a "LensStudio:AssetLibrary".AssetFilter. |
| LensStudio:AssetLibrary.Platform | Enum | Assets › LensStudio:AssetLibrary | Enum representing the target platform associated with an asset. |
| LensStudio:AssetLibrary.Resource | Class | Assets › LensStudio:AssetLibrary | The actual resources of an "LensStudio:AssetLibrary".Asset. |
| LensStudio:AssetLibrary.ServiceError | Class | Assets › LensStudio:AssetLibrary | The callback of an errored fetch call by the "LensStudio:AssetLibrary".AssetListService. |
| LensStudio:AssetLibrary.Space | Enum | Assets › LensStudio:AssetLibrary | The Asset Library space which assets should be searched within. |
| LensStudio:AssetLibrary.Subcategory | Class | Assets › LensStudio:AssetLibrary | Tag or classification used to further categorize an asset within its primary asset type. |
| LensStudio:AssetUtils.js | Module | Assets | |
| LensStudio:AssetUtils.js.addDefine | Function | Assets › LensStudio:AssetUtils.js | Add a define to the pass info's defines array. |
| LensStudio:AssetUtils.js.addGraphToMaterial | Function | Assets › LensStudio:AssetUtils.js | Adds a pass to the given material and optionally adds define strings to the pass. |
| LensStudio:AssetUtils.js.createMaterialFromGraph | Function | Assets › LensStudio:AssetUtils.js | Creates a material from a shader graph asset. |
| LensStudio:AssetUtils.js.findAsset | Function | Assets › LensStudio:AssetUtils.js | Finds an asset in the asset manager based on the specified type, name, and optional parent directory. |
| LensStudio:AssetUtils.js.findOrCreateNativeAsset | Function | Assets › LensStudio:AssetUtils.js | Finds or creates a native asset with the specified name. |
| LensStudio:AssetUtils.js.findOrCreateNonNativeAsset | Function | Assets › LensStudio:AssetUtils.js | Finds or creates an asset in the asset manager. |
| LensStudio:AssetUtils.js.findOrCreateObjectTrackingTexture | Function | Assets › LensStudio:AssetUtils.js | Finds or creates an object tracking texture asset. |
| LensStudio:AssetUtils.js.findOrCreateScreenTexture | Function | Assets › LensStudio:AssetUtils.js | Finds or creates a screen texture asset. |
| LensStudio:AssetUtils.js.getResourceFile | Function | Assets › LensStudio:AssetUtils.js | Retrieves the resource file absolute path for the specified asset type. |
| LensStudio:AssetUtils.js.importImageAsTexture | Function | Assets › LensStudio:AssetUtils.js | Imports an image as a texture and sets up its wrap mode. |
| LensStudio:AssetUtils.js.setupSamplerWrapMode | Function | Assets › LensStudio:AssetUtils.js | Set up the wrap mode for a sampler. |
| LensStudio:AssetUtils.js.ShaderGraphType | Enum | Assets › LensStudio:AssetUtils.js | |
| LensStudio:ChatAssistant | Module | AI & Chat Tools | Plugin module providing a chat assistant interface within Lens Studio. |
| LensStudio:ChatTool | Module | AI & Chat Tools | Module providing base classes and interfaces for building AI-invokable ChatTool plugins in Lens Studio. |
| LensStudio:ChatTool.ChatTool | Class | AI & Chat Tools › LensStudio:ChatTool | Base class for AI-invokable operations; extend this to implement a tool that the AI can call via execute(). |
| LensStudio:ChatTool.Descriptor | Class | AI & Chat Tools › LensStudio:ChatTool | Defines a ChatTool's identity and metadata, including id, name, description, and dependencies. |
| LensStudio:ChatTool.IChatToolRegistry | Class | AI & Chat Tools › LensStudio:ChatTool | Interface for registering and discovering ChatTool instances within the plugin system. |
| LensStudio:ChatTool.Parameters | Class | AI & Chat Tools › LensStudio:ChatTool | Holds the input parameters passed to a ChatTool's execute() call. |
| LensStudio:ChatTool.Result | Class | AI & Chat Tools › LensStudio:ChatTool | Holds the outcome of a ChatTool execution, with data on success or an error string on failure. |
| LensStudio:CladAssistant | Module | AI & Chat Tools | |
| LensStudio:Clipboard | Module | Files & System | Module providing clipboard read/write access for Lens Studio Editor. |
| LensStudio:Clipboard.Clipboard | Class | Files & System › LensStudio:Clipboard | Represents the system clipboard, exposing methods to get and set clipboard content. |
| LensStudio:ConnectedLensMonitor | Module | Preview & Publishing | |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorMessage | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorSession | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | Base class for all script-accessible Lens Studio objects. |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorSnapshot | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | Base class for all script-accessible Lens Studio objects. |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorStore | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorStoreValue | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | |
| LensStudio:ConnectedLensMonitor.ConnectedLensMonitorUser | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | |
| LensStudio:ConnectedLensMonitor.IConnectedLensMonitor | Class | Preview & Publishing › LensStudio:ConnectedLensMonitor | Interface for plugin component registration. |
| LensStudio:CoreService | Module | Plugins | Base class and module for creating background plugin services in Lens Studio. |
| LensStudio:CoreService.CoreService | Class | Plugins › LensStudio:CoreService | Base class for background plugin services; extend to create a service with start/stop lifecycle and access to the plugin system. |
| LensStudio:CoreService.Descriptor | Class | Plugins › LensStudio:CoreService | Defines a service's identity, name, description, and dependencies for registration with the plugin system. |
| LensStudio:Crypto | Module | Files & System | Cryptography module providing secure random value generation, UUIDs, and digest operations modeled after the Web Crypto API. |
| LensStudio:Crypto.getRandomValues | Function | Files & System › LensStudio:Crypto | Fills the given typed array with cryptographically strong random values and returns it. |
| LensStudio:Crypto.randomUUID | Function | Files & System › LensStudio:Crypto | Generates a cryptographically random version 4 UUID string. |
| LensStudio:Crypto.subtle | Class | Files & System › LensStudio:Crypto | Lower-level cryptographic primitives mirroring the Web Crypto SubtleCrypto interface. |
| LensStudio:DeviceSettings | Module | Preview & Publishing | |
| LensStudio:DeviceTracing | Module | Preview & Publishing | |
| LensStudio:DeviceTracing.IProfilingCapture | Class | Preview & Publishing › LensStudio:DeviceTracing | Interface for plugin component registration. |
| LensStudio:DeviceTracing.ITraceSession | Class | Preview & Publishing › LensStudio:DeviceTracing | Base class for all script-accessible Lens Studio objects. |
| LensStudio:DialogPlugin | Module | Plugins | Module providing base classes for building dialog-style plugins in Lens Studio. |
| LensStudio:DialogPlugin.Descriptor | Class | Plugins › LensStudio:DialogPlugin | Configuration descriptor for a DialogPlugin, including menu placement and optional toolbar settings. |
| LensStudio:DialogPlugin.DialogPlugin | Class | Plugins › LensStudio:DialogPlugin | Base class for dialog plugins; extend to implement custom dialogs with a createWidget method. |
| LensStudio:EditorPlugin | Module | Plugins | Module providing base classes for building editor plugins that integrate custom editing behavior into Lens Studio. |
| LensStudio:EditorPlugin.Descriptor | Class | Plugins › LensStudio:EditorPlugin | Descriptor for an editor plugin, extending EditorDescriptor with a canEdit predicate to determine which entities the plugin handles. |
| LensStudio:EditorPlugin.EditorPlugin | Class | Plugins › LensStudio:EditorPlugin | Base class for editor plugins, constructed with a PluginSystem and optional Descriptor to integrate custom editing logic. |
| LensStudio:EntityGenerator | Module | Project & Scene | Module for generating entities within Lens Studio projects. |
| LensStudio:EntityGenerator.Descriptor | Class | Project & Scene › LensStudio:EntityGenerator | Configuration descriptor for an entity generator, specifying entity type and icon. |
| LensStudio:EntityGenerator.EntityGenerator | Class | Project & Scene › LensStudio:EntityGenerator | Constructs a new entity generator plugin with an optional descriptor. |
| LensStudio:Event.js | Module | Globals & Utilities | |
| LensStudio:Event.js.Event | Class | Globals & Utilities › LensStudio:Event.js | A type-safe event emitter that supports adding, removing, and triggering listeners. |
| LensStudio:Event.js.EventListener | Type alias | Globals & Utilities › LensStudio:Event.js | A function that handles event notifications. |
| LensStudio:Event.js.Unsubscribe | Type alias | Globals & Utilities › LensStudio:Event.js | A function that unsubscribes a listener from an event when called. |
| LensStudio:FileSystem | Module | Files & System | Before using anything in this namespace, make sure to import LensStudio:FileSystem and add filesystem in your plugin's module.json. |
| LensStudio:FileSystem.copyDir | Function | Files & System › LensStudio:FileSystem | Options can take recursive and force. |
| LensStudio:FileSystem.CopyDirOptions | Class | Files & System › LensStudio:FileSystem | Used with "LensStudio:FileSystem".CopyDirOptions. |
| LensStudio:FileSystem.copyFile | Function | Files & System › LensStudio:FileSystem | Copies a file from src to dest. |
| LensStudio:FileSystem.createDir | Function | Files & System › LensStudio:FileSystem | Create a directory at path. |
| LensStudio:FileSystem.CreateDirOptions | Class | Files & System › LensStudio:FileSystem | Used with "LensStudio:FileSystem".CreateDirOptions. |
| LensStudio:FileSystem.exists | Function | Files & System › LensStudio:FileSystem | Checks if a file or directory exists at path. |
| LensStudio:FileSystem.isDirectory | Function | Files & System › LensStudio:FileSystem | Checks whether a path is a directory. |
| LensStudio:FileSystem.isFile | Function | Files & System › LensStudio:FileSystem | Checks whether a path is a file. |
| LensStudio:FileSystem.readBytes | Function | Files & System › LensStudio:FileSystem | Returns the content of path as bytes. |
| LensStudio:FileSystem.readDir | Function | Files & System › LensStudio:FileSystem | Returns an array of paths relative to the specified one. |
| LensStudio:FileSystem.ReadDirOptions | Class | Files & System › LensStudio:FileSystem | Used with "LensStudio:FileSystem".ReadDirOptions. |
| LensStudio:FileSystem.readFile | Function | Files & System › LensStudio:FileSystem | Returns the content of path. |
| LensStudio:FileSystem.realPath | Function | Files & System › LensStudio:FileSystem | Resolves a path to its canonical absolute form, following symlinks. |
| LensStudio:FileSystem.remove | Function | Files & System › LensStudio:FileSystem | Removes the path. |
| LensStudio:FileSystem.rename | Function | Files & System › LensStudio:FileSystem | Renames the path. |
| LensStudio:FileSystem.size | Function | Files & System › LensStudio:FileSystem | Get the size of path. |
| LensStudio:FileSystem.TempDir | Class | Files & System › LensStudio:FileSystem | Helper to create temporary directory. |
| LensStudio:FileSystem.Watcher | Class | Files & System › LensStudio:FileSystem | Watches a file or directory for changes and emits events when modifications occur. |
| LensStudio:FileSystem.writeFile | Function | Files & System › LensStudio:FileSystem | Writes a file to path given the data. |
| LensStudio:GeneralUtils.js | Module | Globals & Utilities | |
| LensStudio:GeneralUtils.js.promisify | Function | Globals & Utilities › LensStudio:GeneralUtils.js | Converts a callback-based function to a Promise-based function. |
| LensStudio:GuiService | Module | Plugins | Module providing GUI service plugin infrastructure for Lens Studio. |
| LensStudio:GuiService.Descriptor | Class | Plugins › LensStudio:GuiService | Descriptor object for configuring a GuiService plugin instance. |
| LensStudio:GuiService.GuiService | Class | Plugins › LensStudio:GuiService | Plugin class managing GUI service registration and initialization within the editor plugin system. |
| LensStudio:HierarchyUtils.js | Module | Project & Scene | |
| LensStudio:HierarchyUtils.js.CreateOptions | Interface | Project & Scene › LensStudio:HierarchyUtils.js | Represents the options for creating a scene object. |
| LensStudio:HierarchyUtils.js.createOrthoCameraOnObject | Function | Project & Scene › LensStudio:HierarchyUtils.js | Creates an orthographic camera component on a scene object. |
| LensStudio:HierarchyUtils.js.createPerspectiveCameraOnObject | Function | Project & Scene › LensStudio:HierarchyUtils.js | Creates a perspective camera on the specified scene object. |
| LensStudio:HierarchyUtils.js.findInAncestorsByName | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds a scene object with the specified name in the ancestors of the given base scene object. |
| LensStudio:HierarchyUtils.js.findInAncestorsByType | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds a scene object or an array of scene objects in the ancestors of a given base scene object by the specified component type. |
| LensStudio:HierarchyUtils.js.findInDescendantsByName | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds a scene object or an array of scene objects in the descendants of a base scene object by name. |
| LensStudio:HierarchyUtils.js.findInDescendantsByType | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds a scene object or an array of scene objects within the descendants of a base scene object, based on the specified component type. |
| LensStudio:HierarchyUtils.js.findInRootObjectsByName | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds a scene object or an array of scene objects in the root objects of a scene by name. |
| LensStudio:HierarchyUtils.js.findInRootObjectsByType | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds objects of a specific component type in the root of a scene. |
| LensStudio:HierarchyUtils.js.findNearestCameraInAncestors | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds the nearest camera in the ancestors of the given scene object. |
| LensStudio:HierarchyUtils.js.findOrCreateCameraObject | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds or creates a camera object of the specified type within the given scene. |
| LensStudio:HierarchyUtils.js.findOrCreateChildWithName | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds or creates a child scene object with the specified name under the given root object. |
| LensStudio:HierarchyUtils.js.findOrCreateOrthoCameraForObject | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds or creates an orthographic camera for a given scene object. |
| LensStudio:HierarchyUtils.js.getFirstCameraInScene | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds the first camera in the scene. |
| LensStudio:HierarchyUtils.js.getNearestOrFirstCamera | Function | Project & Scene › LensStudio:HierarchyUtils.js | Finds the nearest camera ancestor of a scene object, if one exists. |
| LensStudio:HierarchyUtils.js.getOrCreateCanvas | Function | Project & Scene › LensStudio:HierarchyUtils.js | Retrieves or creates a canvas component for a given camera object. |
| LensStudio:HierarchyUtils.js.getOrCreateScreenRegion | Function | Project & Scene › LensStudio:HierarchyUtils.js | Retrieves or creates a ScreenRegionComponent for a given camera object and scene. |
| LensStudio:HierarchyUtils.js.SearchOptions | Interface | Project & Scene › LensStudio:HierarchyUtils.js | Represents the options for searching. |
| LensStudio:LcaUtils.js | Module | Networking | |
| LensStudio:LcaUtils.js.attachLCAHeader | Function | Networking › LensStudio:LcaUtils.js | Adds LCA token to Http Request |
| LensStudio:LensBasedEditorView | Module | User Interface | Module providing a live lens preview widget for use inside panel plugins. |
| LensStudio:LensPreview | Module | Preview & Publishing | Module providing LensPreview, a headless preview that renders the open project's Lens without a panel or widgets. |
| LensStudio:LensPreview.LensPreview | Class | Preview & Publishing › LensStudio:LensPreview | Headless preview that renders the project open in Lens Studio without a panel or widgets. |
| LensStudio:LensPreview.LensPreviewOptions | Class | Preview & Publishing › LensStudio:LensPreview | Options passed to the LensPreview constructor. |
| LensStudio:Logger | Module | Files & System | Module providing log collection and monitoring functionality for Lens Studio plugins. |
| LensStudio:Logger.IUserLogCollector | Class | Files & System › LensStudio:Logger | Plugin component interface for collecting and exposing user log data. |
| LensStudio:Mcp | Module | AI & Chat Tools | Model Context Protocol module exposing the in-editor MCP server interface for plugin integrations. |
| LensStudio:Mcp.IMcpServer | Class | AI & Chat Tools › LensStudio:Mcp | Plugin component interface for the editor MCP server, exposing connection details and runtime status. |
| LensStudio:ModelUi | Module | User Interface | |
| LensStudio:ModelUi.EntityReferencePickerLine | Class | User Interface › LensStudio:ModelUi | Line edit widget for picking entity references by type, backed by an asset manager and entity prototype registry. |
| LensStudio:MultimediaWidgets | Module | User Interface | Module providing multimedia playback widgets, including media player controls for use in Lens Studio editor UI. |
| LensStudio:Network | Module | Networking | Before using anything in this namespace, make sure to import LensStudio:Network and add network in your plugin's module.json. |
| LensStudio:Network.Address | Class | Networking › LensStudio:Network | A TCP Server address. |
| LensStudio:Network.BaseServer | Class | Networking › LensStudio:Network | Base class for network servers, providing common listen and connection management functionality. |
| LensStudio:Network.BaseSocket | Class | Networking › LensStudio:Network | Base class for network sockets, providing common send and event handling functionality. |
| LensStudio:Network.FormData | Class | Networking › LensStudio:Network | Holds key-value pairs and file attachments for encoding multipart HTTP request bodies. |
| LensStudio:Network.HttpReply | Class | Networking › LensStudio:Network | Handle to an in-progress HTTP request returned by performHttpRequestWithReply; must be retained to keep the connection alive. |
| LensStudio:Network.HttpRequest | Class | Networking › LensStudio:Network | A HTTP Request configuration. |
| LensStudio:Network.HttpRequest.Method | Enum | Networking › LensStudio:Network | The method in which to send the HTTP request. |
| LensStudio:Network.HttpResponse | Class | Networking › LensStudio:Network | An HTTP response, received from the callback to performing a request, such as through: "LensStudio:Network".performHttpRequestWithReply, or "LensStudio:Remot… |
| LensStudio:Network.performAuthorizedHttpRequest | Function | Networking › LensStudio:Network | Calls a HTTPS endpoint with authorization to Snapchat. |
| LensStudio:Network.performHttpRequest | Function | Networking › LensStudio:Network | Calls a HTTP endpoint. |
| LensStudio:Network.performHttpRequestWithReply | Function | Networking › LensStudio:Network | Request an HTTP call with reply. |
| LensStudio:Network.TcpServer | Class | Networking › LensStudio:Network | A class to accept TCP connetions. |
| LensStudio:Network.TcpSocket | Class | Networking › LensStudio:Network | TCP socket for use with "LensStudio:Network".TcpSocket. |
| LensStudio:PanelPlugin | Module | Plugins | Module providing base classes for creating panel-based plugins in Lens Studio. |
| LensStudio:PanelPlugin.Descriptor | Class | Plugins › LensStudio:PanelPlugin | Configuration descriptor for a PanelPlugin, holding metadata such as id, name, description, and dependencies. |
| LensStudio:PanelPlugin.EditorDescriptor | Class | Plugins › LensStudio:PanelPlugin | Base descriptor class for editor plugins, extended by panel and editor plugin descriptor types. |
| LensStudio:PanelPlugin.PanelDescriptor | Class | Plugins › LensStudio:PanelPlugin | Descriptor subclass specific to panel plugins, used to register a panel with the editor plugin system. |
| LensStudio:PanelPlugin.PanelPlugin | Class | Plugins › LensStudio:PanelPlugin | Base class for plugins that create persistent UI panels; extend this and implement createWidget() to build panel UI. |
| LensStudio:PluginVerifier | Module | Plugins | Module providing base classes for writing plugin verifiers that validate plugin behavior in Lens Studio. |
| LensStudio:PluginVerifier.Descriptor | Class | Plugins › LensStudio:PluginVerifier | Metadata descriptor for a plugin verifier, including identity fields and a canVerify predicate that selects which plugins to test. |
| LensStudio:PluginVerifier.PluginVerifier | Class | Plugins › LensStudio:PluginVerifier | Base class for plugin verifiers; extend this to implement a verify() method that tests plugin functionality against the editor. |
| LensStudio:Preset | Module | Plugins | Module providing the base Preset class and Descriptor for creating editor presets that add objects, assets, or components to a Lens Studio scene. |
| LensStudio:Preset.Descriptor | Class | Plugins › LensStudio:Preset | Descriptor subclass for presets, extending BaseDescriptor with preset-specific metadata such as import paths and section. |
| LensStudio:Preset.Preset | Class | Plugins › LensStudio:Preset | Base preset class to extend when defining a plugin that creates scene objects, assets, or components; requires a static descriptor() and an async createAsync… |
| LensStudio:Preview | Module | Preview & Publishing | Module providing preview functionality for Lens Studio. |
| LensStudio:Preview.allImages | Function | Preview & Publishing › LensStudio:Preview | Returns a promise that resolves to Input values for the sample images bundled with Lens Studio, each with the Multimedia stream type. |
| LensStudio:Preview.allScenes | Function | Preview & Publishing › LensStudio:Preview | Returns a promise that resolves to Input values for the interactive sample scenes bundled with Lens Studio, each with the Interactive stream type. |
| LensStudio:Preview.allVideos | Function | Preview & Publishing › LensStudio:Preview | Returns a promise that resolves to Input values for the sample videos bundled with Lens Studio, each with the Multimedia stream type. |
| LensStudio:Preview.AssetNotReady | Class | Preview & Publishing › LensStudio:Preview | Pause reason reported when some assets are not ready or a script failed to compile. |
| LensStudio:Preview.CameraView | Enum | Preview & Publishing › LensStudio:Preview | Enum selecting which device camera the preview simulates. |
| LensStudio:Preview.Config | Class | Preview & Publishing › LensStudio:Preview | Preview input configuration: input source, camera view, simulated device, and input upscale. |
| LensStudio:Preview.DoubleTap | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.Gesture | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.GestureState | Enum | Preview & Publishing › LensStudio:Preview | |
| LensStudio:Preview.Hover | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.Image | Class | Preview & Publishing › LensStudio:Preview | Frame captured from a preview by screenshot() or tryScreenshot(). |
| LensStudio:Preview.Input | Class | Preview & Publishing › LensStudio:Preview | Preview input source, made of a source path and a stream type. |
| LensStudio:Preview.InspectionSession | Class | Preview & Publishing › LensStudio:Preview | Handle to the Lens's runtime scene during preview inspection, returned by startInspection(). |
| LensStudio:Preview.InvalidAssetConfiguration | Class | Preview & Publishing › LensStudio:Preview | |
| LensStudio:Preview.IPreviewProfiling | Class | Preview & Publishing › LensStudio:Preview | Records performance traces of a preview. |
| LensStudio:Preview.Pan | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.PausedByUser | Class | Preview & Publishing › LensStudio:Preview | Pause reason reported when the creator pauses the Preview panel or switches it to a paused or inspected stream. |
| LensStudio:Preview.Pinch | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.RenderFailed | Class | Preview & Publishing › LensStudio:Preview | Pause reason reported when rendering fails several times in a row. |
| LensStudio:Preview.StreamType | Class | Preview & Publishing › LensStudio:Preview | Enum representing the type of preview stream. |
| LensStudio:Preview.Suspended | Class | Preview & Publishing › LensStudio:Preview | Pause reason reported while a preview is suspended, for example after LensPreview.pause(). |
| LensStudio:Preview.Tap | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.Touch | Class | Preview & Publishing › LensStudio:Preview | Base class for all script-accessible Lens Studio objects. |
| LensStudio:Preview.TraceSession | Class | Preview & Publishing › LensStudio:Preview | Performance trace being recorded, returned by IPreviewProfiling.startTrace(). |
| LensStudio:Preview.Video | Class | Preview & Publishing › LensStudio:Preview | MP4 video recorded from a preview by recordVideo(). |
| LensStudio:PreviewSimulator | Module | Preview & Publishing | |
| LensStudio:ProjectSettingsPlugin | Module | Plugins | Module for registering and managing project settings panels in Lens Studio. |
| LensStudio:ProjectSettingsPlugin.Descriptor | Class | Plugins › LensStudio:ProjectSettingsPlugin | Configuration descriptor for a project settings plugin, holding the section and title used to register the panel. |
| LensStudio:ProjectSettingsPlugin.ProjectSettingsPlugin | Class | Plugins › LensStudio:ProjectSettingsPlugin | Constructs a project settings plugin bound to the given plugin system and optional descriptor. |
| LensStudio:PushToDevice | Module | Preview & Publishing | Plugin component for pushing lens effects and configurations to physical devices. |
| LensStudio:RemoteMediaModule.js | Module | Networking | |
| LensStudio:RemoteMediaModule.js.RemoteMediaModule | Class | Networking › LensStudio:RemoteMediaModule.js | Static utility class for loading various types of media from URLs. |
| LensStudio:RemoteServiceModule | Module | Networking | Class for interacting with Snap's RemoteServiceModule. |
| LensStudio:RemoteServiceModule.performApiRequest | Function | Networking › LensStudio:RemoteServiceModule | Perform the API request. |
| LensStudio:RemoteServiceModule.RemoteApiRequest | Class | Networking › LensStudio:RemoteServiceModule | Configuration for request through "LensStudio:RemoteServiceModule".performApiRequest |
| LensStudio:RemoteServiceModule.RemoteApiResponse | Class | Networking › LensStudio:RemoteServiceModule | Response object from RemoteServiceModule API requests. |
| LensStudio:RemoteServiceModule.RemoteApiResponse.LinkedResource | Class | Networking › LensStudio:RemoteServiceModule | Represents a resource linked to the API response. |
| LensStudio:ScopedStorage.js | Module | Files & System | |
| LensStudio:ScopedStorage.js.IStorage | Interface | Files & System › LensStudio:ScopedStorage.js | Interface for safe file system operations within a specified directory |
| LensStudio:ScopedStorage.js.ScopedStorage | Class | Files & System › LensStudio:ScopedStorage.js | Provides safe file system operations within a specified directory. |
| LensStudio:ScriptEditor | Module | User Interface | Module for script editing capabilities in Lens Studio. |
| LensStudio:ScriptEditor.Definitions | Class | User Interface › LensStudio:ScriptEditor | Provides definitions and paths for script editor functionality. |
| LensStudio:Serialization | Module | Files & System | |
| LensStudio:Serialization.IReader | Class | Files & System › LensStudio:Serialization | Interface for reading serialized data. |
| LensStudio:Serialization.IWriter | Class | Files & System › LensStudio:Serialization | Interface for writing serializable data. |
| LensStudio:Serialization.Yaml | Class | Files & System › LensStudio:Serialization | Class which allows you to serialize and deserialize data from YAML. |
| LensStudio:ShaderCapture | Module | Preview & Publishing | |
| LensStudio:Shell | Module | Files & System | |
| LensStudio:Shell.openUrl | Function | Files & System › LensStudio:Shell | Open a URL with optional query parameters in the default browser. |
| LensStudio:Shell.showItemInFolder | Function | Files & System › LensStudio:Shell | Reveal a file or folder in the system file explorer. |
| LensStudio:Spk | Module | Preview & Publishing | Toolkit for packaging and distributing Lens Studio projects. |
| LensStudio:Subprocess | Module | Files & System | Before using anything in this namespace, make sure to import LensStudio:Subprocess and add subprocess in your plugin's module.json. |
| LensStudio:Subprocess.ExitStatus | Enum | Files & System › LensStudio:Subprocess | The exit status of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync. |
| LensStudio:Subprocess.ProcessError | Enum | Files & System › LensStudio:Subprocess | The process error of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync. |
| LensStudio:Subprocess.ProcessState | Enum | Files & System › LensStudio:Subprocess | The process state of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync. |
| LensStudio:Subprocess.spawn | Function | Files & System › LensStudio:Subprocess | the options parameter can take cwd and timeout, meaning the current working directory to launch the program in, as well as the milliseconds to wait for a syn… |
| LensStudio:Subprocess.SpawnOptions | Class | Files & System › LensStudio:Subprocess | The options of "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync. |
| LensStudio:Subprocess.spawnSync | Function | Files & System › LensStudio:Subprocess | the options parameter can take cwd and timeout, meaning the current working directory to launch the program in, as well as the milliseconds to wait for a syn… |
| LensStudio:Subprocess.SpawnSyncResult | Class | Files & System › LensStudio:Subprocess | The result of "LensStudio:Subprocess".spawnSync. |
| LensStudio:Subprocess.Subprocess | Class | Files & System › LensStudio:Subprocess | Class which allows you to trigger a subproccess outside of Lens Studio (e.g. a command line command). |
| LensStudio:Subprocess.Writable | Class | Files & System › LensStudio:Subprocess | Stream interface for writing to subprocess stdin. |
| LensStudio:SysInfo | Module | Files & System | Provides system information for Lens Studio. |
| LensStudio:SysInfo.buildCpuArchitecture | Variable | Files & System › LensStudio:SysInfo | |
| LensStudio:SysInfo.productType | Variable | Files & System › LensStudio:SysInfo | String identifier for the product type. |
| LensStudio:TypeScript | Module | Files & System | Module exposing the editor TypeScript compilation API for triggering and inspecting project compilations. |
| LensStudio:TypeScript.ITypeScriptCompilationApi | Class | Files & System › LensStudio:TypeScript | Plugin component interface for invoking TypeScript compilation on the current project or an isolated tsconfig. |
| LensStudio:TypeScript.TypeScriptCompilationResult | Class | Files & System › LensStudio:TypeScript | Result of a TypeScript compilation run, containing success status and any reported errors. |
| LensStudio:Ui | Module | User Interface | |
| LensStudio:Ui.AbstractButton | Class | User Interface › LensStudio:Ui | Base class for button widgets with icon and state support. |
| LensStudio:Ui.AbstractItemView | Class | User Interface › LensStudio:Ui | Base widget class for views that display a hierarchical or tabular model, such as lists, tables, and trees. |
| LensStudio:Ui.AbstractMenu | Class | User Interface › LensStudio:Ui | Base class for menu widgets. |
| LensStudio:Ui.Action | Class | User Interface › LensStudio:Ui | Represents an action that can be triggered in the UI. |
| LensStudio:Ui.Alignment | Enum | User Interface › LensStudio:Ui | Enum specifying text or widget alignment. |
| LensStudio:Ui.ArrowPosition | Enum | User Interface › LensStudio:Ui | Enum specifying arrow position for callouts. |
| LensStudio:Ui.AspectRatioMode | Enum | User Interface › LensStudio:Ui | Enum controlling aspect ratio scaling behavior. |
| LensStudio:Ui.BackgroundRole | Enum | User Interface › LensStudio:Ui | Enum specifying background color role. |
| LensStudio:Ui.BoxLayout | Class | User Interface › LensStudio:Ui | Layout manager arranging widgets in a row or column. |
| LensStudio:Ui.CalloutFrame | Class | User Interface › LensStudio:Ui | Widget displaying a callout or tooltip with optional arrow. |
| LensStudio:Ui.CheckBox | Class | User Interface › LensStudio:Ui | Widget for toggling a boolean state. |
| LensStudio:Ui.CheckState | Enum | User Interface › LensStudio:Ui | Enum representing checkbox state. |
| LensStudio:Ui.ClearLayoutBehavior | Enum | User Interface › LensStudio:Ui | Enum controlling layout clearing behavior. |
| LensStudio:Ui.ClickableLabel | Class | User Interface › LensStudio:Ui | Label widget that responds to mouse clicks. |
| LensStudio:Ui.CloseEvent | Class | User Interface › LensStudio:Ui | Event triggered when a window or dialog closes. |
| LensStudio:Ui.CollapsiblePanel | Class | User Interface › LensStudio:Ui | Widget panel that can be expanded or collapsed. |
| LensStudio:Ui.Color | Class | User Interface › LensStudio:Ui | Represents an RGBA color value. |
| LensStudio:Ui.ColorButton | Class | User Interface › LensStudio:Ui | Button for selecting or displaying a color. |
| LensStudio:Ui.ColorGroup | Enum | User Interface › LensStudio:Ui | Enum specifying color group role. |
| LensStudio:Ui.ColorRole | Enum | User Interface › LensStudio:Ui | Enum specifying color role for styling. |
| LensStudio:Ui.ColorScheme | Class | User Interface › LensStudio:Ui | |
| LensStudio:Ui.ComboBox | Class | User Interface › LensStudio:Ui | Dropdown widget for selecting from a list of options. |
| LensStudio:Ui.ContextMenuPolicy | Enum | User Interface › LensStudio:Ui | Enum controlling context menu behavior. |
| LensStudio:Ui.CursorShape | Enum | User Interface › LensStudio:Ui | Enum specifying mouse cursor shape. |
| LensStudio:Ui.Dialog | Class | User Interface › LensStudio:Ui | Modal or modeless dialog window. |
| LensStudio:Ui.Dialog.Code | Enum | User Interface › LensStudio:Ui | Enum of dialog result codes (Accepted, Rejected). |
| LensStudio:Ui.Dialogs | Namespace | User Interface › LensStudio:Ui | |
| LensStudio:Ui.Dialogs.Options | Enum | User Interface › LensStudio:Ui | Options for file dialog behavior: Usual for standard selection or DirectoriesOnly to restrict to directories. |
| LensStudio:Ui.Dialogs.Params | Class | User Interface › LensStudio:Ui | Configuration parameters for file dialogs including caption, file filter, and display options. |
| LensStudio:Ui.Direction | Enum | User Interface › LensStudio:Ui | Enum for layout direction in box layouts. |
| LensStudio:Ui.DockState | Enum | User Interface › LensStudio:Ui | Enum representing dock widget state. |
| LensStudio:Ui.DoubleSpinBox | Class | User Interface › LensStudio:Ui | Widget for entering floating-point numbers. |
| LensStudio:Ui.EditorsManager | Class | User Interface › LensStudio:Ui | Manages text and code editors. |
| LensStudio:Ui.Event | Class | User Interface › LensStudio:Ui | Base class for UI input events that can be accepted or ignored by handlers. |
| LensStudio:Ui.FontRole | Enum | User Interface › LensStudio:Ui | Enum specifying font role for styling. |
| LensStudio:Ui.ForegroundRole | Enum | User Interface › LensStudio:Ui | Enum specifying foreground color role. |
| LensStudio:Ui.getUrlString | Function | User Interface › LensStudio:Ui | Retrieve a URL string representation. |
| LensStudio:Ui.GridLayout | Class | User Interface › LensStudio:Ui | Arranges child layouts and widgets in a grid with rows and columns. |
| LensStudio:Ui.Gui | Class | User Interface › LensStudio:Ui | Built-in interface for GUI operations in plugins. |
| LensStudio:Ui.IconMode | Enum | User Interface › LensStudio:Ui | Enum specifying icon display mode. |
| LensStudio:Ui.IDialogs | Class | User Interface › LensStudio:Ui | Interface for file and message dialogs. |
| LensStudio:Ui.IEditorsManager | Class | User Interface › LensStudio:Ui | Interface for text editor management. |
| LensStudio:Ui.IGui | Class | User Interface › LensStudio:Ui | Main interface for accessing UI dialogs, widgets, and workspaces in Lens Studio. |
| LensStudio:Ui.ImageView | Class | User Interface › LensStudio:Ui | Widget displaying an image. |
| LensStudio:Ui.ItemFlag | Enum | User Interface › LensStudio:Ui | Bit-flag enum describing per-item capabilities (selectable, editable, draggable, etc.) returned by ScriptableModel.flags(). |
| LensStudio:Ui.Key | Enum | User Interface › LensStudio:Ui | Enumeration of keyboard keys reported by KeyEvent and bound by Shortcut. |
| LensStudio:Ui.KeyboardModifier | Enum | User Interface › LensStudio:Ui | Enum representing keyboard modifier keys. |
| LensStudio:Ui.KeyEvent | Class | User Interface › LensStudio:Ui | Input event describing a keyboard key press, including key code, modifiers, and text. |
| LensStudio:Ui.Label | Class | User Interface › LensStudio:Ui | Widget displaying read-only text. |
| LensStudio:Ui.Layout | Class | User Interface › LensStudio:Ui | Base class for layout managers. |
| LensStudio:Ui.LineEdit | Class | User Interface › LensStudio:Ui | Widget for single-line text input. |
| LensStudio:Ui.ListWidget | Class | User Interface › LensStudio:Ui | Widget displaying a scrollable list of items. |
| LensStudio:Ui.ListWidgetItem | Class | User Interface › LensStudio:Ui | Individual item in a ListWidget. |
| LensStudio:Ui.Menu | Class | User Interface › LensStudio:Ui | Popup menu widget. |
| LensStudio:Ui.MessageBox | Class | User Interface › LensStudio:Ui | Dialog for displaying messages or confirmations. |
| LensStudio:Ui.MessageBox.Icon | Enum | User Interface › LensStudio:Ui | Icon enumeration for message box dialogs. |
| LensStudio:Ui.MessageBox.StandardButton | Enum | User Interface › LensStudio:Ui | Button option type that can be clicked in a message dialog. |
| LensStudio:Ui.MessageBox.StandardButtons | Class | User Interface › LensStudio:Ui | Collection of button options to display in the message dialog. |
| LensStudio:Ui.ModelIndex | Class | User Interface › LensStudio:Ui | Handle identifying a single cell within a ScriptableModel by its row, column, and path of parent row indices. |
| LensStudio:Ui.MouseButton | Enum | User Interface › LensStudio:Ui | Enum representing mouse button identifiers. |
| LensStudio:Ui.MouseEvent | Class | User Interface › LensStudio:Ui | Event object containing mouse interaction data. |
| LensStudio:Ui.Movie | Class | User Interface › LensStudio:Ui | Represents an animated movie or video file. |
| LensStudio:Ui.Movie.CacheMode | Enum | User Interface › LensStudio:Ui | Enum specifying how a Movie caches decoded frames. |
| LensStudio:Ui.MovieView | Class | User Interface › LensStudio:Ui | Widget for playing movies or animations. |
| LensStudio:Ui.Orientation | Enum | User Interface › LensStudio:Ui | Enum specifying horizontal or vertical orientation. |
| LensStudio:Ui.OverflowToolBar | Class | User Interface › LensStudio:Ui | Toolbar that collapses into a menu when space is limited. |
| LensStudio:Ui.Pixmap | Class | User Interface › LensStudio:Ui | Represents an image in memory. |
| LensStudio:Ui.PopupWithArrow | Class | User Interface › LensStudio:Ui | Popup widget with an arrow pointing to a reference position. |
| LensStudio:Ui.ProgressBar | Class | User Interface › LensStudio:Ui | Widget displaying a progress bar. |
| LensStudio:Ui.ProgressIndicator | Class | User Interface › LensStudio:Ui | Widget showing progress without a specific percentage. |
| LensStudio:Ui.ProjectSettings | Namespace | User Interface › LensStudio:Ui | |
| LensStudio:Ui.ProjectSettings.Error | Class | User Interface › LensStudio:Ui | Represents a project settings validation error with a human-readable description. |
| LensStudio:Ui.ProjectSettings.NoIssue | Class | User Interface › LensStudio:Ui | Represents a project settings validation result with no issues. |
| LensStudio:Ui.ProjectSettings.Warning | Class | User Interface › LensStudio:Ui | Represents a project settings validation warning with a human-readable description. |
| LensStudio:Ui.PushButton | Class | User Interface › LensStudio:Ui | Clickable button widget. |
| LensStudio:Ui.QtObject | Class | User Interface › LensStudio:Ui | Base class for native Qt-backed UI objects exposed to plugin scripts. |
| LensStudio:Ui.RadioButton | Class | User Interface › LensStudio:Ui | Widget for selecting one option from a group. |
| LensStudio:Ui.RadioButtonGroup | Class | User Interface › LensStudio:Ui | Manager for radio button groups. |
| LensStudio:Ui.Rect | Class | User Interface › LensStudio:Ui | Represents a rectangular area with x, y, width, height. |
| LensStudio:Ui.ScriptableModel | Class | User Interface › LensStudio:Ui | Base class for custom item models implemented in plugin script; subclasses override rowCount, columnCount, data, headerData, flags, index, and roleNames to f… |
| LensStudio:Ui.SearchableMenu | Class | User Interface › LensStudio:Ui | Menu with search/filter functionality. |
| LensStudio:Ui.SearchLineEdit | Class | User Interface › LensStudio:Ui | LineEdit with search capabilities. |
| LensStudio:Ui.Section | Enum | User Interface › LensStudio:Ui | Collapsible section widget for grouping content. |
| LensStudio:Ui.Separator | Class | User Interface › LensStudio:Ui | A horizontal or vertical line widget used to visually separate groups of UI elements. |
| LensStudio:Ui.Shadow | Enum | User Interface › LensStudio:Ui | Enum specifying shadow effect style. |
| LensStudio:Ui.Shortcut | Class | User Interface › LensStudio:Ui | Keyboard shortcut bound to a widget that emits a signal when its key sequence is activated. |
| LensStudio:Ui.ShortcutContext | Enum | User Interface › LensStudio:Ui | Enum specifying the scope in which a Shortcut is active. |
| LensStudio:Ui.Size | Class | User Interface › LensStudio:Ui | Represents width and height dimensions. |
| LensStudio:Ui.SizePolicy | Namespace | User Interface › LensStudio:Ui | |
| LensStudio:Ui.SizePolicy.Policy | Enum | User Interface › LensStudio:Ui | Enum defining how a widget resizes along an axis: Fixed, Minimum, MinimumExpanding, Maximum, Preferred, Expanding, or Ignored. |
| LensStudio:Ui.Sizes | Class | User Interface › LensStudio:Ui | Collection of size values. |
| LensStudio:Ui.Slider | Class | User Interface › LensStudio:Ui | Widget for selecting a value within a range. |
| LensStudio:Ui.SpinBox | Class | User Interface › LensStudio:Ui | Widget for entering integer numbers. |
| LensStudio:Ui.Splitter | Class | User Interface › LensStudio:Ui | Widget dividing a container into resizable sections. |
| LensStudio:Ui.StackedLayout | Class | User Interface › LensStudio:Ui | Layout manager displaying one widget at a time. |
| LensStudio:Ui.StackedWidget | Class | User Interface › LensStudio:Ui | Container displaying one child widget at a time. |
| LensStudio:Ui.StackingMode | Enum | User Interface › LensStudio:Ui | Enum specifying stacking order mode. |
| LensStudio:Ui.StatusIndicator | Class | User Interface › LensStudio:Ui | Widget showing status with color or icon. |
| LensStudio:Ui.TabBar | Class | User Interface › LensStudio:Ui | Widget displaying tabs for switching between panels. |
| LensStudio:Ui.TextCursor | Class | User Interface › LensStudio:Ui | Represents cursor position in text. |
| LensStudio:Ui.TextCursor.MoveMode | Enum | User Interface › LensStudio:Ui | Enum controlling whether moving the cursor moves the anchor or keeps it to extend the selection. |
| LensStudio:Ui.TextCursor.MoveOperation | Enum | User Interface › LensStudio:Ui | Enum of cursor movement operations such as Start, End, NextWord, StartOfLine, and others. |
| LensStudio:Ui.TextEdit | Class | User Interface › LensStudio:Ui | Widget for multi-line text input. |
| LensStudio:Ui.ToolbarConfig | Class | User Interface › LensStudio:Ui | Configuration for toolbar appearance and behavior. |
| LensStudio:Ui.ToolbarPosition | Enum | User Interface › LensStudio:Ui | Enum specifying toolbar position. |
| LensStudio:Ui.ToolbarSettings | Class | User Interface › LensStudio:Ui | Settings for toolbar configuration. |
| LensStudio:Ui.ToolButton | Class | User Interface › LensStudio:Ui | Button suitable for toolbar placement. |
| LensStudio:Ui.TransformationMode | Enum | User Interface › LensStudio:Ui | Enum specifying image transformation mode. |
| LensStudio:Ui.VerticalScrollArea | Class | User Interface › LensStudio:Ui | Container with vertical scrolling. |
| LensStudio:Ui.VideoView | Class | User Interface › LensStudio:Ui | Widget for displaying video content. |
| LensStudio:Ui.WebEngineView | Class | User Interface › LensStudio:Ui | Embedded Chromium browser widget for HTML/CSS/JavaScript UI. |
| LensStudio:Ui.Widget | Class | User Interface › LensStudio:Ui | Base class for all UI widgets. |
| LensStudio:UiTest | Module | User Interface | Module providing synthetic input and widget inspection utilities for driving the Lens Studio UI in integration tests. |
| LensStudio:UiTest.compareImages | Function | User Interface › LensStudio:UiTest | |
| LensStudio:UiTest.createDiffImage | Function | User Interface › LensStudio:UiTest | |
| LensStudio:UiTest.Cursor | Class | User Interface › LensStudio:UiTest | |
| LensStudio:UiTest.EventType | Enum | User Interface › LensStudio:UiTest | Enumeration of synthetic event types that can be dispatched to widgets via sendEvent. |
| LensStudio:UiTest.findChildren | Function | User Interface › LensStudio:UiTest | Returns descendant widgets of the given widget whose class matches the specified class name. |
| LensStudio:UiTest.findTopLevelWidgets | Function | User Interface › LensStudio:UiTest | |
| LensStudio:UiTest.invoke | Function | User Interface › LensStudio:UiTest | Invokes the named method on the target widget (such as the preview panel) and returns whether the call succeeded. |
| LensStudio:UiTest.itemActivate | Function | User Interface › LensStudio:UiTest | |
| LensStudio:UiTest.itemClick | Function | User Interface › LensStudio:UiTest | Clicks the item at the given index path within a tree or list widget. |
| LensStudio:UiTest.itemCollapse | Function | User Interface › LensStudio:UiTest | Collapses the tree item at the given index path within the widget. |
| LensStudio:UiTest.itemCount | Function | User Interface › LensStudio:UiTest | Returns the number of child items under the given index path within a tree or list widget. |
| LensStudio:UiTest.itemExpand | Function | User Interface › LensStudio:UiTest | Expands the tree item at the given index path within the widget. |
| LensStudio:UiTest.itemText | Function | User Interface › LensStudio:UiTest | Returns the displayed text of the item at the given index path within a tree or list widget. |
| LensStudio:UiTest.KeyEvent | Function | User Interface › LensStudio:UiTest | Constructs a synthetic keyboard event of the given type, key, modifiers, and text for delivery via sendEvent. |
| LensStudio:UiTest.mainWindow | Function | User Interface › LensStudio:UiTest | Returns the top-level main window widget of the Lens Studio GUI. |
| LensStudio:UiTest.MouseEvent | Function | User Interface › LensStudio:UiTest | Constructs a synthetic mouse event of the given type, button, modifiers, and position for delivery via sendEvent. |
| LensStudio:UiTest.processEvents | Function | User Interface › LensStudio:UiTest | Pumps the Qt event loop for the specified number of milliseconds so pending UI updates are processed. |
| LensStudio:UiTest.sendEvent | Function | User Interface › LensStudio:UiTest | Dispatches a synthetic event to the target widget as if the user had triggered it. |
| LensStudio:UriHandlerPlugin | Module | Plugins | Module providing URI handling plugin infrastructure for extending Lens Studio with custom URI scheme handlers. |
| LensStudio:UriHandlerPlugin.Descriptor | Class | Plugins › LensStudio:UriHandlerPlugin | Descriptor for a URI handler plugin, including a predicate function to determine if the handler can process a given URI. |
| LensStudio:UriHandlerPlugin.UriHandlerPlugin | Class | Plugins › LensStudio:UriHandlerPlugin | Constructs a URI handler plugin instance bound to the given plugin system and optional descriptor. |
| LensStudio:Uuid | Module | Files & System | Namespace providing UUID creation and manipulation utilities. |
| LensStudio:Uuid.fromString | Function | Files & System › LensStudio:Uuid | Parses a UUID from its string representation. |
| LensStudio:Uuid.invalid | Variable | Files & System › LensStudio:Uuid | A UUID instance representing an invalid or null identifier. |
| LensStudio:Uuid.Uuid | Class | Files & System › LensStudio:Uuid | Represents a universally unique identifier used to reference assets and components. |
| LensStudio:WebSocket | Module | Networking | Module providing WebSocket client and server classes for bidirectional network communication. |
| LensStudio:WebSocket.WebSocket | Class | Networking › LensStudio:WebSocket | Client-side WebSocket connection that can send and receive data over a WebSocket connection. |
| LensStudio:WebSocket.WebSocketServer | Class | Networking › LensStudio:WebSocket | Server that accepts incoming WebSocket connections and manages connected client sockets. |
| LensStudio:Workspaces | Module | User Interface | Module for inspecting Lens Studio workspaces and installing custom workspace presets. |
| LensStudio:Workspaces.Descriptor | Class | User Interface › LensStudio:Workspaces | Describes a workspace preset: its metadata and serialized panel layout. |
| LensStudio:Workspaces.IWorkspaceManager | Class | User Interface › LensStudio:Workspaces | Plugin component that manages the workspaces open in Lens Studio, each a tab with its own panel layout, and the custom workspace presets users can open. |
| LensStudio:Workspaces.Metadata | Class | User Interface › LensStudio:Workspaces | Display name and icon of a workspace or workspace preset. |
| LensStudio:Workspaces.PresetHandle | Class | User Interface › LensStudio:Workspaces | Opaque handle returned by IWorkspaceManager.register() for an installed workspace preset. |
| LensStudio:Workspaces.Workspace | Class | User Interface › LensStudio:Workspaces | A workspace open in Lens Studio: a named tab with its own panel layout. |
| mat2 | Class | Math | 2x2 column-major floating-point matrix. |
| mat3 | Class | Math | A 3x3 matrix type supporting common linear algebra operations. |
| mat4 | Class | Math | 4x4 matrix used for 3D transformations including rotation, scale, translation, and projection. |
| MathUtils | Class | Math | Utility class providing common math operations and constants. |
| quat | Class | Math | Quaternion type for representing rotations in 3D space. |
| ScriptObject | Class | Globals & Utilities | Base class for all script-accessible Lens Studio objects. |
| SecureLocalStorage | Class | Files & System | Provides encrypted storage for each plugin module's sensitive data, like access tokens. |
| setInterval | Function | Globals & Utilities | Repeatedly call callback every delayMs milliseconds. |
| setTimeout | Function | Globals & Utilities | Call callback after delayMs milliseconds. |
| signal0 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| signal1 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| signal2 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| signal3 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| signal4 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| signal5 | Interface | Globals & Utilities | An interface that allows you to bind a callback on connect. |
| Task | Class | Globals & Utilities | Namespace providing task management utilities for tracking and coordinating asynchronous operations. |
| Task.ITaskManager | Class | Globals & Utilities › Task | Interface for a plugin component that manages pending tasks and exposes a promise that resolves when all tasks complete. |
| Task.TaskManager | Class | Globals & Utilities › Task | Concrete implementation of ITaskManager that tracks and coordinates task completion within the editor. |
| TextDecoder | Class | Globals & Utilities | Decodes binary data from a Uint8Array into a string using a specified character encoding. |
| TextEncoder | Class | Globals & Utilities | Encodes strings into UTF-8 byte arrays. |
| Timeout | Class | Globals & Utilities | A handle for a timer. |
| vec2 | Class | Math | 2D vector with x and y components, used for 2D positions, directions, and math operations. |
| vec3 | Class | Math | 3-component floating-point vector used for 3D positions, directions, and RGB color values. |
| vec4 | Class | Math | Four-component float vector used for XYZW coordinates and RGBA color values. |
| vec4b | Class | Math | A 4-component boolean vector with x/y/z/w and r/g/b/a accessors. |