Skip to main content

Rendering & Materials

Cameras and render targets, materials, passes and samplers, lights, and shadows.

Commonly used

Guides

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

APIDescription
BlurNoiseEstimationUsed to analyze camera input and apply similar image artifacts to AR objects to better blend and match with the real world.
CameraRenders SceneObjects to one or more Render Target textures.
CompositionLayerComponent SPECSRepresents a composition layer that is rendered independently from the main scene and composited by the system compositor.
CompositionLayerRenderComponent SPECSControls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings.
LightSourceActs as a source of light in the scene.
MaterialAn asset that describes how visual objects should appear.
RayTracingSettingsRay Tracing settings for a camera.

Objects and data

APIDescription
CompositionLayer SPECS
DepthStencilRenderTargetProviderAccess to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.
MaterialPropertyOverridesOverrides the passes of one material on a single visual.
PassControls how a mesh will get rendered.
PassPropertyOverridesOverrides the properties of one material pass on a single visual, without affecting other visuals that use the same material.
PassWrapperSimilar to Pass, except used by VFXAsset.
PropertyOverridesOverrides material properties on a single visual, without affecting other visuals that use the same material.
RenderTargetProviderControls a camera texture resource.
SamplerWrapperAn accessor for Pass.samplers when using PassWrappers
SamplerWrappersA 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…
ScreenTextureProviderTexture providing the current Render Target being rendered.
StencilStateThe stencil test state for Pass.

Enums

APIDescription
BlendMode
ClearColorOptionSettings for how color will be cleared before rendering.
CullModeUsed with Pass's cullMode property.
DepthClearOptionSettings for the depth clear option modes on a DepthStencilRenderTargetProvider.
FalloffTypeThe types of light falloff from a LightSource.
FrustumCullModeMode for setting frustum culling on Pass
LightTypeThe types of light emission from a LightSource.
MeshShadowMode
ShadowMapQuality
ShadowTypeThe types of shadows that a LightSource can cast.
StencilClearOptionStencil buffer clear option.
StencilFaceSpecifies whether the front and/or back face stencil test will be applied.
StencilFunctionSpecifies the stencil test function.
StencilOperationOptions for specifying the action to take when stencil and depth tests resolve.