Rendering & Materials
Cameras and render targets, materials, passes and samplers, lights, and shadows.
Commonly used
CameraRenders SceneObjects to one or more Render Target textures.MaterialAn asset that describes how visual objects should appear.PassControls how a mesh will get rendered.LightSourceActs as a source of light in the scene.RenderTargetProviderControls a camera texture resource.
Guides
CubemapsThis guide will walk you through the Cubemap Template which offers several examples of how to create and use cubemaps in Lens Studio.OverviewYou can emit particles in Lens Studio by using the Particles object.CubemapThis guide will walk you through the Cubemap Template which offers several examples of how to create and use cubemaps in Lens Studio.Shadertoy to Lens StudioThis guide provides a reference for transcribing Shadertoy operations to Material Editor in Lens Studio.Light and ShadowAll templates come with a default light source in the scene.Curves in Materials and VFXAnimation Curve Tracks can be utilized in both Materials and VFX.
All APIs in this topic
Add components to a scene object and reference assets and other modules with a script input.
Components, assets, and modules
| API | Description |
|---|---|
| BlurNoiseEstimation | Used to analyze camera input and apply similar image artifacts to AR objects to better blend and match with the real world. |
| Camera | Renders SceneObjects to one or more Render Target textures. |
| CompositionLayerComponent SPECS | Represents a composition layer that is rendered independently from the main scene and composited by the system compositor. |
| CompositionLayerRenderComponent SPECS | Controls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings. |
| LightSource | Acts as a source of light in the scene. |
| Material | An asset that describes how visual objects should appear. |
| RayTracingSettings | Ray Tracing settings for a camera. |
Objects and data
| API | Description |
|---|---|
| CompositionLayer SPECS | |
| DepthStencilRenderTargetProvider | Access to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format. |
| MaterialPropertyOverrides | Overrides the passes of one material on a single visual. |
| Pass | Controls how a mesh will get rendered. |
| PassPropertyOverrides | Overrides the properties of one material pass on a single visual, without affecting other visuals that use the same material. |
| PassWrapper | Similar to Pass, except used by VFXAsset. |
| PropertyOverrides | Overrides material properties on a single visual, without affecting other visuals that use the same material. |
| RenderTargetProvider | Controls a camera texture resource. |
| SamplerWrapper | An accessor for Pass.samplers when using PassWrappers |
| SamplerWrappers | A proxy class that provides the access to the properties of the sampler under the hood of the passes contained in the Material asset and VFXAsset via either… |
| ScreenTextureProvider | Texture providing the current Render Target being rendered. |
| StencilState | The stencil test state for Pass. |
Enums
| API | Description |
|---|---|
| BlendMode | |
| ClearColorOption | Settings for how color will be cleared before rendering. |
| CullMode | Used with Pass's cullMode property. |
| DepthClearOption | Settings for the depth clear option modes on a DepthStencilRenderTargetProvider. |
| FalloffType | The types of light falloff from a LightSource. |
| FrustumCullMode | Mode for setting frustum culling on Pass |
| LightType | The types of light emission from a LightSource. |
| MeshShadowMode | |
| ShadowMapQuality | |
| ShadowType | The types of shadows that a LightSource can cast. |
| StencilClearOption | Stencil buffer clear option. |
| StencilFace | Specifies whether the front and/or back face stencil test will be applied. |
| StencilFunction | Specifies the stencil test function. |
| StencilOperation | Options for specifying the action to take when stencil and depth tests resolve. |