Skip to main content

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.

SymbolKindTopicDescription
Base64ClassGlobals & UtilitiesUtility class for encoding and decoding data in base64 format.
BaseDescriptorClassPluginsBase class for plugin descriptors containing metadata and interface requirements.
clearIntervalFunctionGlobals & UtilitiesRemove the interval calls.
clearTimeoutFunctionGlobals & UtilitiesCancels the timeout.
consoleClassGlobals & UtilitiesOutput logging utilities for plugin scripts.
console.CategoryClassGlobals & Utilities › consoleEnum-like type for log categories (console.None, console.User).
createFunctionObjectFunctionGlobals & UtilitiesDynamically creates a function object from a string of JavaScript code.
EditorClassPluginsNamespace that provides access to the components of Lens Studio.
Editor.AiClassAI & Chat ToolsAccess AI chat functionality and message history.
Editor.Ai.StorageClassAI & Chat Tools › Editor.AiManage AI chat history and sessions.
Editor.AlignmentNamespaceUser Interface
Editor.Alignment.HorizontalEnumUser Interface › Editor.AlignmentThe options for horizontal alignment, for example when using Editor.Components.BaseMeshVisual
Editor.Alignment.VerticalEnumUser Interface › Editor.AlignmentThe options for vertical alignment, for example when using Editor.Components.BaseMeshVisual
Editor.AnimationClipClassAssetsRepresents an animation clip instance with playback configuration.
Editor.AnimationLayerBlendModeEnumAssetsEnum defining how animation layers blend with the base animation.
Editor.AnimationLayerScaleModeEnumAssetsDefines how animation layer scaling is applied to the base animation.
Editor.AssetsClassAssetsNamespace containing all asset types for Lens Studio projects.
Editor.Assets.AnimationAssetClassAssetsRepresents an animation asset with playback timing information.
Editor.Assets.AntialiasingModeEnumAssetsThe aliasing mode of Editor.Assets.RenderTarget.
Editor.Assets.AntialiasingQualityEnumAssetsEnum for antialiasing quality levels.
Editor.Assets.AssetClassAssetsRepresents an imported asset with cached file and metadata.
Editor.Assets.AssetCompressionSettingsClassAssetsBase type assigned to AssetImportMetadata.compressionSettings to set how an asset is compressed during import.
Editor.Assets.AssetImporterSettingsClassAssetsEntity subclass representing the structural organization of entities within a scene.
Editor.Assets.AudioTrackAssetClassAssetsRepresents an audio track asset.
Editor.Assets.BlendModeEnumAssetsThe blendmode of a Editor.Assets.PassInfo.
Editor.Assets.BodyTracking3DAssetClassAssets3D body tracking asset with optional hand tracking support.
Editor.Assets.ClearColorOptionEnumAssetsHow a Render Target should be cleared every frame Editor.Assets.RenderTarget.
Editor.Assets.CullModeEnumAssetsEnum that specifies which faces of a mesh to cull during rendering.
Editor.Assets.CustomAssetClassAssetsAn instance of a custom asset type defined by an @asset script.
Editor.Assets.CustomCodeNodeAssetClassAssetsAsset representing a custom code node in a visual graph.
Editor.Assets.CustomVariationStyleClassAssetsA user-defined named style on a variable Editor.Assets.Font.
Editor.Assets.DepthBufferStrategyEnumAssetsThe depth buffer strategy of a Editor.Assets.RenderTarget.
Editor.Assets.DepthFunctionEnumAssetsHow a Editor.Assets.PassInfo should determine its depth compared to others.
Editor.Assets.DeviceCameraTextureClassAssetsA native asset that provides the texture from the camera feed.
Editor.Assets.DracoCompressionSettingsClassAssetsSets Google Draco geometry compression on a mesh asset; assign to AssetImportMetadata.compressionSettings.
Editor.Assets.FaceCropTextureClassAssetsA native asset that provides a cropped region of the input texture, calculated based on face position.
Editor.Assets.FaceMeshClassAssetsA native asset that provides a 3D mesh of the user's face.
Editor.Assets.FileCompressionSettingsClassAssetsBase type for file-backed compression strategies, assigned to AssetImportMetadata.compressionSettings to set the compression applied at import.
Editor.Assets.FileMeshClassAssetsAn asset for 3D meshes.
Editor.Assets.FileTextureClassAssetsAn asset for textures.
Editor.Assets.FileTexture2DArrayClassAssetsA 2D texture array asset loaded from file containing multiple 2D texture layers.
Editor.Assets.FileTexture3DClassAssets3D texture asset imported from an external file.
Editor.Assets.FileTextureCubemapClassAssetsCubemap texture asset with per-face texture information.
Editor.Assets.FileTextureInfoClassAssetsHolds texture file dimensions.
Editor.Assets.FileTextureInfo3DClassAssets3D texture file information including depth.
Editor.Assets.FilteringModeEnumAssetsHow a texture should be sampled.
Editor.Assets.FontClassAssetsFont asset for text rendering.
Editor.Assets.FontCollectionClassAssetsAn ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.
Editor.Assets.FontCollectionEntryClassAssetsSingle entry within a FontCollection, pairing a Font or FontFamily asset with weight and italic style attributes.
Editor.Assets.FontFamilyClassAssetsGroups multiple Font assets into a single family, mapping each to a style (weight + italic).
Editor.Assets.FontFamilyEntryClassAssetsMaps a single Font asset to a specific style (weight and italic flag) within a FontFamily.
Editor.Assets.FrustumCullModeEnumAssetsThe same entity as in Lens Scripting.
Editor.Assets.GaussianSplattingAssetClassAssetsAsset containing Gaussian splats for use with GaussianSplattingVisual.
Editor.Assets.HairDataAssetClassAssetsNative asset providing data for hair rendering.
Editor.Assets.HandMeshClassAssetsA render mesh that follows a tracked hand.
Editor.Assets.HandTracking3DAssetClassAssets3D hand tracking asset for hand pose and gesture recognition.
Editor.Assets.HandTracking3DHandTypeEnumAssetsUsed with {Editor.Assets.HandTracking3DAsset}.
Editor.Assets.ImageMarkerClassAssetsA LensScripting.MarkerAsset for use with Editor.Components.MarkerTrackingComponent
Editor.Assets.JavaScriptAssetClassAssetsA script asset that is written in JavaScript.
Editor.Assets.JsonAssetClassAssetsAsset wrapping JSON data.
Editor.Assets.LicensedAudioTrackClassAssetsLicensed audio track asset with metadata and runtime source paths.
Editor.Assets.LocationAssetClassAssetsAsset representing a named location with an identifier and type.
Editor.Assets.LocationMeshClassAssetsA native asset that provides data for LensScripting.LocationAsset.
Editor.Assets.LocationTypeEnumAssetsUsed with {Editor.Assets.Location}.
Editor.Assets.MarkdownAssetClassAssetsNative asset for markdown content.
Editor.Assets.MarkerAssetClassAssetsBase asset for marker tracking with configurable height.
Editor.Assets.MaterialClassAssetsMaterial asset defining rendering passes and their properties.
Editor.Assets.MeshInfoClassAssetsRead-only metadata describing the geometry and rigging of a mesh asset.
Editor.Assets.MLAssetClassAssetsMachine learning model asset.
Editor.Assets.MSAAStrategyEnumAssetsEnum for multisample anti-aliasing strategy selection.
Editor.Assets.NamedInstanceInfoClassAssetsRead-only named axis preset from the font's fvar table, for example "Condensed Bold".
Editor.Assets.NativePackageDescriptorClassAssetsMetadata descriptor for a native package asset.
Editor.Assets.Object3DAssetClassAssetsBase asset type for 3D object models.
Editor.Assets.ObjectOwnerClassAssetsBase class for entities which has object and component relationship such as Editor.Assets.Scene and Editor.Assets.ObjectPrefab.
Editor.Assets.ObjectPrefabClassAssetsReusable object template that can be instantiated in scenes.
Editor.Assets.ObjectTrackingTextureClassAssetsA native asset that provides information for object tracking texture.
Editor.Assets.ObjectTrackingTextureTypeEnumAssetsUsed with Editor.Assets.ObjectTrackingTexture.
Editor.Assets.PackagePolicyEnumAssetsEnum defining how asset packages can be unpacked and their transparency handling.
Editor.Assets.PassClassAssetsRendering pass asset used within a material.
Editor.Assets.PassBindingClassAssetsDefines a binding parameter for a render pass with metadata for UI presentation and value constraints.
Editor.Assets.PassBindingTypeEnumAssetsEnum defining types of bindings for render passes.
Editor.Assets.PassConfigurationClassAssetsPlain configuration object describing a Pass asset, blend mode, and shader defines to apply to a PassInfo via setPassConfiguration.
Editor.Assets.PassInfoClassAssetsThe Editor.Assets.Pass on a Editor.Assets.Material.
Editor.Assets.PassUiDataClassAssetsShader pass UI configuration data.
Editor.Assets.PerformanceCompressionSettingsClassAssetsSets runtime-performance-tuned texture compression with optional mipmaps; assign to AssetImportMetadata.compressionSettings.
Editor.Assets.PhysicsClassAssetsNamespace for physics-related assets and configuration.
Editor.Assets.Physics.FilterClassAssets › Editor.Assets.PhysicsDefines collision filtering rules for physics queries and interactions.
Editor.Assets.Physics.LevelsetColliderAssetClassAssets › Editor.Assets.PhysicsLevelset-based collision shape asset.
Editor.Assets.Physics.MatterClassAssets › Editor.Assets.PhysicsPhysics material asset defining bounce and friction properties.
Editor.Assets.Physics.WorldSettingsAssetClassAssets › Editor.Assets.PhysicsAsset configuring global physics simulation settings.
Editor.Assets.Physics.WorldSettingsBaseClassAssets › Editor.Assets.PhysicsBase class for physics world settings assets, such as WorldSettingsAsset.
Editor.Assets.RemoteAssetMetadataClassAssets
Editor.Assets.RemoteAssetOrganizationClassAssets
Editor.Assets.RemoteAssetResourceClassAssets
Editor.Assets.RemoteAssetTypeEnumAssets
Editor.Assets.RemoteMLAssetClassAssetsML asset backed by a remote device-dependent resource.
Editor.Assets.RemoteReferenceAssetClassAssetsReference to a remote asset identified by an asset ID.
Editor.Assets.RenderMeshClassAssets3D mesh asset for rendering geometry.
Editor.Assets.RenderTargetClassAssetsA native asset that provides the target for a camera to provide its output to.
Editor.Assets.SamplerClassAssetsTexture sampling configuration for filtering, mipmapping, and wrapping modes.
Editor.Assets.SceneClassAssetsThe entity which will be converted into the Lens scene during project export.
Editor.Assets.ScriptAssetClassAssetsScript asset that can be attached to scene objects, containing inputs, attachments, and metadata.
Editor.Assets.ScriptInputInfoClassAssetsMetadata about a script input parameter.
Editor.Assets.ScriptTypeEnumAssetsThe 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.SegmentationTextureClassAssetsA native asset that provides information for segmentation texture.
Editor.Assets.SegmentationTypeEnumAssetsBuilt in segmentation textures to be used with Editor.Assets.SegmentationTexture.
Editor.Assets.SetupScriptClassAssetsScript executed during asset package setup.
Editor.Assets.ShaderTypeEnumAssetsEnum of shader type categories.
Editor.Assets.SizeCompressionSettingsClassAssetsSets size-prioritized texture compression at a configurable quality level; assign to AssetImportMetadata.compressionSettings.
Editor.Assets.SnapcodeMarkerClassAssetsA native asset that can be used with LensScripting.MarkerTrackingComponent Learn more at LensScripting.SnapcodeMarkerProvider.
Editor.Assets.SubgraphAssetClassAssetsAsset representing a subgraph embeddable in other graphs.
Editor.Assets.SupabaseProjectClassAssetsSupabase project asset with connection credentials.
Editor.Assets.TextureClassAssetsBase texture asset.
Editor.Assets.TextureCompressionLevelEnumAssetsQuality preset selecting how aggressively a texture is compressed.
Editor.Assets.TextureParameterClassAssetsAssociates a texture with a sampler for use in a material pass.
Editor.Assets.TypeScriptAssetClassAssetsTypeScript script asset for Lens Studio plugins.
Editor.Assets.VariationAxisInfoClassAssetsRead-only metadata describing one OpenType variation axis on a variable font.
Editor.Assets.VectorCompositeClassAssetsVector graphics asset created by importing an SVG file.
Editor.Assets.VersionClassAssetsUsed to set the version of script assets.
Editor.Assets.VertexAttributeEnumAssetsUsed witih Editor.Assets.FaceMesh
Editor.Assets.VideoTextureClassAssetsTexture asset created by importing a video file.
Editor.Assets.WrapModeEnumAssetsOptions for what value is returned when a fetch falls outside the bounds of a texture.
Editor.AxisEnumGlobals & UtilitiesEnum of spatial axes.
Editor.BufferClassFiles & SystemWraps a byte array for data serialization and deserialization.
Editor.ComponentsClassComponentsContainer for all scene component types and related enums.
Editor.Components.AnimationPlayerClassComponentsComponent that manages animation playback with clips and autoplay settings.
Editor.Components.AudioComponentClassComponentsManages audio playback and spatial audio properties for a scene object.
Editor.Components.BackgroundSettingsClassComponentsConfigures background styling for UI components.
Editor.Components.BarycentricVertexClassComponentsSettings used with Editor.Components.Head to set position on the face.
Editor.Components.BaseMeshVisualClassComponentsBase class for mesh-based visual components.
Editor.Components.CameraClassComponentsRenders the scene from a viewpoint with configurable projection and output.
Editor.Components.CameraAspectPresetEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraClearColorClassComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraClearColor.ModeEnumComponents › Editor.Components.CameraClearColorThe same entity as in Lens Scripting.
Editor.Components.CameraClearDepthClassComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraClearDepth.ModeEnumComponents › Editor.Components.CameraClearDepthThe same entity as in Lens Scripting.
Editor.Components.CameraDepthBufferModeEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraDevicePropertyEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraOitLayersEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.CameraTypeEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.CanvasClassComponentsManages 2D canvas rendering and layout properties for a scene object.
Editor.Components.CapitalizationOverrideEnumComponentsEnum for text capitalization override options.
Editor.Components.ClipRangeTypeEnumComponentsEnum for specifying clip range units.
Editor.Components.ClothVisualClassComponentsSimulates cloth physics with stretching, bending, and collision interactions.
Editor.Components.ClothVisual.BendModeEnumComponents › Editor.Components.ClothVisualThe same entity as in Lens Scripting.
Editor.Components.ClothVisual.VertexBindingClassComponents › Editor.Components.ClothVisualThe same entity as in Lens Scripting.
Editor.Components.ComponentClassComponentsBase class for components attached to scene objects.
Editor.Components.CompositionLayerComponentClassComponentsBase class for components attached to scene objects.
Editor.Components.CompositionLayerRenderComponentClassComponentsBase class for components attached to scene objects.
Editor.Components.CompositionLayerRenderUpdateModeEnumComponents
Editor.Components.DeviceTrackingClassComponentsComponent that configures device tracking behavior and options.
Editor.Components.DeviceTrackingModeEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.DistanceEffectCurveTypeEnumComponentsCurve type options for distance-based effects.
Editor.Components.DropshadowSettingsClassComponentsDrop shadow settings for text rendering.
Editor.Components.EnvmapFromCameraModeEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.ExtrudeDirectionEnumComponentsSettings used with Editor.Components.Text3D.
Editor.Components.EyeColorVisualClassComponentsVisual component for rendering eye color on a face mesh.
Editor.Components.EyeToRenderEnumComponentsSettings used with Editor.Components.EyeColorVisual.
Editor.Components.FaceInsetRegionEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.FaceInsetVisualClassComponentsVisual component for rendering an inset region of a face mesh with customizable borders.
Editor.Components.FaceMaskVisualClassComponentsVisual component for rendering face masks with optional mouth and teeth correction.
Editor.Components.FaceStretchVisualClassComponentsVisual component for stretching and deforming face meshes with named features.
Editor.Components.FalloffTypeEnumComponentsFalloff curve type options for light and effect components.
Editor.Components.FontStylesClassComponentsStandard font style names for the preferredStyle property of Editor.Components.Text and Editor.Components.Text3D.
Editor.Components.GaussianSplattingVisualClassComponentsRenders a Gaussian Splatting asset with optional frame selection for animated content.
Editor.Components.HairVisualClassComponentsRenders and simulates hair with physics, collision, and material properties.
Editor.Components.HeadClassComponentsComponent that attaches a scene object to a tracked head position.
Editor.Components.HeadAttachmentPointTypeEnumComponentsSettings used with Editor.Components.Head.
Editor.Components.HorizontalOverflowEnumComponentsSettings used with Editor.Components.Text and Editor.Components.Text3D.
Editor.Components.ImageClassComponentsRenders a 2D image with optional flip, pivot, and rotation.
Editor.Components.InteractionComponentClassComponentsHandles touch and interaction detection on 3D meshes.
Editor.Components.LightSourceClassComponentsComponent controlling light properties, shadows, and environment mapping.
Editor.Components.LightTypeEnumComponentsSettings used with Editor.Components.LightSource.
Editor.Components.LiquifyVisualClassComponentsVisual component applying liquify distortion to face mesh geometry.
Editor.Components.LocatedAtComponentClassComponentsPins a scene object to a real-world location asset.
Editor.Components.LookAtComponentClassComponentsRotates an object to face a target point or direction.
Editor.Components.LookAtComponent.AimVectorsEnumComponents › Editor.Components.LookAtComponentSettings used with Editor.Components.LookAtComponent.
Editor.Components.LookAtComponent.LookAtModeEnumComponents › Editor.Components.LookAtComponentSettings used with Editor.Components.LookAtComponent.
Editor.Components.LookAtComponent.WorldUpVectorEnumComponents › Editor.Components.LookAtComponentSettings used with Editor.Components.LookAtComponent.
Editor.Components.ManipulateComponentClassComponentsEnables drag, rotate, and scale interactions on a scene object.
Editor.Components.MarkerTrackingComponentClassComponentsTracks a marker asset for marker-based AR anchoring.
Editor.Components.MaskingComponentClassComponentsApplies a rounded-corner mask to a scene object.
Editor.Components.MaterialMeshVisualClassComponentsBase class for mesh visual components that render with materials.
Editor.Components.MeshShadowModeEnumComponentsThe same entity as in Lens Scripting.
Editor.Components.ObjectTrackingClassComponentsTracks 2D objects in the camera feed using ML classification.
Editor.Components.ObjectTracking3DClassComponentsTracks and matches 3D objects in the scene using pose estimation.
Editor.Components.ObjectTracking3D.TrackingModeEnumComponents › Editor.Components.ObjectTracking3DEnum specifying how 3D object tracking data is interpreted.
Editor.Components.ObjectTrackingTypeEnumComponentsSettings used with Editor.Components.ObjectTracking.
Editor.Components.OutlineSettingsClassComponentsSettings for outline rendering on a component.
Editor.Components.PhysicsClassComponentsNamespace containing physics simulation components, shapes, and constraints for rigid bodies and colliders.
Editor.Components.Physics.BodyComponentClassComponents › Editor.Components.PhysicsRigid body physics component for dynamic objects.
Editor.Components.Physics.BodySettingEnumComponents › Editor.Components.PhysicsEnum specifying how a physics body's mass is calculated.
Editor.Components.Physics.BoxClassComponents › Editor.Components.PhysicsBox-shaped physics collider component.
Editor.Components.Physics.CapsuleClassComponents › Editor.Components.PhysicsA capsule-shaped physics collider.
Editor.Components.Physics.ColliderComponentClassComponents › Editor.Components.PhysicsDefines collision geometry and physics properties for an object.
Editor.Components.Physics.ConeClassComponents › Editor.Components.PhysicsCone-shaped physics collider.
Editor.Components.Physics.ConstraintEnumComponents › Editor.Components.PhysicsPhysics constraint types for rigidbody connections.
Editor.Components.Physics.ConstraintComponentClassComponents › Editor.Components.PhysicsComponent that applies physics constraints to a scene object.
Editor.Components.Physics.CylinderClassComponents › Editor.Components.PhysicsCylindrical physics shape with configurable axis, length, and radius.
Editor.Components.Physics.LevelSetClassComponents › Editor.Components.PhysicsA physics shape using a level set asset for complex collision geometry.
Editor.Components.Physics.MeshClassComponents › Editor.Components.PhysicsPhysics mesh shape component for collision detection using custom meshes.
Editor.Components.Physics.ShapeClassComponents › Editor.Components.PhysicsBase class for physics shapes attached to entities.
Editor.Components.Physics.SphereClassComponents › Editor.Components.PhysicsA spherical physics shape component.
Editor.Components.Physics.WorldComponentClassComponents › Editor.Components.PhysicsPhysics world container managing simulation and settings.
Editor.Components.PinToMeshNamespaceComponents
Editor.Components.PinToMesh.OrientationEnumComponents › Editor.Components.PinToMeshSpecifies how the pin aligns to the mesh.
Editor.Components.PinToMeshComponentClassComponentsComponent that pins a SceneObject to a point on a mesh surface.
Editor.Components.PostEffectVisualClassComponentsVisual component for rendering post-effect materials.
Editor.Components.RectangleSetterClassComponentsComponent for setting rectangular regions on textures.
Editor.Components.RenderLayerOwnerClassComponentsThe render layer which the component will be on.
Editor.Components.RenderMeshVisualClassComponentsRenders a mesh with customizable blend shapes and normals.
Editor.Components.RetouchVisualClassComponentsVisual component for applying retouching effects to faces.
Editor.Components.RotationOptionsClassComponentsConfigures rotation behavior for entities.
Editor.Components.ScreenRegionComponentClassComponentsComponent that defines a rectangular region on screen.
Editor.Components.ScreenRegionTypeEnumComponentsUsed with Editor.Components.ScreenRegionComponent.
Editor.Components.ScreenTransformClassComponentsComponent for positioning and scaling UI elements relative to screen dimensions.
Editor.Components.ScreenTransformConstraintsClassComponentsUsed with Editor.Components.ScreenTransformConstraints.
Editor.Components.ScriptComponentClassComponentsComponent that runs a script asset.
Editor.Components.ShadowTypeEnumComponentsEnum specifying shadow rendering technique for light sources.
Editor.Components.SkinClassComponentsRepresents a skeletal rigging component that controls deformation of mesh geometry through bone transformations.
Editor.Components.SortingTypeEnumComponentsUsed with Editor.Components.Canvas.
Editor.Components.StretchModeEnumComponentsUsed with Editor.Components.BaseMeshVisual.
Editor.Components.StretchPointClassComponentsDefines a mesh vertex stretch point for FaceStretchVisual deformation.
Editor.Components.SurfaceOptionsClassComponentsConfiguration for surface rendering options.
Editor.Components.TextClassComponentsRenders and manages text in the scene with customizable font, size, layout, and visual effects.
Editor.Components.Text3DClassComponents3D text rendering component with font, layout, and styling options.
Editor.Components.TextAdvancedLayoutClassComponentsAdvanced text layout configuration for controlling text appearance and spacing.
Editor.Components.TextFillClassComponentsConfigures fill properties for text rendering.
Editor.Components.TextFillModeEnumComponentsSettings used with Editor.Components.Text.
Editor.Components.TextFillTileZoneEnumComponentsSpecifies the coordinate system for text fill tile positioning.
Editor.Components.UnitTypeEnumComponentsSettings used with Editor.Components.Canvas.
Editor.Components.VerticalOverflowEnumComponentsSettings used with Editor.Components.Text.
Editor.Components.VisualClassComponentsBase class for visual components that control rendering order and appearance.
Editor.CompressionClassFiles & SystemProvides compression and decompression utilities.
Editor.Compression.GZipClassFiles & System › Editor.CompressionGZip compression utility for packing and unpacking files.
Editor.Compression.ZipClassFiles & System › Editor.CompressionModule to zip and unzip files.
Editor.ContextActionClassPluginsAn action in a Editor.IContextActionRegistry.
Editor.DockClassUser InterfaceContainer for dock panel management functionality.
Editor.Dock.IDockManagerClassUser Interface › Editor.DockManages the states of Lens Studio panels.
Editor.GaussianSplattingClassAssetsNamespace providing utilities to create and import Gaussian splatting (GSAF) assets from PLY input files.
Editor.GaussianSplatting.GaussianSplattingImporterSettingsClassAssets › Editor.GaussianSplattingEntity subclass representing the structural organization of entities within a scene.
Editor.GaussianSplatting.GsafCreationInfoClassAssets › Editor.GaussianSplattingRead-only metadata returned by createGsafFromPlyFiles describing the bit rate and quantization characteristics of the resulting GSAF asset.
Editor.GaussianSplatting.GsafImporterSettingsClassAssets › Editor.GaussianSplattingConfiguration entity controlling how PLY files are compressed and packed into a GSAF asset by createGsafFromPlyFiles.
Editor.GaussianSplatting.GsCompressionProfileEnumAssets › Editor.GaussianSplattingEnum of preset compression profiles consumed by GsafImporterSettings.compressionProfile, trading file size against visual quality.
Editor.GaussianSplatting.GsQuatPackingMethodEnumAssets › Editor.GaussianSplattingEnum selecting how splat rotation quaternions are packed when encoding a GSAF asset, consumed by GsafImporterSettings.quatPackingMethod.
Editor.GraphClassAssetsUtility class for converting between binary and YAML representations of graph files.
Editor.IAuthorizationClassPluginsComponent that allows you to check whether Lens Studio is authorized, as well as get authorization.
Editor.IconClassUser InterfaceAn icon to be used in the Editor UI.
Editor.IContextClassPluginsEditor context passed to context action callbacks when a right-click menu is triggered.
Editor.IContextActionRegistryClassPluginsA registry of Editor.ContextAction which will be shown in a contextual menu (i.e. right click).
Editor.IEntityPickerClassUser InterfacePopup window that allows the user to choose specific objects in the Scene hierarchy, or assets in the Asset Browser.
Editor.IGuardClassPluginsRepresents ownership of a resource.
Editor.IInterfaceClassPluginsBase interface type for Editor plugin system objects.
Editor.InterfaceIdClassPluginsUnique identifier for plugin interfaces.
Editor.IPackageActionsClassPluginsInterface for package-level actions.
Editor.IPackageRegistryClassPluginsInterface for package discovery and registration.
Editor.IPluginClassPluginsInterface representing a plugin.
Editor.IPluginComponentClassPluginsInterface for plugin component registration.
Editor.IRuntimeBundleExporterClassPreview & PublishingInterface for exporting an asset, together with the assets it references, as a runtime bundle file.
Editor.ModelClassProject & SceneThe model object is a core concept in the plugin development environment.
Editor.Model.AssetContextClassProject & SceneContext object holding the current asset selection, providing access to selected assets and their paths.
Editor.Model.AssetContext.ItemClassProject & Scene › Editor.Model.AssetContextRepresents a single selected asset entry, pairing an asset reference with its file path.
Editor.Model.AssetImportMetadataClassProject & SceneA handle for the metadata of an asset.
Editor.Model.AssetImportMetadata.PackageIterateEnumProject & Scene › Editor.Model.AssetImportMetadataEnum controlling whether native package iteration is shallow or deep.
Editor.Model.AssetManagerClassProject & SceneManages project assets — creating, importing, finding, and organizing assets within the project.
Editor.Model.AssetMetaClassProject & SceneStores metadata for an asset, including type information and associated properties.
Editor.Model.BaseChangesStreamClassProject & SceneBase class for streams that track and apply model changes.
Editor.Model.DeviceTypeEnumProject & SceneEnum representing the target device type for a Lens Studio project.
Editor.Model.EntityClassProject & SceneAn object in the scene, or asset in the Editor.Model.AssetManager
Editor.Model.EntityBaseTypeEnumProject & SceneEnum defining the base types an entity prototype can represent.
Editor.Model.EntityPrototypeDataClassProject & SceneDefines prototype data for an entity type, including its display metadata and factory function.
Editor.Model.EntityStructureClassProject & SceneEntity subclass representing the structural organization of entities within a scene.
Editor.Model.ExportOptionsClassProject & SceneOptions controlling how a model is exported, including dependency handling and packaging policy.
Editor.Model.ExternalPackageDependencyClassProject & SceneRepresents an external package dependency, including its import metadata and version configuration.
Editor.Model.FindOptionEnumProject & SceneEnum of options controlling model lookup behavior.
Editor.Model.IEntityPrototypeRegistryClassProject & SceneRegistry for entity prototypes, providing methods to create, query, and register entity types within the Editor model.
Editor.Model.IEntityRegistryClassProject & SceneA registry of various entities.
Editor.Model.IModelClassProject & SceneCore plugin component interface providing access to the current Lens Studio project and its lifecycle events.
Editor.Model.ImportResultClassProject & SceneThe result of Editor.Model.AssetManager.importExternalFile and Editor.Model.AssetManager.importExternalFileAsync.
Editor.Model.ImportSettingsClassProject & SceneSettings object describing how a model import operation was configured.
Editor.Model.InspectableMetaClassProject & SceneMetadata for an inspectable object, providing display caption and icon for use in the Editor UI.
Editor.Model.InstantiationParamsClassProject & SceneParameters used when instantiating a scene object, including its parent hierarchy.
Editor.Model.LayerClassProject & SceneThe layers within a Editor.Model.LayerSet.
Editor.Model.LayerIdClassProject & SceneThe id of a Editor.Model.Layer.
Editor.Model.LayersClassProject & SceneThe layers of a {@Editor.Assets.Scene}.
Editor.Model.LayerSetClassProject & SceneRepresents an immutable set of scene layers, supporting set operations like union, intersection, and difference.
Editor.Model.LensActivationCameraEnumProject & SceneThe various cameras which will be activated when this project's Lens turns on.
Editor.Model.LensApplicabilityEnumProject & SceneThe various contexts in which this Lens can be used.
Editor.Model.LensClientCompatibilityEnumProject & SceneEnumerates the client surfaces a Lens can target for distribution.
Editor.Model.MetaClassProject & SceneThe metadata of an entity.
Editor.Model.MetaInfoClassProject & SceneMetadata of the current project's Lens.
Editor.Model.ObjectContextClassProject & SceneContext scoped to a set of scene objects, providing access to the current object selection.
Editor.Model.PackageOptionEnumProject & SceneEnum representing the packaging state of an asset or resource.
Editor.Model.PrefabableClassProject & SceneAn entity which can be turned into a prefab, such as Editor.Model.SceneObject.
Editor.Model.ProjectClassProject & SceneRepresents the open Lens Studio project, providing access to the scene, asset manager, and project settings.
Editor.Model.ProjectSaveModeEnumProject & SceneEnum controlling how and when a project is saved.
Editor.Model.ResultTypeEnumProject & SceneHow a file should be imported into the project.
Editor.Model.SceneObjectClassProject & SceneA node in the scene hierarchy, holding components and child scene objects.
Editor.Model.SourcePathClassProject & SceneRepresents a file path within a Lens Studio project, combining a root-relative path with a source root directory.
Editor.Model.SourceRootDirectoryEnumProject & SceneEnum identifying the root directory context for resolving source paths within a Lens Studio project.
Editor.Model.TransformEntityClassProject & SceneEntity that carries a spatial transform, representing position, rotation, and scale in the scene.
Editor.Model.WorldTransformAccessorClassProject & SceneProvides read and write access to an entity's world-space transform.
Editor.MyLensesClassNetworkingNamespace for Lens Studio's My Lenses account integration.
Editor.PackageMetadataClassPluginsMetadata information about a package.
Editor.PathClassFiles & SystemA path in the filesystem, or Asset Manager.
Editor.PlaybackModeEnumAssetsEnumeration of animation playback modes.
Editor.PluginSystemClassPluginsProvides access to the Lens Studio editor plugins, components, and interfaces
Editor.PointClassUser InterfaceRepresents a 2D point with x and y coordinates.
Editor.RectClassUser InterfaceRepresents a 2D rectangle with position and dimensions.
Editor.RuntimeBundleExporterClassPreview & PublishingLens Studio's built-in implementation of Editor.IRuntimeBundleExporter.
Editor.ScopedConnectionClassGlobals & UtilitiesStores event listener connections, automatically cleaned up on scope exit.
Editor.ShapeClassGlobals & UtilitiesRepresents a 2D or 3D shape object.
Editor.SizeClassUser InterfaceUsed with Editor.Assets.RenderTarget.
Editor.TargetPlatformEnumPluginsEnum of platforms a Lens Studio plugin or project can target.
Editor.TransformClassProject & SceneRepresents position, rotation, and scale in 3D space.
Editor.VersionClassGlobals & UtilitiesVersion information for the editor or plugin.
globalNamespaceGlobals & Utilities
global.secureLocalStorageVariableGlobals & Utilities › globalProvides access to the plugin's SecureLocalStorage.
IPanelPluginClassPluginsPlugin base class for plugins that contribute a titled UI panel widget to the editor.
IPluginDescriptorClassPluginsDescriptor exposing a plugin's id, name, description, dependencies, and exported interfaces.
LensStudio:AnalyticsModuleFiles & SystemProvides analytics functionality for logging events from within a Lens.
LensStudio:AppModuleFiles & System
LensStudio:App.AppStateEnumFiles & System › LensStudio:App
LensStudio:App.envVariableFiles & System › LensStudio:AppA map containing the PATH and PWD environment variables of the current Lens Studio process.
LensStudio:App.executablePathVariableFiles & System › LensStudio:App
LensStudio:App.onStateChangedVariableFiles & System › LensStudio:AppSignal emitted with the new AppState whenever the application-wide state of Lens Studio changes.
LensStudio:App.stateFunctionFiles & System › LensStudio:AppReturns the current application-wide state of Lens Studio.
LensStudio:App.versionVariableFiles & System › LensStudio:AppThe Lens Studio version.
LensStudio:AssetInstantiatorModuleAssetsModule providing asset instantiation capabilities for Lens Studio plugins.
LensStudio:AssetInstantiator.AssetInstantiatorClassAssets › LensStudio:AssetInstantiatorPlugin class that manages asset instantiation, initialized with a PluginSystem and optional Descriptor.
LensStudio:AssetInstantiator.DescriptorClassAssets › LensStudio:AssetInstantiatorConfiguration descriptor for the AssetInstantiator plugin, extending BaseDescriptor.
LensStudio:AssetLibraryModuleAssets
LensStudio:AssetLibrary.AssetClassAssets › LensStudio:AssetLibraryA handle for an asset from the Asset Library.
LensStudio:AssetLibrary.AssetFilterClassAssets › LensStudio:AssetLibraryA filter used to narrow down an AssetListRequest.
LensStudio:AssetLibrary.AssetListRequestClassAssets › LensStudio:AssetLibraryA request object for finding assets in the Asset Library.
LensStudio:AssetLibrary.AssetListResponseClassAssets › LensStudio:AssetLibraryA handle returned by the "LensStudio:AssetLibrary".AssetListService.
LensStudio:AssetLibrary.AssetListServiceClassAssets › LensStudio:AssetLibraryA handle to the "LensStudio:AssetLibrary".AssetListService which can provide a list of assets based on the passed in parameters.
LensStudio:AssetLibrary.AssetListSuccessClassAssets › LensStudio:AssetLibraryThe result of a fetch call by the "LensStudio:AssetLibrary".AssetListService, which provides you a list of matching assets in the Asset Library.
LensStudio:AssetLibrary.AssetTypeEnumAssets › LensStudio:AssetLibraryThe types of assets that might be provided by the "LensStudio:AssetLibrary".
LensStudio:AssetLibrary.CreatorClassAssets › LensStudio:AssetLibraryInformation about the creator or author of an Asset Library asset.
LensStudio:AssetLibrary.EnvironmentEnumAssets › LensStudio:AssetLibraryThe Asset Library environment which assets should be searched within.
LensStudio:AssetLibrary.EnvironmentSettingClassAssets › LensStudio:AssetLibraryA configuration object that describes what Asset Library environment should be accessed.
LensStudio:AssetLibrary.GetAssetsByIdsRequestClassAssets › LensStudio:AssetLibraryRequest object for fetching specific assets by their unique identifiers.
LensStudio:AssetLibrary.GetAssetsByIdsResponseClassAssets › LensStudio:AssetLibraryResponse returned when fetching assets by IDs, containing matched assets or an error.
LensStudio:AssetLibrary.GetAssetsByIdsServiceClassAssets › LensStudio:AssetLibraryService interface for submitting get-assets-by-IDs requests.
LensStudio:AssetLibrary.IAssetLibraryProviderClassAssets › LensStudio:AssetLibraryA handle that provides access to the AssetLibraryListService.
LensStudio:AssetLibrary.LicensedMusicClassAssets › LensStudio:AssetLibraryProvides access to licensed music import functionality for adding music assets to a project.
LensStudio:AssetLibrary.MusicAssetClassAssets › LensStudio:AssetLibraryHandle for a music asset from the Asset Library.
LensStudio:AssetLibrary.MusicListResponseClassAssets › LensStudio:AssetLibraryResponse returned from a music list query, containing either a success result or a service error.
LensStudio:AssetLibrary.MusicListServiceClassAssets › LensStudio:AssetLibraryService interface for submitting and managing music list requests.
LensStudio:AssetLibrary.MusicListSuccessClassAssets › LensStudio:AssetLibrarySuccessful result of a music list request, containing the returned music assets.
LensStudio:AssetLibrary.PaginationClassAssets › LensStudio:AssetLibraryConfiguration for the page to be accessed in a "LensStudio:AssetLibrary".AssetFilter.
LensStudio:AssetLibrary.PlatformEnumAssets › LensStudio:AssetLibraryEnum representing the target platform associated with an asset.
LensStudio:AssetLibrary.ResourceClassAssets › LensStudio:AssetLibraryThe actual resources of an "LensStudio:AssetLibrary".Asset.
LensStudio:AssetLibrary.ServiceErrorClassAssets › LensStudio:AssetLibraryThe callback of an errored fetch call by the "LensStudio:AssetLibrary".AssetListService.
LensStudio:AssetLibrary.SpaceEnumAssets › LensStudio:AssetLibraryThe Asset Library space which assets should be searched within.
LensStudio:AssetLibrary.SubcategoryClassAssets › LensStudio:AssetLibraryTag or classification used to further categorize an asset within its primary asset type.
LensStudio:AssetUtils.jsModuleAssets
LensStudio:AssetUtils.js.addDefineFunctionAssets › LensStudio:AssetUtils.jsAdd a define to the pass info's defines array.
LensStudio:AssetUtils.js.addGraphToMaterialFunctionAssets › LensStudio:AssetUtils.jsAdds a pass to the given material and optionally adds define strings to the pass.
LensStudio:AssetUtils.js.createMaterialFromGraphFunctionAssets › LensStudio:AssetUtils.jsCreates a material from a shader graph asset.
LensStudio:AssetUtils.js.findAssetFunctionAssets › LensStudio:AssetUtils.jsFinds an asset in the asset manager based on the specified type, name, and optional parent directory.
LensStudio:AssetUtils.js.findOrCreateNativeAssetFunctionAssets › LensStudio:AssetUtils.jsFinds or creates a native asset with the specified name.
LensStudio:AssetUtils.js.findOrCreateNonNativeAssetFunctionAssets › LensStudio:AssetUtils.jsFinds or creates an asset in the asset manager.
LensStudio:AssetUtils.js.findOrCreateObjectTrackingTextureFunctionAssets › LensStudio:AssetUtils.jsFinds or creates an object tracking texture asset.
LensStudio:AssetUtils.js.findOrCreateScreenTextureFunctionAssets › LensStudio:AssetUtils.jsFinds or creates a screen texture asset.
LensStudio:AssetUtils.js.getResourceFileFunctionAssets › LensStudio:AssetUtils.jsRetrieves the resource file absolute path for the specified asset type.
LensStudio:AssetUtils.js.importImageAsTextureFunctionAssets › LensStudio:AssetUtils.jsImports an image as a texture and sets up its wrap mode.
LensStudio:AssetUtils.js.setupSamplerWrapModeFunctionAssets › LensStudio:AssetUtils.jsSet up the wrap mode for a sampler.
LensStudio:AssetUtils.js.ShaderGraphTypeEnumAssets › LensStudio:AssetUtils.js
LensStudio:ChatAssistantModuleAI & Chat ToolsPlugin module providing a chat assistant interface within Lens Studio.
LensStudio:ChatToolModuleAI & Chat ToolsModule providing base classes and interfaces for building AI-invokable ChatTool plugins in Lens Studio.
LensStudio:ChatTool.ChatToolClassAI & Chat Tools › LensStudio:ChatToolBase class for AI-invokable operations; extend this to implement a tool that the AI can call via execute().
LensStudio:ChatTool.DescriptorClassAI & Chat Tools › LensStudio:ChatToolDefines a ChatTool's identity and metadata, including id, name, description, and dependencies.
LensStudio:ChatTool.IChatToolRegistryClassAI & Chat Tools › LensStudio:ChatToolInterface for registering and discovering ChatTool instances within the plugin system.
LensStudio:ChatTool.ParametersClassAI & Chat Tools › LensStudio:ChatToolHolds the input parameters passed to a ChatTool's execute() call.
LensStudio:ChatTool.ResultClassAI & Chat Tools › LensStudio:ChatToolHolds the outcome of a ChatTool execution, with data on success or an error string on failure.
LensStudio:CladAssistantModuleAI & Chat Tools
LensStudio:ClipboardModuleFiles & SystemModule providing clipboard read/write access for Lens Studio Editor.
LensStudio:Clipboard.ClipboardClassFiles & System › LensStudio:ClipboardRepresents the system clipboard, exposing methods to get and set clipboard content.
LensStudio:ConnectedLensMonitorModulePreview & Publishing
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorMessageClassPreview & Publishing › LensStudio:ConnectedLensMonitor
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorSessionClassPreview & Publishing › LensStudio:ConnectedLensMonitorBase class for all script-accessible Lens Studio objects.
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorSnapshotClassPreview & Publishing › LensStudio:ConnectedLensMonitorBase class for all script-accessible Lens Studio objects.
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorStoreClassPreview & Publishing › LensStudio:ConnectedLensMonitor
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorStoreValueClassPreview & Publishing › LensStudio:ConnectedLensMonitor
LensStudio:ConnectedLensMonitor.ConnectedLensMonitorUserClassPreview & Publishing › LensStudio:ConnectedLensMonitor
LensStudio:ConnectedLensMonitor.IConnectedLensMonitorClassPreview & Publishing › LensStudio:ConnectedLensMonitorInterface for plugin component registration.
LensStudio:CoreServiceModulePluginsBase class and module for creating background plugin services in Lens Studio.
LensStudio:CoreService.CoreServiceClassPlugins › LensStudio:CoreServiceBase class for background plugin services; extend to create a service with start/stop lifecycle and access to the plugin system.
LensStudio:CoreService.DescriptorClassPlugins › LensStudio:CoreServiceDefines a service's identity, name, description, and dependencies for registration with the plugin system.
LensStudio:CryptoModuleFiles & SystemCryptography module providing secure random value generation, UUIDs, and digest operations modeled after the Web Crypto API.
LensStudio:Crypto.getRandomValuesFunctionFiles & System › LensStudio:CryptoFills the given typed array with cryptographically strong random values and returns it.
LensStudio:Crypto.randomUUIDFunctionFiles & System › LensStudio:CryptoGenerates a cryptographically random version 4 UUID string.
LensStudio:Crypto.subtleClassFiles & System › LensStudio:CryptoLower-level cryptographic primitives mirroring the Web Crypto SubtleCrypto interface.
LensStudio:DeviceSettingsModulePreview & Publishing
LensStudio:DeviceTracingModulePreview & Publishing
LensStudio:DeviceTracing.IProfilingCaptureClassPreview & Publishing › LensStudio:DeviceTracingInterface for plugin component registration.
LensStudio:DeviceTracing.ITraceSessionClassPreview & Publishing › LensStudio:DeviceTracingBase class for all script-accessible Lens Studio objects.
LensStudio:DialogPluginModulePluginsModule providing base classes for building dialog-style plugins in Lens Studio.
LensStudio:DialogPlugin.DescriptorClassPlugins › LensStudio:DialogPluginConfiguration descriptor for a DialogPlugin, including menu placement and optional toolbar settings.
LensStudio:DialogPlugin.DialogPluginClassPlugins › LensStudio:DialogPluginBase class for dialog plugins; extend to implement custom dialogs with a createWidget method.
LensStudio:EditorPluginModulePluginsModule providing base classes for building editor plugins that integrate custom editing behavior into Lens Studio.
LensStudio:EditorPlugin.DescriptorClassPlugins › LensStudio:EditorPluginDescriptor for an editor plugin, extending EditorDescriptor with a canEdit predicate to determine which entities the plugin handles.
LensStudio:EditorPlugin.EditorPluginClassPlugins › LensStudio:EditorPluginBase class for editor plugins, constructed with a PluginSystem and optional Descriptor to integrate custom editing logic.
LensStudio:EntityGeneratorModuleProject & SceneModule for generating entities within Lens Studio projects.
LensStudio:EntityGenerator.DescriptorClassProject & Scene › LensStudio:EntityGeneratorConfiguration descriptor for an entity generator, specifying entity type and icon.
LensStudio:EntityGenerator.EntityGeneratorClassProject & Scene › LensStudio:EntityGeneratorConstructs a new entity generator plugin with an optional descriptor.
LensStudio:Event.jsModuleGlobals & Utilities
LensStudio:Event.js.EventClassGlobals & Utilities › LensStudio:Event.jsA type-safe event emitter that supports adding, removing, and triggering listeners.
LensStudio:Event.js.EventListenerType aliasGlobals & Utilities › LensStudio:Event.jsA function that handles event notifications.
LensStudio:Event.js.UnsubscribeType aliasGlobals & Utilities › LensStudio:Event.jsA function that unsubscribes a listener from an event when called.
LensStudio:FileSystemModuleFiles & SystemBefore using anything in this namespace, make sure to import LensStudio:FileSystem and add filesystem in your plugin's module.json.
LensStudio:FileSystem.copyDirFunctionFiles & System › LensStudio:FileSystemOptions can take recursive and force.
LensStudio:FileSystem.CopyDirOptionsClassFiles & System › LensStudio:FileSystemUsed with "LensStudio:FileSystem".CopyDirOptions.
LensStudio:FileSystem.copyFileFunctionFiles & System › LensStudio:FileSystemCopies a file from src to dest.
LensStudio:FileSystem.createDirFunctionFiles & System › LensStudio:FileSystemCreate a directory at path.
LensStudio:FileSystem.CreateDirOptionsClassFiles & System › LensStudio:FileSystemUsed with "LensStudio:FileSystem".CreateDirOptions.
LensStudio:FileSystem.existsFunctionFiles & System › LensStudio:FileSystemChecks if a file or directory exists at path.
LensStudio:FileSystem.isDirectoryFunctionFiles & System › LensStudio:FileSystemChecks whether a path is a directory.
LensStudio:FileSystem.isFileFunctionFiles & System › LensStudio:FileSystemChecks whether a path is a file.
LensStudio:FileSystem.readBytesFunctionFiles & System › LensStudio:FileSystemReturns the content of path as bytes.
LensStudio:FileSystem.readDirFunctionFiles & System › LensStudio:FileSystemReturns an array of paths relative to the specified one.
LensStudio:FileSystem.ReadDirOptionsClassFiles & System › LensStudio:FileSystemUsed with "LensStudio:FileSystem".ReadDirOptions.
LensStudio:FileSystem.readFileFunctionFiles & System › LensStudio:FileSystemReturns the content of path.
LensStudio:FileSystem.realPathFunctionFiles & System › LensStudio:FileSystemResolves a path to its canonical absolute form, following symlinks.
LensStudio:FileSystem.removeFunctionFiles & System › LensStudio:FileSystemRemoves the path.
LensStudio:FileSystem.renameFunctionFiles & System › LensStudio:FileSystemRenames the path.
LensStudio:FileSystem.sizeFunctionFiles & System › LensStudio:FileSystemGet the size of path.
LensStudio:FileSystem.TempDirClassFiles & System › LensStudio:FileSystemHelper to create temporary directory.
LensStudio:FileSystem.WatcherClassFiles & System › LensStudio:FileSystemWatches a file or directory for changes and emits events when modifications occur.
LensStudio:FileSystem.writeFileFunctionFiles & System › LensStudio:FileSystemWrites a file to path given the data.
LensStudio:GeneralUtils.jsModuleGlobals & Utilities
LensStudio:GeneralUtils.js.promisifyFunctionGlobals & Utilities › LensStudio:GeneralUtils.jsConverts a callback-based function to a Promise-based function.
LensStudio:GuiServiceModulePluginsModule providing GUI service plugin infrastructure for Lens Studio.
LensStudio:GuiService.DescriptorClassPlugins › LensStudio:GuiServiceDescriptor object for configuring a GuiService plugin instance.
LensStudio:GuiService.GuiServiceClassPlugins › LensStudio:GuiServicePlugin class managing GUI service registration and initialization within the editor plugin system.
LensStudio:HierarchyUtils.jsModuleProject & Scene
LensStudio:HierarchyUtils.js.CreateOptionsInterfaceProject & Scene › LensStudio:HierarchyUtils.jsRepresents the options for creating a scene object.
LensStudio:HierarchyUtils.js.createOrthoCameraOnObjectFunctionProject & Scene › LensStudio:HierarchyUtils.jsCreates an orthographic camera component on a scene object.
LensStudio:HierarchyUtils.js.createPerspectiveCameraOnObjectFunctionProject & Scene › LensStudio:HierarchyUtils.jsCreates a perspective camera on the specified scene object.
LensStudio:HierarchyUtils.js.findInAncestorsByNameFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds a scene object with the specified name in the ancestors of the given base scene object.
LensStudio:HierarchyUtils.js.findInAncestorsByTypeFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds 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.findInDescendantsByNameFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds a scene object or an array of scene objects in the descendants of a base scene object by name.
LensStudio:HierarchyUtils.js.findInDescendantsByTypeFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds 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.findInRootObjectsByNameFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds a scene object or an array of scene objects in the root objects of a scene by name.
LensStudio:HierarchyUtils.js.findInRootObjectsByTypeFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds objects of a specific component type in the root of a scene.
LensStudio:HierarchyUtils.js.findNearestCameraInAncestorsFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds the nearest camera in the ancestors of the given scene object.
LensStudio:HierarchyUtils.js.findOrCreateCameraObjectFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds or creates a camera object of the specified type within the given scene.
LensStudio:HierarchyUtils.js.findOrCreateChildWithNameFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds or creates a child scene object with the specified name under the given root object.
LensStudio:HierarchyUtils.js.findOrCreateOrthoCameraForObjectFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds or creates an orthographic camera for a given scene object.
LensStudio:HierarchyUtils.js.getFirstCameraInSceneFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds the first camera in the scene.
LensStudio:HierarchyUtils.js.getNearestOrFirstCameraFunctionProject & Scene › LensStudio:HierarchyUtils.jsFinds the nearest camera ancestor of a scene object, if one exists.
LensStudio:HierarchyUtils.js.getOrCreateCanvasFunctionProject & Scene › LensStudio:HierarchyUtils.jsRetrieves or creates a canvas component for a given camera object.
LensStudio:HierarchyUtils.js.getOrCreateScreenRegionFunctionProject & Scene › LensStudio:HierarchyUtils.jsRetrieves or creates a ScreenRegionComponent for a given camera object and scene.
LensStudio:HierarchyUtils.js.SearchOptionsInterfaceProject & Scene › LensStudio:HierarchyUtils.jsRepresents the options for searching.
LensStudio:LcaUtils.jsModuleNetworking
LensStudio:LcaUtils.js.attachLCAHeaderFunctionNetworking › LensStudio:LcaUtils.jsAdds LCA token to Http Request
LensStudio:LensBasedEditorViewModuleUser InterfaceModule providing a live lens preview widget for use inside panel plugins.
LensStudio:LensPreviewModulePreview & PublishingModule providing LensPreview, a headless preview that renders the open project's Lens without a panel or widgets.
LensStudio:LensPreview.LensPreviewClassPreview & Publishing › LensStudio:LensPreviewHeadless preview that renders the project open in Lens Studio without a panel or widgets.
LensStudio:LensPreview.LensPreviewOptionsClassPreview & Publishing › LensStudio:LensPreviewOptions passed to the LensPreview constructor.
LensStudio:LoggerModuleFiles & SystemModule providing log collection and monitoring functionality for Lens Studio plugins.
LensStudio:Logger.IUserLogCollectorClassFiles & System › LensStudio:LoggerPlugin component interface for collecting and exposing user log data.
LensStudio:McpModuleAI & Chat ToolsModel Context Protocol module exposing the in-editor MCP server interface for plugin integrations.
LensStudio:Mcp.IMcpServerClassAI & Chat Tools › LensStudio:McpPlugin component interface for the editor MCP server, exposing connection details and runtime status.
LensStudio:ModelUiModuleUser Interface
LensStudio:ModelUi.EntityReferencePickerLineClassUser Interface › LensStudio:ModelUiLine edit widget for picking entity references by type, backed by an asset manager and entity prototype registry.
LensStudio:MultimediaWidgetsModuleUser InterfaceModule providing multimedia playback widgets, including media player controls for use in Lens Studio editor UI.
LensStudio:NetworkModuleNetworkingBefore using anything in this namespace, make sure to import LensStudio:Network and add network in your plugin's module.json.
LensStudio:Network.AddressClassNetworking › LensStudio:NetworkA TCP Server address.
LensStudio:Network.BaseServerClassNetworking › LensStudio:NetworkBase class for network servers, providing common listen and connection management functionality.
LensStudio:Network.BaseSocketClassNetworking › LensStudio:NetworkBase class for network sockets, providing common send and event handling functionality.
LensStudio:Network.FormDataClassNetworking › LensStudio:NetworkHolds key-value pairs and file attachments for encoding multipart HTTP request bodies.
LensStudio:Network.HttpReplyClassNetworking › LensStudio:NetworkHandle to an in-progress HTTP request returned by performHttpRequestWithReply; must be retained to keep the connection alive.
LensStudio:Network.HttpRequestClassNetworking › LensStudio:NetworkA HTTP Request configuration.
LensStudio:Network.HttpRequest.MethodEnumNetworking › LensStudio:NetworkThe method in which to send the HTTP request.
LensStudio:Network.HttpResponseClassNetworking › LensStudio:NetworkAn HTTP response, received from the callback to performing a request, such as through: "LensStudio:Network".performHttpRequestWithReply, or "LensStudio:Remot…
LensStudio:Network.performAuthorizedHttpRequestFunctionNetworking › LensStudio:NetworkCalls a HTTPS endpoint with authorization to Snapchat.
LensStudio:Network.performHttpRequestFunctionNetworking › LensStudio:NetworkCalls a HTTP endpoint.
LensStudio:Network.performHttpRequestWithReplyFunctionNetworking › LensStudio:NetworkRequest an HTTP call with reply.
LensStudio:Network.TcpServerClassNetworking › LensStudio:NetworkA class to accept TCP connetions.
LensStudio:Network.TcpSocketClassNetworking › LensStudio:NetworkTCP socket for use with "LensStudio:Network".TcpSocket.
LensStudio:PanelPluginModulePluginsModule providing base classes for creating panel-based plugins in Lens Studio.
LensStudio:PanelPlugin.DescriptorClassPlugins › LensStudio:PanelPluginConfiguration descriptor for a PanelPlugin, holding metadata such as id, name, description, and dependencies.
LensStudio:PanelPlugin.EditorDescriptorClassPlugins › LensStudio:PanelPluginBase descriptor class for editor plugins, extended by panel and editor plugin descriptor types.
LensStudio:PanelPlugin.PanelDescriptorClassPlugins › LensStudio:PanelPluginDescriptor subclass specific to panel plugins, used to register a panel with the editor plugin system.
LensStudio:PanelPlugin.PanelPluginClassPlugins › LensStudio:PanelPluginBase class for plugins that create persistent UI panels; extend this and implement createWidget() to build panel UI.
LensStudio:PluginVerifierModulePluginsModule providing base classes for writing plugin verifiers that validate plugin behavior in Lens Studio.
LensStudio:PluginVerifier.DescriptorClassPlugins › LensStudio:PluginVerifierMetadata descriptor for a plugin verifier, including identity fields and a canVerify predicate that selects which plugins to test.
LensStudio:PluginVerifier.PluginVerifierClassPlugins › LensStudio:PluginVerifierBase class for plugin verifiers; extend this to implement a verify() method that tests plugin functionality against the editor.
LensStudio:PresetModulePluginsModule providing the base Preset class and Descriptor for creating editor presets that add objects, assets, or components to a Lens Studio scene.
LensStudio:Preset.DescriptorClassPlugins › LensStudio:PresetDescriptor subclass for presets, extending BaseDescriptor with preset-specific metadata such as import paths and section.
LensStudio:Preset.PresetClassPlugins › LensStudio:PresetBase preset class to extend when defining a plugin that creates scene objects, assets, or components; requires a static descriptor() and an async createAsync…
LensStudio:PreviewModulePreview & PublishingModule providing preview functionality for Lens Studio.
LensStudio:Preview.allImagesFunctionPreview & Publishing › LensStudio:PreviewReturns a promise that resolves to Input values for the sample images bundled with Lens Studio, each with the Multimedia stream type.
LensStudio:Preview.allScenesFunctionPreview & Publishing › LensStudio:PreviewReturns a promise that resolves to Input values for the interactive sample scenes bundled with Lens Studio, each with the Interactive stream type.
LensStudio:Preview.allVideosFunctionPreview & Publishing › LensStudio:PreviewReturns a promise that resolves to Input values for the sample videos bundled with Lens Studio, each with the Multimedia stream type.
LensStudio:Preview.AssetNotReadyClassPreview & Publishing › LensStudio:PreviewPause reason reported when some assets are not ready or a script failed to compile.
LensStudio:Preview.CameraViewEnumPreview & Publishing › LensStudio:PreviewEnum selecting which device camera the preview simulates.
LensStudio:Preview.ConfigClassPreview & Publishing › LensStudio:PreviewPreview input configuration: input source, camera view, simulated device, and input upscale.
LensStudio:Preview.DoubleTapClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.GestureClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.GestureStateEnumPreview & Publishing › LensStudio:Preview
LensStudio:Preview.HoverClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.ImageClassPreview & Publishing › LensStudio:PreviewFrame captured from a preview by screenshot() or tryScreenshot().
LensStudio:Preview.InputClassPreview & Publishing › LensStudio:PreviewPreview input source, made of a source path and a stream type.
LensStudio:Preview.InspectionSessionClassPreview & Publishing › LensStudio:PreviewHandle to the Lens's runtime scene during preview inspection, returned by startInspection().
LensStudio:Preview.InvalidAssetConfigurationClassPreview & Publishing › LensStudio:Preview
LensStudio:Preview.IPreviewProfilingClassPreview & Publishing › LensStudio:PreviewRecords performance traces of a preview.
LensStudio:Preview.PanClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.PausedByUserClassPreview & Publishing › LensStudio:PreviewPause reason reported when the creator pauses the Preview panel or switches it to a paused or inspected stream.
LensStudio:Preview.PinchClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.RenderFailedClassPreview & Publishing › LensStudio:PreviewPause reason reported when rendering fails several times in a row.
LensStudio:Preview.StreamTypeClassPreview & Publishing › LensStudio:PreviewEnum representing the type of preview stream.
LensStudio:Preview.SuspendedClassPreview & Publishing › LensStudio:PreviewPause reason reported while a preview is suspended, for example after LensPreview.pause().
LensStudio:Preview.TapClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.TouchClassPreview & Publishing › LensStudio:PreviewBase class for all script-accessible Lens Studio objects.
LensStudio:Preview.TraceSessionClassPreview & Publishing › LensStudio:PreviewPerformance trace being recorded, returned by IPreviewProfiling.startTrace().
LensStudio:Preview.VideoClassPreview & Publishing › LensStudio:PreviewMP4 video recorded from a preview by recordVideo().
LensStudio:PreviewSimulatorModulePreview & Publishing
LensStudio:ProjectSettingsPluginModulePluginsModule for registering and managing project settings panels in Lens Studio.
LensStudio:ProjectSettingsPlugin.DescriptorClassPlugins › LensStudio:ProjectSettingsPluginConfiguration descriptor for a project settings plugin, holding the section and title used to register the panel.
LensStudio:ProjectSettingsPlugin.ProjectSettingsPluginClassPlugins › LensStudio:ProjectSettingsPluginConstructs a project settings plugin bound to the given plugin system and optional descriptor.
LensStudio:PushToDeviceModulePreview & PublishingPlugin component for pushing lens effects and configurations to physical devices.
LensStudio:RemoteMediaModule.jsModuleNetworking
LensStudio:RemoteMediaModule.js.RemoteMediaModuleClassNetworking › LensStudio:RemoteMediaModule.jsStatic utility class for loading various types of media from URLs.
LensStudio:RemoteServiceModuleModuleNetworkingClass for interacting with Snap's RemoteServiceModule.
LensStudio:RemoteServiceModule.performApiRequestFunctionNetworking › LensStudio:RemoteServiceModulePerform the API request.
LensStudio:RemoteServiceModule.RemoteApiRequestClassNetworking › LensStudio:RemoteServiceModuleConfiguration for request through "LensStudio:RemoteServiceModule".performApiRequest
LensStudio:RemoteServiceModule.RemoteApiResponseClassNetworking › LensStudio:RemoteServiceModuleResponse object from RemoteServiceModule API requests.
LensStudio:RemoteServiceModule.RemoteApiResponse.LinkedResourceClassNetworking › LensStudio:RemoteServiceModuleRepresents a resource linked to the API response.
LensStudio:ScopedStorage.jsModuleFiles & System
LensStudio:ScopedStorage.js.IStorageInterfaceFiles & System › LensStudio:ScopedStorage.jsInterface for safe file system operations within a specified directory
LensStudio:ScopedStorage.js.ScopedStorageClassFiles & System › LensStudio:ScopedStorage.jsProvides safe file system operations within a specified directory.
LensStudio:ScriptEditorModuleUser InterfaceModule for script editing capabilities in Lens Studio.
LensStudio:ScriptEditor.DefinitionsClassUser Interface › LensStudio:ScriptEditorProvides definitions and paths for script editor functionality.
LensStudio:SerializationModuleFiles & System
LensStudio:Serialization.IReaderClassFiles & System › LensStudio:SerializationInterface for reading serialized data.
LensStudio:Serialization.IWriterClassFiles & System › LensStudio:SerializationInterface for writing serializable data.
LensStudio:Serialization.YamlClassFiles & System › LensStudio:SerializationClass which allows you to serialize and deserialize data from YAML.
LensStudio:ShaderCaptureModulePreview & Publishing
LensStudio:ShellModuleFiles & System
LensStudio:Shell.openUrlFunctionFiles & System › LensStudio:ShellOpen a URL with optional query parameters in the default browser.
LensStudio:Shell.showItemInFolderFunctionFiles & System › LensStudio:ShellReveal a file or folder in the system file explorer.
LensStudio:SpkModulePreview & PublishingToolkit for packaging and distributing Lens Studio projects.
LensStudio:SubprocessModuleFiles & SystemBefore using anything in this namespace, make sure to import LensStudio:Subprocess and add subprocess in your plugin's module.json.
LensStudio:Subprocess.ExitStatusEnumFiles & System › LensStudio:SubprocessThe exit status of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync.
LensStudio:Subprocess.ProcessErrorEnumFiles & System › LensStudio:SubprocessThe process error of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync.
LensStudio:Subprocess.ProcessStateEnumFiles & System › LensStudio:SubprocessThe process state of a "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync.
LensStudio:Subprocess.spawnFunctionFiles & System › LensStudio:Subprocessthe 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.SpawnOptionsClassFiles & System › LensStudio:SubprocessThe options of "LensStudio:Subprocess".spawn or "LensStudio:Subprocess".spawnSync.
LensStudio:Subprocess.spawnSyncFunctionFiles & System › LensStudio:Subprocessthe 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.SpawnSyncResultClassFiles & System › LensStudio:SubprocessThe result of "LensStudio:Subprocess".spawnSync.
LensStudio:Subprocess.SubprocessClassFiles & System › LensStudio:SubprocessClass which allows you to trigger a subproccess outside of Lens Studio (e.g. a command line command).
LensStudio:Subprocess.WritableClassFiles & System › LensStudio:SubprocessStream interface for writing to subprocess stdin.
LensStudio:SysInfoModuleFiles & SystemProvides system information for Lens Studio.
LensStudio:SysInfo.buildCpuArchitectureVariableFiles & System › LensStudio:SysInfo
LensStudio:SysInfo.productTypeVariableFiles & System › LensStudio:SysInfoString identifier for the product type.
LensStudio:TypeScriptModuleFiles & SystemModule exposing the editor TypeScript compilation API for triggering and inspecting project compilations.
LensStudio:TypeScript.ITypeScriptCompilationApiClassFiles & System › LensStudio:TypeScriptPlugin component interface for invoking TypeScript compilation on the current project or an isolated tsconfig.
LensStudio:TypeScript.TypeScriptCompilationResultClassFiles & System › LensStudio:TypeScriptResult of a TypeScript compilation run, containing success status and any reported errors.
LensStudio:UiModuleUser Interface
LensStudio:Ui.AbstractButtonClassUser Interface › LensStudio:UiBase class for button widgets with icon and state support.
LensStudio:Ui.AbstractItemViewClassUser Interface › LensStudio:UiBase widget class for views that display a hierarchical or tabular model, such as lists, tables, and trees.
LensStudio:Ui.AbstractMenuClassUser Interface › LensStudio:UiBase class for menu widgets.
LensStudio:Ui.ActionClassUser Interface › LensStudio:UiRepresents an action that can be triggered in the UI.
LensStudio:Ui.AlignmentEnumUser Interface › LensStudio:UiEnum specifying text or widget alignment.
LensStudio:Ui.ArrowPositionEnumUser Interface › LensStudio:UiEnum specifying arrow position for callouts.
LensStudio:Ui.AspectRatioModeEnumUser Interface › LensStudio:UiEnum controlling aspect ratio scaling behavior.
LensStudio:Ui.BackgroundRoleEnumUser Interface › LensStudio:UiEnum specifying background color role.
LensStudio:Ui.BoxLayoutClassUser Interface › LensStudio:UiLayout manager arranging widgets in a row or column.
LensStudio:Ui.CalloutFrameClassUser Interface › LensStudio:UiWidget displaying a callout or tooltip with optional arrow.
LensStudio:Ui.CheckBoxClassUser Interface › LensStudio:UiWidget for toggling a boolean state.
LensStudio:Ui.CheckStateEnumUser Interface › LensStudio:UiEnum representing checkbox state.
LensStudio:Ui.ClearLayoutBehaviorEnumUser Interface › LensStudio:UiEnum controlling layout clearing behavior.
LensStudio:Ui.ClickableLabelClassUser Interface › LensStudio:UiLabel widget that responds to mouse clicks.
LensStudio:Ui.CloseEventClassUser Interface › LensStudio:UiEvent triggered when a window or dialog closes.
LensStudio:Ui.CollapsiblePanelClassUser Interface › LensStudio:UiWidget panel that can be expanded or collapsed.
LensStudio:Ui.ColorClassUser Interface › LensStudio:UiRepresents an RGBA color value.
LensStudio:Ui.ColorButtonClassUser Interface › LensStudio:UiButton for selecting or displaying a color.
LensStudio:Ui.ColorGroupEnumUser Interface › LensStudio:UiEnum specifying color group role.
LensStudio:Ui.ColorRoleEnumUser Interface › LensStudio:UiEnum specifying color role for styling.
LensStudio:Ui.ColorSchemeClassUser Interface › LensStudio:Ui
LensStudio:Ui.ComboBoxClassUser Interface › LensStudio:UiDropdown widget for selecting from a list of options.
LensStudio:Ui.ContextMenuPolicyEnumUser Interface › LensStudio:UiEnum controlling context menu behavior.
LensStudio:Ui.CursorShapeEnumUser Interface › LensStudio:UiEnum specifying mouse cursor shape.
LensStudio:Ui.DialogClassUser Interface › LensStudio:UiModal or modeless dialog window.
LensStudio:Ui.Dialog.CodeEnumUser Interface › LensStudio:UiEnum of dialog result codes (Accepted, Rejected).
LensStudio:Ui.DialogsNamespaceUser Interface › LensStudio:Ui
LensStudio:Ui.Dialogs.OptionsEnumUser Interface › LensStudio:UiOptions for file dialog behavior: Usual for standard selection or DirectoriesOnly to restrict to directories.
LensStudio:Ui.Dialogs.ParamsClassUser Interface › LensStudio:UiConfiguration parameters for file dialogs including caption, file filter, and display options.
LensStudio:Ui.DirectionEnumUser Interface › LensStudio:UiEnum for layout direction in box layouts.
LensStudio:Ui.DockStateEnumUser Interface › LensStudio:UiEnum representing dock widget state.
LensStudio:Ui.DoubleSpinBoxClassUser Interface › LensStudio:UiWidget for entering floating-point numbers.
LensStudio:Ui.EditorsManagerClassUser Interface › LensStudio:UiManages text and code editors.
LensStudio:Ui.EventClassUser Interface › LensStudio:UiBase class for UI input events that can be accepted or ignored by handlers.
LensStudio:Ui.FontRoleEnumUser Interface › LensStudio:UiEnum specifying font role for styling.
LensStudio:Ui.ForegroundRoleEnumUser Interface › LensStudio:UiEnum specifying foreground color role.
LensStudio:Ui.getUrlStringFunctionUser Interface › LensStudio:UiRetrieve a URL string representation.
LensStudio:Ui.GridLayoutClassUser Interface › LensStudio:UiArranges child layouts and widgets in a grid with rows and columns.
LensStudio:Ui.GuiClassUser Interface › LensStudio:UiBuilt-in interface for GUI operations in plugins.
LensStudio:Ui.IconModeEnumUser Interface › LensStudio:UiEnum specifying icon display mode.
LensStudio:Ui.IDialogsClassUser Interface › LensStudio:UiInterface for file and message dialogs.
LensStudio:Ui.IEditorsManagerClassUser Interface › LensStudio:UiInterface for text editor management.
LensStudio:Ui.IGuiClassUser Interface › LensStudio:UiMain interface for accessing UI dialogs, widgets, and workspaces in Lens Studio.
LensStudio:Ui.ImageViewClassUser Interface › LensStudio:UiWidget displaying an image.
LensStudio:Ui.ItemFlagEnumUser Interface › LensStudio:UiBit-flag enum describing per-item capabilities (selectable, editable, draggable, etc.) returned by ScriptableModel.flags().
LensStudio:Ui.KeyEnumUser Interface › LensStudio:UiEnumeration of keyboard keys reported by KeyEvent and bound by Shortcut.
LensStudio:Ui.KeyboardModifierEnumUser Interface › LensStudio:UiEnum representing keyboard modifier keys.
LensStudio:Ui.KeyEventClassUser Interface › LensStudio:UiInput event describing a keyboard key press, including key code, modifiers, and text.
LensStudio:Ui.LabelClassUser Interface › LensStudio:UiWidget displaying read-only text.
LensStudio:Ui.LayoutClassUser Interface › LensStudio:UiBase class for layout managers.
LensStudio:Ui.LineEditClassUser Interface › LensStudio:UiWidget for single-line text input.
LensStudio:Ui.ListWidgetClassUser Interface › LensStudio:UiWidget displaying a scrollable list of items.
LensStudio:Ui.ListWidgetItemClassUser Interface › LensStudio:UiIndividual item in a ListWidget.
LensStudio:Ui.MenuClassUser Interface › LensStudio:UiPopup menu widget.
LensStudio:Ui.MessageBoxClassUser Interface › LensStudio:UiDialog for displaying messages or confirmations.
LensStudio:Ui.MessageBox.IconEnumUser Interface › LensStudio:UiIcon enumeration for message box dialogs.
LensStudio:Ui.MessageBox.StandardButtonEnumUser Interface › LensStudio:UiButton option type that can be clicked in a message dialog.
LensStudio:Ui.MessageBox.StandardButtonsClassUser Interface › LensStudio:UiCollection of button options to display in the message dialog.
LensStudio:Ui.ModelIndexClassUser Interface › LensStudio:UiHandle identifying a single cell within a ScriptableModel by its row, column, and path of parent row indices.
LensStudio:Ui.MouseButtonEnumUser Interface › LensStudio:UiEnum representing mouse button identifiers.
LensStudio:Ui.MouseEventClassUser Interface › LensStudio:UiEvent object containing mouse interaction data.
LensStudio:Ui.MovieClassUser Interface › LensStudio:UiRepresents an animated movie or video file.
LensStudio:Ui.Movie.CacheModeEnumUser Interface › LensStudio:UiEnum specifying how a Movie caches decoded frames.
LensStudio:Ui.MovieViewClassUser Interface › LensStudio:UiWidget for playing movies or animations.
LensStudio:Ui.OrientationEnumUser Interface › LensStudio:UiEnum specifying horizontal or vertical orientation.
LensStudio:Ui.OverflowToolBarClassUser Interface › LensStudio:UiToolbar that collapses into a menu when space is limited.
LensStudio:Ui.PixmapClassUser Interface › LensStudio:UiRepresents an image in memory.
LensStudio:Ui.PopupWithArrowClassUser Interface › LensStudio:UiPopup widget with an arrow pointing to a reference position.
LensStudio:Ui.ProgressBarClassUser Interface › LensStudio:UiWidget displaying a progress bar.
LensStudio:Ui.ProgressIndicatorClassUser Interface › LensStudio:UiWidget showing progress without a specific percentage.
LensStudio:Ui.ProjectSettingsNamespaceUser Interface › LensStudio:Ui
LensStudio:Ui.ProjectSettings.ErrorClassUser Interface › LensStudio:UiRepresents a project settings validation error with a human-readable description.
LensStudio:Ui.ProjectSettings.NoIssueClassUser Interface › LensStudio:UiRepresents a project settings validation result with no issues.
LensStudio:Ui.ProjectSettings.WarningClassUser Interface › LensStudio:UiRepresents a project settings validation warning with a human-readable description.
LensStudio:Ui.PushButtonClassUser Interface › LensStudio:UiClickable button widget.
LensStudio:Ui.QtObjectClassUser Interface › LensStudio:UiBase class for native Qt-backed UI objects exposed to plugin scripts.
LensStudio:Ui.RadioButtonClassUser Interface › LensStudio:UiWidget for selecting one option from a group.
LensStudio:Ui.RadioButtonGroupClassUser Interface › LensStudio:UiManager for radio button groups.
LensStudio:Ui.RectClassUser Interface › LensStudio:UiRepresents a rectangular area with x, y, width, height.
LensStudio:Ui.ScriptableModelClassUser Interface › LensStudio:UiBase class for custom item models implemented in plugin script; subclasses override rowCount, columnCount, data, headerData, flags, index, and roleNames to f…
LensStudio:Ui.SearchableMenuClassUser Interface › LensStudio:UiMenu with search/filter functionality.
LensStudio:Ui.SearchLineEditClassUser Interface › LensStudio:UiLineEdit with search capabilities.
LensStudio:Ui.SectionEnumUser Interface › LensStudio:UiCollapsible section widget for grouping content.
LensStudio:Ui.SeparatorClassUser Interface › LensStudio:UiA horizontal or vertical line widget used to visually separate groups of UI elements.
LensStudio:Ui.ShadowEnumUser Interface › LensStudio:UiEnum specifying shadow effect style.
LensStudio:Ui.ShortcutClassUser Interface › LensStudio:UiKeyboard shortcut bound to a widget that emits a signal when its key sequence is activated.
LensStudio:Ui.ShortcutContextEnumUser Interface › LensStudio:UiEnum specifying the scope in which a Shortcut is active.
LensStudio:Ui.SizeClassUser Interface › LensStudio:UiRepresents width and height dimensions.
LensStudio:Ui.SizePolicyNamespaceUser Interface › LensStudio:Ui
LensStudio:Ui.SizePolicy.PolicyEnumUser Interface › LensStudio:UiEnum defining how a widget resizes along an axis: Fixed, Minimum, MinimumExpanding, Maximum, Preferred, Expanding, or Ignored.
LensStudio:Ui.SizesClassUser Interface › LensStudio:UiCollection of size values.
LensStudio:Ui.SliderClassUser Interface › LensStudio:UiWidget for selecting a value within a range.
LensStudio:Ui.SpinBoxClassUser Interface › LensStudio:UiWidget for entering integer numbers.
LensStudio:Ui.SplitterClassUser Interface › LensStudio:UiWidget dividing a container into resizable sections.
LensStudio:Ui.StackedLayoutClassUser Interface › LensStudio:UiLayout manager displaying one widget at a time.
LensStudio:Ui.StackedWidgetClassUser Interface › LensStudio:UiContainer displaying one child widget at a time.
LensStudio:Ui.StackingModeEnumUser Interface › LensStudio:UiEnum specifying stacking order mode.
LensStudio:Ui.StatusIndicatorClassUser Interface › LensStudio:UiWidget showing status with color or icon.
LensStudio:Ui.TabBarClassUser Interface › LensStudio:UiWidget displaying tabs for switching between panels.
LensStudio:Ui.TextCursorClassUser Interface › LensStudio:UiRepresents cursor position in text.
LensStudio:Ui.TextCursor.MoveModeEnumUser Interface › LensStudio:UiEnum controlling whether moving the cursor moves the anchor or keeps it to extend the selection.
LensStudio:Ui.TextCursor.MoveOperationEnumUser Interface › LensStudio:UiEnum of cursor movement operations such as Start, End, NextWord, StartOfLine, and others.
LensStudio:Ui.TextEditClassUser Interface › LensStudio:UiWidget for multi-line text input.
LensStudio:Ui.ToolbarConfigClassUser Interface › LensStudio:UiConfiguration for toolbar appearance and behavior.
LensStudio:Ui.ToolbarPositionEnumUser Interface › LensStudio:UiEnum specifying toolbar position.
LensStudio:Ui.ToolbarSettingsClassUser Interface › LensStudio:UiSettings for toolbar configuration.
LensStudio:Ui.ToolButtonClassUser Interface › LensStudio:UiButton suitable for toolbar placement.
LensStudio:Ui.TransformationModeEnumUser Interface › LensStudio:UiEnum specifying image transformation mode.
LensStudio:Ui.VerticalScrollAreaClassUser Interface › LensStudio:UiContainer with vertical scrolling.
LensStudio:Ui.VideoViewClassUser Interface › LensStudio:UiWidget for displaying video content.
LensStudio:Ui.WebEngineViewClassUser Interface › LensStudio:UiEmbedded Chromium browser widget for HTML/CSS/JavaScript UI.
LensStudio:Ui.WidgetClassUser Interface › LensStudio:UiBase class for all UI widgets.
LensStudio:UiTestModuleUser InterfaceModule providing synthetic input and widget inspection utilities for driving the Lens Studio UI in integration tests.
LensStudio:UiTest.compareImagesFunctionUser Interface › LensStudio:UiTest
LensStudio:UiTest.createDiffImageFunctionUser Interface › LensStudio:UiTest
LensStudio:UiTest.CursorClassUser Interface › LensStudio:UiTest
LensStudio:UiTest.EventTypeEnumUser Interface › LensStudio:UiTestEnumeration of synthetic event types that can be dispatched to widgets via sendEvent.
LensStudio:UiTest.findChildrenFunctionUser Interface › LensStudio:UiTestReturns descendant widgets of the given widget whose class matches the specified class name.
LensStudio:UiTest.findTopLevelWidgetsFunctionUser Interface › LensStudio:UiTest
LensStudio:UiTest.invokeFunctionUser Interface › LensStudio:UiTestInvokes the named method on the target widget (such as the preview panel) and returns whether the call succeeded.
LensStudio:UiTest.itemActivateFunctionUser Interface › LensStudio:UiTest
LensStudio:UiTest.itemClickFunctionUser Interface › LensStudio:UiTestClicks the item at the given index path within a tree or list widget.
LensStudio:UiTest.itemCollapseFunctionUser Interface › LensStudio:UiTestCollapses the tree item at the given index path within the widget.
LensStudio:UiTest.itemCountFunctionUser Interface › LensStudio:UiTestReturns the number of child items under the given index path within a tree or list widget.
LensStudio:UiTest.itemExpandFunctionUser Interface › LensStudio:UiTestExpands the tree item at the given index path within the widget.
LensStudio:UiTest.itemTextFunctionUser Interface › LensStudio:UiTestReturns the displayed text of the item at the given index path within a tree or list widget.
LensStudio:UiTest.KeyEventFunctionUser Interface › LensStudio:UiTestConstructs a synthetic keyboard event of the given type, key, modifiers, and text for delivery via sendEvent.
LensStudio:UiTest.mainWindowFunctionUser Interface › LensStudio:UiTestReturns the top-level main window widget of the Lens Studio GUI.
LensStudio:UiTest.MouseEventFunctionUser Interface › LensStudio:UiTestConstructs a synthetic mouse event of the given type, button, modifiers, and position for delivery via sendEvent.
LensStudio:UiTest.processEventsFunctionUser Interface › LensStudio:UiTestPumps the Qt event loop for the specified number of milliseconds so pending UI updates are processed.
LensStudio:UiTest.sendEventFunctionUser Interface › LensStudio:UiTestDispatches a synthetic event to the target widget as if the user had triggered it.
LensStudio:UriHandlerPluginModulePluginsModule providing URI handling plugin infrastructure for extending Lens Studio with custom URI scheme handlers.
LensStudio:UriHandlerPlugin.DescriptorClassPlugins › LensStudio:UriHandlerPluginDescriptor for a URI handler plugin, including a predicate function to determine if the handler can process a given URI.
LensStudio:UriHandlerPlugin.UriHandlerPluginClassPlugins › LensStudio:UriHandlerPluginConstructs a URI handler plugin instance bound to the given plugin system and optional descriptor.
LensStudio:UuidModuleFiles & SystemNamespace providing UUID creation and manipulation utilities.
LensStudio:Uuid.fromStringFunctionFiles & System › LensStudio:UuidParses a UUID from its string representation.
LensStudio:Uuid.invalidVariableFiles & System › LensStudio:UuidA UUID instance representing an invalid or null identifier.
LensStudio:Uuid.UuidClassFiles & System › LensStudio:UuidRepresents a universally unique identifier used to reference assets and components.
LensStudio:WebSocketModuleNetworkingModule providing WebSocket client and server classes for bidirectional network communication.
LensStudio:WebSocket.WebSocketClassNetworking › LensStudio:WebSocketClient-side WebSocket connection that can send and receive data over a WebSocket connection.
LensStudio:WebSocket.WebSocketServerClassNetworking › LensStudio:WebSocketServer that accepts incoming WebSocket connections and manages connected client sockets.
LensStudio:WorkspacesModuleUser InterfaceModule for inspecting Lens Studio workspaces and installing custom workspace presets.
LensStudio:Workspaces.DescriptorClassUser Interface › LensStudio:WorkspacesDescribes a workspace preset: its metadata and serialized panel layout.
LensStudio:Workspaces.IWorkspaceManagerClassUser Interface › LensStudio:WorkspacesPlugin 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.MetadataClassUser Interface › LensStudio:WorkspacesDisplay name and icon of a workspace or workspace preset.
LensStudio:Workspaces.PresetHandleClassUser Interface › LensStudio:WorkspacesOpaque handle returned by IWorkspaceManager.register() for an installed workspace preset.
LensStudio:Workspaces.WorkspaceClassUser Interface › LensStudio:WorkspacesA workspace open in Lens Studio: a named tab with its own panel layout.
mat2ClassMath2x2 column-major floating-point matrix.
mat3ClassMathA 3x3 matrix type supporting common linear algebra operations.
mat4ClassMath4x4 matrix used for 3D transformations including rotation, scale, translation, and projection.
MathUtilsClassMathUtility class providing common math operations and constants.
quatClassMathQuaternion type for representing rotations in 3D space.
ScriptObjectClassGlobals & UtilitiesBase class for all script-accessible Lens Studio objects.
SecureLocalStorageClassFiles & SystemProvides encrypted storage for each plugin module's sensitive data, like access tokens.
setIntervalFunctionGlobals & UtilitiesRepeatedly call callback every delayMs milliseconds.
setTimeoutFunctionGlobals & UtilitiesCall callback after delayMs milliseconds.
signal0InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
signal1InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
signal2InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
signal3InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
signal4InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
signal5InterfaceGlobals & UtilitiesAn interface that allows you to bind a callback on connect.
TaskClassGlobals & UtilitiesNamespace providing task management utilities for tracking and coordinating asynchronous operations.
Task.ITaskManagerClassGlobals & Utilities › TaskInterface for a plugin component that manages pending tasks and exposes a promise that resolves when all tasks complete.
Task.TaskManagerClassGlobals & Utilities › TaskConcrete implementation of ITaskManager that tracks and coordinates task completion within the editor.
TextDecoderClassGlobals & UtilitiesDecodes binary data from a Uint8Array into a string using a specified character encoding.
TextEncoderClassGlobals & UtilitiesEncodes strings into UTF-8 byte arrays.
TimeoutClassGlobals & UtilitiesA handle for a timer.
vec2ClassMath2D vector with x and y components, used for 2D positions, directions, and math operations.
vec3ClassMath3-component floating-point vector used for 3D positions, directions, and RGB color values.
vec4ClassMathFour-component float vector used for XYZW coordinates and RGBA color values.
vec4bClassMathA 4-component boolean vector with x/y/z/w and r/g/b/a accessors.