Struct AOVRequest
Use this request to define how to render an AOV.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
public struct AOVRequest
Constructors
AOVRequest(AOVRequest)
Create a new instance by copying values from other
.
Declaration
public AOVRequest(AOVRequest other)
Parameters
Type | Name | Description |
---|---|---|
AOVRequest | other |
Fields
default
Default settings.
Declaration
[Obsolete("Since 2019.3, use AOVRequest.NewDefault() instead.")]
public static readonly AOVRequest @default
Field Value
Type | Description |
---|---|
AOVRequest |
Methods
Equals(object)
Equality operator.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The AOV request to compare to. |
Returns
Type | Description |
---|---|
bool | True if the provided AOV request is equal to this. |
Overrides
FillDebugData(DebugDisplaySettings)
Populate the debug display settings with the AOV data.
Declaration
public void FillDebugData(DebugDisplaySettings debug)
Parameters
Type | Name | Description |
---|---|---|
DebugDisplaySettings | debug | The debug display settings to fill. |
GetHashCode()
Computes a hash code for the AOV Request.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | A hash code for the AOV Request. |
Overrides
NewDefault()
Default settings.
Declaration
public static AOVRequest NewDefault()
Returns
Type | Description |
---|---|
AOVRequest |
SetFullscreenOutput(MaterialSharedProperty)
State the property to render. In case of several SetFullscreenOutput chained call, only last will be used.
Declaration
public ref AOVRequest SetFullscreenOutput(MaterialSharedProperty materialProperty)
Parameters
Type | Name | Description |
---|---|---|
MaterialSharedProperty | materialProperty | The property to render. |
Returns
Type | Description |
---|---|
AOVRequest | A ref return to chain calls. |
SetFullscreenOutput(DebugFullScreen)
State the property to render. In case of several SetFullscreenOutput chained call, only last will be used.
Declaration
public ref AOVRequest SetFullscreenOutput(DebugFullScreen debugFullScreen)
Parameters
Type | Name | Description |
---|---|---|
DebugFullScreen | debugFullScreen | The property to render. |
Returns
Type | Description |
---|---|
AOVRequest | A ref return to chain calls. |
SetFullscreenOutput(LightingProperty)
State the property to render. In case of several SetFullscreenOutput chained call, only last will be used.
Declaration
public ref AOVRequest SetFullscreenOutput(LightingProperty lightingProperty)
Parameters
Type | Name | Description |
---|---|---|
LightingProperty | lightingProperty | The property to render. |
Returns
Type | Description |
---|---|
AOVRequest | A ref return to chain calls. |
SetLightFilter(DebugLightFilterMode)
Set the light filter to use.
Declaration
public ref AOVRequest SetLightFilter(DebugLightFilterMode filter)
Parameters
Type | Name | Description |
---|---|---|
DebugLightFilterMode | filter | The light filter to use |
Returns
Type | Description |
---|---|
AOVRequest | A ref return to chain calls. |
SetOverrideRenderFormat(bool)
Allows AOVs to be rendered at the same format/precision as the user allocated buffers.
Declaration
public ref AOVRequest SetOverrideRenderFormat(bool flag)
Parameters
Type | Name | Description |
---|---|---|
bool | flag | Set to true to override the rendering buffer format |
Returns
Type | Description |
---|---|
AOVRequest | A ref return to chain calls. |
Operators
operator ==(AOVRequest, AOVRequest)
Compares if two AOV requests have the same settings.
Declaration
public static bool operator ==(AOVRequest a, AOVRequest b)
Parameters
Type | Name | Description |
---|---|---|
AOVRequest | a | The first AOVRequest to compare. |
AOVRequest | b | The second AOVRequest to compare. |
Returns
Type | Description |
---|---|
bool | True if the two AOV requests have the same settings. |
operator !=(AOVRequest, AOVRequest)
Compares if two AOV requests have the same settings.
Declaration
public static bool operator !=(AOVRequest a, AOVRequest b)
Parameters
Type | Name | Description |
---|---|---|
AOVRequest | a | The first AOVRequest to compare. |
AOVRequest | b | The second AOVRequest to compare. |
Returns
Type | Description |
---|---|
bool | True if the two AOV requests have not the same settings. |