Skip to main content

Providers

Providers supply and control various resources within Lens Studio.

AnimatedTextureFileProvider​

Controls an animated texture resource. Can be accessed from Texture.control on an animated texture. See also: 2D Animation Guide.

Lens Studio v1.0.0+
Scripting Name: Provider.AnimatedTextureFileProvider
Inherits from TextureProvider

AudioEffectProvider​

Provider for AudioEffectAsset.

Lens Studio v1.7.0+
Scripting Name: Provider.AudioEffectProvider
Inherits from Provider

AudioOutputProvider​

Provider of the Audio Output Audio Track asset.

Lens Studio v4.0+
Scripting Name: Provider.AudioOutputProvider
Inherits from AudioTrackProvider

AudioTrackProvider​

Base class for Audio Track providers.

Lens Studio v3.4+
Scripting Name: Provider.AudioTrackProvider
Inherits from Provider

BodyDepthTextureProvider​

Provides depth values of the tracked body encoded as D24_UNORM_S8_UINT in screen resolution. Depth is normalized between 0-1, and the stencil component is ignored. The values may be remapped from normalized units (0 to 1) to negative centimeters from the camera (-near in cm to -far in cm) using the Depth Map mode of the Texture 2D Sample node in Material Editor.

Lens Studio v4.19.0+
Scripting Name: Provider.BodyDepthTextureProvider
Inherits from TextureProvider

BodyNormalsTextureProvider​

Provides surface normal values of the tracked body encoded as RGBA (x, y, z, confidence) in R8G8B8A8_UNORM format in screen resolution. The XYZ values may need to be remapped from [0 -> 1] to [-1 -> 1] using the "Normal Map" mode of the Texture 2D Sample node in Material Editor.

Lens Studio v4.19.0+
Scripting Name: Provider.BodyNormalsTextureProvider
Inherits from TextureProvider

BodyRenderObjectProvider​

Provider for full Body Mesh render object.

Lens Studio v4.0+
Scripting Name: Provider.BodyRenderObjectProvider
Inherits from RenderObjectProvider

CameraTextureProvider​

Lens Studio v4.49.0+
Scripting Name: Provider.CameraTextureProvider
Inherits from TextureProvider

ColocatedLandmarks2DRenderObjectProvider​

Not usable from JS. Accessed via the Colocated Landmarks 2D Mesh resource. Contains the 2D keypoints when creating a Colocated map. Expanded by the material provided with template.

Lens Studio v4.0+
Scripting Name: Provider.ColocatedLandmarks2DRenderObjectProvider

ColocatedLandmarks3DRenderObjectProvider​

Not usable from JS. Accessed via the Colocated Landmarks 3D Mesh resource. Contains the 3D landmarks when creating a Colocated map. Expanded by the material provided with template.

Lens Studio v4.0+
Scripting Name: Provider.ColocatedLandmarks3DRenderObjectProvider

ColocatedLandmarksRenderObjectProviderBase​

Lens Studio v4.0+
Scripting Name: Provider.ColocatedLandmarksRenderObjectProviderBase
Inherits from RenderObjectProvider

CropTextureProvider​

Base class for Texture Providers that crop an input texture.

Lens Studio v3.0+
Scripting Name: Provider.CropTextureProvider
Inherits from TextureProvider

DepthStencilRenderTargetProvider​

Access to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.

Lens Studio v4.1+
Scripting Name: Provider.DepthStencilRenderTargetProvider
Inherits from TextureProvider

DepthTextureProvider​

Provides depth information of the video feed that the Lens is being applied to when available, such as in Lenses for Spectacles 3. Can be accessed from mainPass.baseTex.control of a Spectacles Depth material.

See the Lenses for Spectacles guide for more information.

Lens Studio v2.2+
Scripting Name: Provider.DepthTextureProvider
Inherits from TextureProvider

FaceCropTextureProvider​

Texture Provider giving a cropped region of the input texture, calculated based on face position. Can be accessed using Texture.control on a FaceCropTexture asset. For more information, see the Crop Textures guide.

Lens Studio v3.0+
Scripting Name: Provider.FaceCropTextureProvider
Inherits from CropTextureProvider

[DEPRECATED] FaceImagePickerTextureProvider​

Controls the face image picker texture resource. Can be accessed through Texture.control on a Face Image Picker texture. For more information, see the Face Image Picker Texture guide.

Lens Studio v1.7.0+
Scripting Name: Provider.FaceImagePickerTextureProvider

FaceRenderObjectProvider​

Mesh provider for a Face Mesh. Accessible through the control property on a Face Mesh RenderMesh.

Lens Studio v2.3+
Scripting Name: Provider.FaceRenderObjectProvider
Inherits from RenderObjectProvider

FaceTextureProvider​

TextureProvider for face textures. See the Face Texture Guide for more information. Can be accessed using Texture.control on a face texture asset.

Lens Studio v1.5.0+
Scripting Name: Provider.FaceTextureProvider
Inherits from TextureProvider

FileAudioTrackProvider​

Provider for file based Audio Tracks.

Lens Studio v3.4+
Scripting Name: Provider.FileAudioTrackProvider
Inherits from AudioTrackProvider

FileLicensedSoundProvider​

A file track provider of the Licensed Sounds from Asset LIbrary.

Lens Studio v4.10.0+
Scripting Name: Provider.FileLicensedSoundProvider
Inherits from AudioTrackProvider

FileTextureProvider​

A TextureProvider for textures originating from files.

Lens Studio v1.0.0+
Scripting Name: Provider.FileTextureProvider
Inherits from TextureProvider

