Skip to main content

Assets

Every asset type a plugin can create or edit, materials and passes, animation clips, Gaussian splats, and the Asset Library.

Commonly used

Guides

All APIs in this topic

Create assets with assetManager.createNativeAsset('Material', name, destination) and import modules with import * as Ui from 'LensStudio:Ui'. APIs listed by a short name are in Editor.Assets: AnimationAsset is Editor.Assets.AnimationAsset.

Components, assets, and modules

APIDescription
AnimationAssetRepresents an animation asset with playback timing information.
AssetRepresents an imported asset with cached file and metadata.
AudioTrackAsset
BodyTracking3DAsset3D body tracking asset with optional hand tracking support.
CustomAssetAn instance of a custom asset type defined by an @asset script.
CustomCodeNodeAssetAsset representing a custom code node in a visual graph.
DeviceCameraTextureA native asset that provides the texture from the camera feed.
FaceCropTextureA native asset that provides a cropped region of the input texture, calculated based on face position.
FaceMeshA native asset that provides a 3D mesh of the user's face.
FileMeshAn asset for 3D meshes.
FileTextureAn asset for textures.
FileTexture2DArrayA 2D texture array asset loaded from file containing multiple 2D texture layers.
FileTexture3D3D texture asset imported from an external file.
FileTextureCubemapCubemap texture asset with per-face texture information.
FontFont asset for text rendering.
FontCollectionAn ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.
FontFamilyGroups multiple Font assets into a single family, mapping each to a style (weight + italic).
GaussianSplattingAssetAsset containing Gaussian splats for use with GaussianSplattingVisual.
HairDataAssetNative asset providing data for hair rendering.
HandMeshA render mesh that follows a tracked hand.
HandTracking3DAsset3D hand tracking asset for hand pose and gesture recognition.
ImageMarkerA LensScripting.MarkerAsset for use with Editor.Components.MarkerTrackingComponent
JavaScriptAssetA script asset that is written in JavaScript.
JsonAssetAsset wrapping JSON data.
LensStudio:AssetInstantiatorModule providing asset instantiation capabilities for Lens Studio plugins.
LensStudio:AssetLibrary
LensStudio:AssetUtils.js
LicensedAudioTrackLicensed audio track asset with metadata and runtime source paths.
LocationAssetAsset representing a named location with an identifier and type.
LocationMeshA native asset that provides data for LensScripting.LocationAsset.
MarkdownAssetNative asset for markdown content.
MarkerAssetBase asset for marker tracking with configurable height.
MaterialMaterial asset defining rendering passes and their properties.
MLAssetMachine learning model asset.
NativePackageDescriptorMetadata descriptor for a native package asset.
Object3DAssetBase asset type for 3D object models.
ObjectOwnerBase class for entities which has object and component relationship such as Editor.Assets.Scene and Editor.Assets.ObjectPrefab.
ObjectPrefabReusable object template that can be instantiated in scenes.
ObjectTrackingTextureA native asset that provides information for object tracking texture.
PassRendering pass asset used within a material.
RemoteMLAssetML asset backed by a remote device-dependent resource.
RemoteReferenceAssetReference to a remote asset identified by an asset ID.
RenderMesh3D mesh asset for rendering geometry.
RenderTargetA native asset that provides the target for a camera to provide its output to.
SceneThe entity which will be converted into the Lens scene during project export.
ScriptAssetScript asset that can be attached to scene objects, containing inputs, attachments, and metadata.
SegmentationTextureA native asset that provides information for segmentation texture.
SnapcodeMarkerA native asset that can be used with LensScripting.MarkerTrackingComponent Learn more at LensScripting.SnapcodeMarkerProvider.
SubgraphAssetAsset representing a subgraph embeddable in other graphs.
SupabaseProjectSupabase project asset with connection credentials.
TextureBase texture asset.
TypeScriptAssetTypeScript script asset for Lens Studio plugins.
VectorCompositeVector graphics asset created by importing an SVG file.
VideoTextureTexture asset created by importing a video file.

Objects and data

