Class ScriptableRendererFeature
You can add a ScriptableRendererFeature to the ScriptableRenderer. Use this scriptable renderer feature to inject render passes into the renderer.
Implements
Inherited Members
Namespace: UnityEngine.Rendering.Universal
Assembly: Unity.RenderPipelines.Universal.Runtime.dll
Syntax
[ExcludeFromPreset]
public abstract class ScriptableRendererFeature : ScriptableObject, IDisposableProperties
isActive
Returns the state of the ScriptableRenderFeature (true: the feature is active, false: the feature is inactive). Use the method ScriptableRenderFeature.SetActive to change the value of this variable.
Declaration
public bool isActive { get; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Methods
AddRenderPasses(ScriptableRenderer, ref RenderingData)
Injects one or multiple ScriptableRenderPass in the renderer.
Declaration
public abstract void AddRenderPasses(ScriptableRenderer renderer, ref RenderingData renderingData)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableRenderer | renderer | Renderer used for adding render passes. |
| RenderingData | renderingData | Rendering state. Use this to setup render passes. |
See Also
Create()
Initializes this feature's resources. This is called every time serialization happens.
Declaration
public abstract void Create()See Also
Dispose()
Disposable pattern implementation. Cleans up resources used by the renderer.
Declaration
public void Dispose()See Also
Dispose(bool)
Called by Dispose(). Override this function to clean up resources in your renderer.
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
See Also
OnCameraPreCull(ScriptableRenderer, in CameraData)
Callback before cull happens in renderer.
Declaration
public virtual void OnCameraPreCull(ScriptableRenderer renderer, in CameraData cameraData)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableRenderer | renderer | Renderer of callback. |
| CameraData | cameraData | CameraData contains all relevant render target information for the camera. |
See Also
SetActive(bool)
Sets the state of ScriptableRenderFeature (true: the feature is active, false: the feature is inactive). If the feature is active, it is added to the renderer it is attached to, otherwise the feature is skipped while rendering.
Declaration
public void SetActive(bool active)Parameters
| Type | Name | Description |
|---|---|---|
| bool | active | The true value activates the ScriptableRenderFeature and the false value deactivates it. |
See Also
SetupRenderPasses(ScriptableRenderer, in RenderingData)
Callback after render targets are initialized. This allows for accessing targets from renderer after they are created and ready.
Declaration
public virtual void SetupRenderPasses(ScriptableRenderer renderer, in RenderingData renderingData)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableRenderer | renderer | Renderer used for adding render passes. |
| RenderingData | renderingData | Rendering state. Use this to setup render passes. |