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.
Provider.AnimatedTextureFileProvider
AudioEffectProvider​
Provider for AudioEffectAsset.
Provider.AudioEffectProvider
AudioOutputProvider​
Provider of the Audio Output Audio Track asset.
Provider.AudioOutputProvider
AudioTrackProvider​
Base class for Audio Track providers.
Provider.AudioTrackProvider
AudioOutputProvider
, FileAudioTrackProvider
, FileLicensedSoundProvider
, MicrophoneAudioProvider
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.
Provider.BodyDepthTextureProvider
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.
Provider.BodyNormalsTextureProvider
BodyRenderObjectProvider​
Provider for full Body Mesh render object.
Provider.BodyRenderObjectProvider
CameraTextureProvider​
Provider.CameraTextureProvider
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.
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.
Provider.ColocatedLandmarks3DRenderObjectProvider
ColocatedLandmarksRenderObjectProviderBase​
Provider.ColocatedLandmarksRenderObjectProviderBase
CropTextureProvider​
Base class for Texture Providers that crop an input texture.
Provider.CropTextureProvider
FaceCropTextureProvider
, ObjectTrackingMaskedTextureProvider
, RectCropTextureProvider
DepthStencilRenderTargetProvider​
Access to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.
Provider.DepthStencilRenderTargetProvider
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.
Provider.DepthTextureProvider
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.
Provider.FaceCropTextureProvider
[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.
Provider.FaceImagePickerTextureProvider
FaceRenderObjectProvider​
Mesh provider for a Face Mesh. Accessible through the control
property on a Face Mesh RenderMesh
.
Provider.FaceRenderObjectProvider
FaceTextureProvider​
TextureProvider for face textures. See the Face Texture Guide for more information. Can be accessed using Texture.control on a face texture asset.
Provider.FaceTextureProvider
FileAudioTrackProvider​
Provider for file based Audio Tracks.
Provider.FileAudioTrackProvider
FileLicensedSoundProvider​
A file track provider of the Licensed Sounds from Asset LIbrary.
Provider.FileLicensedSoundProvider
FileTextureProvider​
A TextureProvider for textures originating from files.
Provider.FileTextureProvider
[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.
Provider.ImagePickerTextureProvider
FaceImagePickerTextureProvider
LocationRenderObjectProvider​
Provides access to a location's Mesh--such as when working with City Scale AR. Usually used in conjunction with LocationTextureProvider
.
Provider.LocationRenderObjectProvider
LocationTextureProvider​
Provides access to a location's texture--such as when working with City Scale AR.
Provider.LocationTextureProvider
MapTextureProvider​
A texture of the map at the given location of a LocationAsset
.
Provider.MapTextureProvider
MarkerProvider​
Base class for marker providers. For more information, see the Marker Tracking guide.
Provider.MarkerProvider
SnapcodeMarkerProvider
MediaPickerTextureProvider​
Base class for Texture Providers based on selectable media.
Provider.MediaPickerTextureProvider
ImagePickerTextureProvider
MeshRenderObjectProvider​
Provider.MeshRenderObjectProvider
ProceduralMeshRenderObjectProvider
MicrophoneAudioProvider​
The Audio Track Provider of the audio from microphone.
Provider.MicrophoneAudioProvider
ObjectTrackingMaskedTextureProvider​
Provider.ObjectTrackingMaskedTextureProvider
ObjectTrackingNormalsTextureProvider
, ObjectTrackingTextureProvider
ObjectTrackingNormalsTextureProvider​
Provider.ObjectTrackingNormalsTextureProvider
ObjectTrackingTextureProvider​
Controls a segmentation texture and its placement using information provided by Object tracking.
Provider.ObjectTrackingTextureProvider
ProceduralMeshRenderObjectProvider​
RenderObjectProvider for mesh objects generated procedurally.
Provider.ProceduralMeshRenderObjectProvider
ProceduralTextureProvider​
Provides a texture that can be written to or read from. Can be accessed using Texture.control on a Procedural Texture.
Provider.ProceduralTextureProvider
Provider​
Base class for all resource providers.
Provider
AudioEffectProvider
, AudioTrackProvider
, MarkerProvider
, RenderObjectProvider
, TextureProvider
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.
Provider.RectCropTextureProvider
RenderObjectProvider​
Provider for RenderMesh data.
RenderObjectProvider
BodyRenderObjectProvider
, ColocatedLandmarksRenderObjectProviderBase
, FaceRenderObjectProvider
, LocationRenderObjectProvider
, MeshRenderObjectProvider
, UpperBodyRenderObjectProvider
, WorldRenderObjectProvider
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.
Provider.RenderTargetProvider
RenderTargetProvider.TextureType
ScreenTextureProvider​
Texture providing the current Render Target being rendered.
Provider.ScreenTextureProvider
SegmentationTextureProvider​
Controls a segmentation texture resource. Can be accessed through Texture.control on a Segmentation texture. For more information, see the Segmentation guide.
Provider.SegmentationTextureProvider
SnapcodeMarkerProvider​
Provides a marker for tracking Snapcodes. For more information, see the Marker Tracking guide.
Provider.SnapcodeMarkerProvider
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.
Provider.TextProvider
TextureProvider​
The base class for specialized Texture providers. Can be accessed through Texture.control.
TextureProvider
AnimatedTextureFileProvider
, BodyDepthTextureProvider
, BodyNormalsTextureProvider
, CameraTextureProvider
, CropTextureProvider
, DepthStencilRenderTargetProvider
, DepthTextureProvider
, FaceTextureProvider
, FileTextureProvider
, LocationTextureProvider
, MapTextureProvider
, MediaPickerTextureProvider
, ProceduralTextureProvider
, RenderTargetProvider
, ScreenTextureProvider
, SegmentationTextureProvider
, TextProvider
, VideoTextureProvider
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.
Provider.UpperBodyRenderObjectProvider
VideoTextureProvider​
Controls a video texture resource. Can be accessed through Texture.control.
Provider.VideoTextureProvider
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.
Provider.WorldRenderObjectProvider