APIDescription
AssetCompressionSettingsBase type assigned to AssetImportMetadata.compressionSettings to set how an asset is compressed during import.
AssetImporterSettingsEntity subclass representing the structural organization of entities within a scene.
CustomVariationStyleA user-defined named style on a variable Editor.Assets.Font.
DracoCompressionSettingsSets Google Draco geometry compression on a mesh asset; assign to AssetImportMetadata.compressionSettings.
Editor.AnimationClipRepresents an animation clip instance with playback configuration.
Editor.AssetsNamespace containing all asset types for Lens Studio projects.
Editor.GaussianSplattingNamespace providing utilities to create and import Gaussian splatting (GSAF) assets from PLY input files.
Editor.GraphUtility class for converting between binary and YAML representations of graph files.
FileCompressionSettingsBase type for file-backed compression strategies, assigned to AssetImportMetadata.compressionSettings to set the compression applied at import.
FileTextureInfoHolds texture file dimensions.
FileTextureInfo3D3D texture file information including depth.
FontCollectionEntrySingle entry within a FontCollection, pairing a Font or FontFamily asset with weight and italic style attributes.
FontFamilyEntryMaps a single Font asset to a specific style (weight and italic flag) within a FontFamily.
MeshInfoRead-only metadata describing the geometry and rigging of a mesh asset.
NamedInstanceInfoRead-only named axis preset from the font's fvar table, for example "Condensed Bold".
PassBindingDefines a binding parameter for a render pass with metadata for UI presentation and value constraints.
PassConfigurationPlain configuration object describing a Pass asset, blend mode, and shader defines to apply to a PassInfo via setPassConfiguration.
PassInfoThe Editor.Assets.Pass on a Editor.Assets.Material.
PassUiDataShader pass UI configuration data.
PerformanceCompressionSettingsSets runtime-performance-tuned texture compression with optional mipmaps; assign to AssetImportMetadata.compressionSettings.
PhysicsNamespace for physics-related assets and configuration.
RemoteAssetMetadata
RemoteAssetOrganization
RemoteAssetResource
SamplerTexture sampling configuration for filtering, mipmapping, and wrapping modes.
ScriptInputInfoMetadata about a script input parameter.
SetupScriptScript executed during asset package setup.
SizeCompressionSettingsSets size-prioritized texture compression at a configurable quality level; assign to AssetImportMetadata.compressionSettings.
TextureParameterAssociates a texture with a sampler for use in a material pass.
VariationAxisInfoRead-only metadata describing one OpenType variation axis on a variable font.
VersionUsed to set the version of script assets.

Enums

APIDescription
AntialiasingModeThe aliasing mode of Editor.Assets.RenderTarget.
AntialiasingQualityEnum for antialiasing quality levels.
BlendModeThe blendmode of a Editor.Assets.PassInfo.
ClearColorOptionHow a Render Target should be cleared every frame Editor.Assets.RenderTarget.
CullModeEnum that specifies which faces of a mesh to cull during rendering.
DepthBufferStrategyThe depth buffer strategy of a Editor.Assets.RenderTarget.
DepthFunctionHow a Editor.Assets.PassInfo should determine its depth compared to others.
Editor.AnimationLayerBlendModeEnum defining how animation layers blend with the base animation.
Editor.AnimationLayerScaleModeDefines how animation layer scaling is applied to the base animation.
Editor.PlaybackModeEnumeration of animation playback modes.
FilteringModeHow a texture should be sampled.
FrustumCullModeThe same entity as in Lens Scripting.
HandTracking3DHandTypeUsed with {Editor.Assets.HandTracking3DAsset}.
LocationTypeUsed with {Editor.Assets.Location}.
MSAAStrategyEnum for multisample anti-aliasing strategy selection.
ObjectTrackingTextureTypeUsed with Editor.Assets.ObjectTrackingTexture.
PackagePolicyEnum defining how asset packages can be unpacked and their transparency handling.
PassBindingTypeEnum defining types of bindings for render passes.
RemoteAssetType
ScriptTypeThe 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…
SegmentationTypeBuilt in segmentation textures to be used with Editor.Assets.SegmentationTexture.
ShaderTypeEnum of shader type categories.
TextureCompressionLevelQuality preset selecting how aggressively a texture is compressed.
VertexAttributeUsed witih Editor.Assets.FaceMesh
WrapModeOptions for what value is returned when a fetch falls outside the bounds of a texture.