Struct AOVRequestData
Describes a frame pass.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
public struct AOVRequestData
Constructors
AOVRequestData(AOVRequest, AOVRequestBufferAllocator, List<GameObject>, AOVBuffers[], CustomPassAOVBuffers[], AOVRequestCustomPassBufferAllocator, FramePassCallbackEx)
Create a new frame pass.
Declaration
public AOVRequestData(AOVRequest settings, AOVRequestBufferAllocator bufferAllocator, List<GameObject> lightFilter, AOVBuffers[] requestedAOVBuffers, CustomPassAOVBuffers[] customPassAOVBuffers, AOVRequestCustomPassBufferAllocator customPassBufferAllocator, FramePassCallbackEx callback)
Parameters
Type | Name | Description |
---|---|---|
AOVRequest | settings | Settings to use. |
AOVRequestBufferAllocator | bufferAllocator | Buffer allocators to use. |
List<GameObject> | lightFilter | If null, all light will be rendered, if not, only those light will be rendered. |
AOVBuffers[] | requestedAOVBuffers | The requested buffers for the callback. |
CustomPassAOVBuffers[] | customPassAOVBuffers | The custom pass buffers that will be captured. |
AOVRequestCustomPassBufferAllocator | customPassBufferAllocator | Buffer allocators to use for custom passes. |
FramePassCallbackEx | callback | The callback to execute. |
AOVRequestData(AOVRequest, AOVRequestBufferAllocator, List<GameObject>, AOVBuffers[], FramePassCallback)
Create a new frame pass.
Declaration
public AOVRequestData(AOVRequest settings, AOVRequestBufferAllocator bufferAllocator, List<GameObject> lightFilter, AOVBuffers[] requestedAOVBuffers, FramePassCallback callback)
Parameters
Type | Name | Description |
---|---|---|
AOVRequest | settings | Settings to use. |
AOVRequestBufferAllocator | bufferAllocator | Buffer allocators to use. |
List<GameObject> | lightFilter | If null, all light will be rendered, if not, only those light will be rendered. |
AOVBuffers[] | requestedAOVBuffers | The requested buffers for the callback. |
FramePassCallback | callback | The callback to execute. |
Fields
default
Default frame pass settings.
Declaration
[Obsolete("Since 2019.3, use AOVRequestData.NewDefault() instead.")]
public static readonly AOVRequestData @default
Field Value
Type | Description |
---|---|
AOVRequestData |
defaultAOVRequestDataNonAlloc
Default frame pass settings.
Declaration
public static readonly AOVRequestData defaultAOVRequestDataNonAlloc
Field Value
Type | Description |
---|---|
AOVRequestData |
Properties
isValid
Whether this frame pass is valid.
Declaration
public bool isValid { get; }
Property Value
Type | Description |
---|---|
bool |
overrideRenderFormat
Whether internal rendering should be done at the same format as the user allocated AOV output buffer.
Declaration
public bool overrideRenderFormat { get; }
Property Value
Type | Description |
---|---|
bool |
Methods
AllocateTargetTexturesIfRequired(ref List<RTHandle>)
Allocate texture if required.
Declaration
public void AllocateTargetTexturesIfRequired(ref List<RTHandle> textures)
Parameters
Type | Name | Description |
---|---|---|
List<RTHandle> | textures | A buffer of texture ready to use. |
AllocateTargetTexturesIfRequired(ref List<RTHandle>, ref List<RTHandle>)
Allocate texture if required.
Declaration
public void AllocateTargetTexturesIfRequired(ref List<RTHandle> textures, ref List<RTHandle> customPassTextures)
Parameters
Type | Name | Description |
---|---|---|
List<RTHandle> | textures | A buffer of textures ready to use. |
List<RTHandle> | customPassTextures | A buffer of textures ready to use for custom pass AOVs. |
Execute(CommandBuffer, List<RTHandle>, List<RTHandle>, RenderOutputProperties)
Execute the frame pass callback. It assumes that the textures are properly initialized and filled.
Declaration
public void Execute(CommandBuffer cmd, List<RTHandle> framePassTextures, List<RTHandle> customPassTextures, RenderOutputProperties outputProperties)
Parameters
Type | Name | Description |
---|---|---|
CommandBuffer | cmd | The command buffer to use. |
List<RTHandle> | framePassTextures | The textures to use. |
List<RTHandle> | customPassTextures | The custom pass AOV textures to use. |
RenderOutputProperties | outputProperties | The properties computed for this frame. |
Execute(CommandBuffer, List<RTHandle>, RenderOutputProperties)
Execute the frame pass callback. It assumes that the textures are properly initialized and filled.
Declaration
public void Execute(CommandBuffer cmd, List<RTHandle> framePassTextures, RenderOutputProperties outputProperties)
Parameters
Type | Name | Description |
---|---|---|
CommandBuffer | cmd | The command buffer to use. |
List<RTHandle> | framePassTextures | The textures to use. |
RenderOutputProperties | outputProperties | The properties computed for this frame. |
IsLightEnabled(GameObject)
Whether a light should be rendered.
Declaration
public bool IsLightEnabled(GameObject gameObject)
Parameters
Type | Name | Description |
---|---|---|
GameObject | gameObject | The game object of the light to be rendered. |
Returns
Type | Description |
---|---|
bool |
|
NewDefault()
Instantiate a new AOV request data with default values.
Note: Allocates memory by the garbage collector. If you intend only to read the default values, you should use defaultAOVRequestDataNonAlloc.
Declaration
public static AOVRequestData NewDefault()
Returns
Type | Description |
---|---|
AOVRequestData | A new AOV request data with default values. |
SetupDebugData(ref DebugDisplaySettings)
Setup the display manager if necessary.
Declaration
public void SetupDebugData(ref DebugDisplaySettings debugDisplaySettings)
Parameters
Type | Name | Description |
---|---|---|
DebugDisplaySettings | debugDisplaySettings |