[DEPRECATED] ImagePickerTextureProvider​

Controls an image picker texture and UI. Can be accessed through Texture.control on an Image Picker texture. For more information, see the Image Picker Texture guide.

Lens Studio v1.7.0+
Scripting Name: Provider.ImagePickerTextureProvider

LocationRenderObjectProvider​

Provides access to a location's Mesh--such as when working with City Scale AR. Usually used in conjunction with LocationTextureProvider.

Lens Studio v4.12.0+
Scripting Name: Provider.LocationRenderObjectProvider
Inherits from RenderObjectProvider

LocationTextureProvider​

Provides access to a location's texture--such as when working with City Scale AR.

Lens Studio v4.19.0+
Scripting Name: Provider.LocationTextureProvider
Inherits from TextureProvider

MapTextureProvider​

A texture of the map at the given location of a LocationAsset.

Lens Studio v5.0.0+
Scripting Name: Provider.MapTextureProvider
Inherits from TextureProvider

MarkerProvider​

Base class for marker providers. For more information, see the Marker Tracking guide.

Lens Studio v1.7.0+
Scripting Name: Provider.MarkerProvider
Inherits from Provider
Child Classes: SnapcodeMarkerProvider

MediaPickerTextureProvider​

Base class for Texture Providers based on selectable media.

Lens Studio v4.0+
Scripting Name: Provider.MediaPickerTextureProvider
Inherits from TextureProvider

MeshRenderObjectProvider​

Lens Studio v4.55.0+
Scripting Name: Provider.MeshRenderObjectProvider
Inherits from RenderObjectProvider

MicrophoneAudioProvider​

The Audio Track Provider of the audio from microphone.

Lens Studio v3.4+
Scripting Name: Provider.MicrophoneAudioProvider
Inherits from AudioTrackProvider

ObjectTrackingMaskedTextureProvider​

Lens Studio v4.49.0+
Scripting Name: Provider.ObjectTrackingMaskedTextureProvider
Inherits from CropTextureProvider

ObjectTrackingNormalsTextureProvider​

Lens Studio v4.49.0+
Scripting Name: Provider.ObjectTrackingNormalsTextureProvider

ObjectTrackingTextureProvider​

Controls a segmentation texture and its placement using information provided by Object tracking.

Lens Studio v3.2+
Scripting Name: Provider.ObjectTrackingTextureProvider

ProceduralMeshRenderObjectProvider​

RenderObjectProvider for mesh objects generated procedurally.

Lens Studio v1.0.0+
Scripting Name: Provider.ProceduralMeshRenderObjectProvider

ProceduralTextureProvider​

Provides a texture that can be written to or read from. Can be accessed using Texture.control on a Procedural Texture.

Lens Studio v3.0+
Scripting Name: Provider.ProceduralTextureProvider
Inherits from TextureProvider

Provider​

Base class for all resource providers.

Lens Studio v2.3+
Scripting Name: Provider
Inherits from ScriptObject

RectCropTextureProvider​

Texture Provider providing a cropped region of the input texture. The region is specified by the cropRect in local space and rotation. Can be accessed using Texture.control on a RectCropTexture asset, such as a Screen Crop Texture. For more information, see the Crop Textures guide.

Lens Studio v3.0+
Scripting Name: Provider.RectCropTextureProvider
Inherits from CropTextureProvider

RenderObjectProvider​

Provider for RenderMesh data.

Lens Studio v1.0.0+
Scripting Name: RenderObjectProvider
Inherits from Provider

RenderTargetProvider​

Controls a camera texture resource. Can be accessed through Texture.control on a Camera texture. For more information, see the Camera and Layers guide.

Lens Studio v1.7.0+
Scripting Name: Provider.RenderTargetProvider
Inherits from TextureProvider

ScreenTextureProvider​

Texture providing the current Render Target being rendered.

Lens Studio v3.0+
Scripting Name: Provider.ScreenTextureProvider
Inherits from TextureProvider

SegmentationTextureProvider​

Controls a segmentation texture resource. Can be accessed through Texture.control on a Segmentation texture. For more information, see the Segmentation guide.

Lens Studio v1.7.0+
Scripting Name: Provider.SegmentationTextureProvider
Inherits from TextureProvider

SnapcodeMarkerProvider​

Provides a marker for tracking Snapcodes. For more information, see the Marker Tracking guide.

Lens Studio v1.7.0+
Scripting Name: Provider.SnapcodeMarkerProvider
Inherits from MarkerProvider

TextProvider​

Controls a text rendering texture. Can be accessed through the main rendering pass on a Label component. The properties here mirror those on Label.

Lens Studio v1.7.0+
Scripting Name: Provider.TextProvider
Inherits from TextureProvider

UpperBodyRenderObjectProvider​

Provides a render object of the upper body, without the head. Unlike BodyMesh which handles the whole body, this model is optimized to work better with FaceMesh and selfie use cases.

Lens Studio v5.2.0+
Scripting Name: Provider.UpperBodyRenderObjectProvider
Inherits from RenderObjectProvider

VideoTextureProvider​

Controls a video texture resource. Can be accessed through Texture.control.

Lens Studio v1.5.0+
Scripting Name: Provider.VideoTextureProvider
Inherits from TextureProvider

WorldRenderObjectProvider​

Provider for RenderMesh data representing the estimated shape of real world objects generated from depth information. Only available when world mesh tracking is supported and enabled.

Lens Studio v3.2+
Scripting Name: Provider.WorldRenderObjectProvider
Inherits from RenderObjectProvider
Was this page helpful?
Yes
No

AI-Powered Search