Class DenoiserBase

Inheritance
object
DenoiserBase
CommandBufferDenoiser
Denoiser
Inherited Members
Namespace: UnityEngine.Rendering.Denoising
Assembly: Unity.Rendering.Denoising.Runtime.dll
Syntax
public abstract class DenoiserBase

Fields

m_ActiveAOV

Declaration
protected bool m_ActiveAOV
Field Value
Type Description
bool

m_ActiveBacked

Declaration
protected DenoiserType m_ActiveBacked
Field Value
Type Description
DenoiserType

m_ActiveHeight

Declaration
protected int m_ActiveHeight
Field Value
Type Description
int

m_ActiveWidth

Declaration
protected int m_ActiveWidth
Field Value
Type Description
int

m_DenoiserBackend

Declaration
protected IntPtr m_DenoiserBackend
Field Value
Type Description
IntPtr

m_FilterHint

Declaration
protected DenoiserBase.FilterHint m_FilterHint
Field Value
Type Description
DenoiserBase.FilterHint

m_InternalState

Declaration
protected DenoiserBase.State m_InternalState
Field Value
Type Description
DenoiserBase.State

m_RequestHeight

Declaration
protected int m_RequestHeight
Field Value
Type Description
int

m_RequestWidth

Declaration
protected int m_RequestWidth
Field Value
Type Description
int

m_Temporal

Declaration
protected bool m_Temporal
Field Value
Type Description
bool

m_TileHeight

Declaration
protected int m_TileHeight
Field Value
Type Description
int

m_TileWidth

Declaration
protected int m_TileWidth
Field Value
Type Description
int

m_Type

Declaration
protected DenoiserType m_Type
Field Value
Type Description
DenoiserType

m_UseAOV

Declaration
protected bool m_UseAOV
Field Value
Type Description
bool

Properties

filterHint

The denoising filter you have selected.

Declaration
public DenoiserBase.FilterHint filterHint { get; }
Property Value
Type Description
DenoiserBase.FilterHint

type

The denoiser backend type that is used for the denoising operations.

Declaration
public DenoiserType type { get; }
Property Value
Type Description
DenoiserType

Methods

DisposeDenoiser()

Disposes a denoiser

Declaration
public void DisposeDenoiser()

IsDenoiserTypeSupported(DenoiserType)

Checks if a denoiser backend type is available on the current hardware configuration.

Declaration
public static bool IsDenoiserTypeSupported(DenoiserType type)
Parameters
Type Name Description
DenoiserType type

The denoiser backend type to check for.
Returns
Type Description
bool

Returns true if the denoiser type is available, false otherwise.

udnCreateDenoiser(StringBuilder, int, int, int, int, int, FilterHint)

Declaration
protected static extern IntPtr udnCreateDenoiser(StringBuilder backEnd, int width, int height, int tilex, int tiley, int temporal, DenoiserBase.FilterHint mode)
Parameters
Type Name Description
StringBuilder backEnd
int width
int height
int tilex
int tiley
int temporal
DenoiserBase.FilterHint mode
Returns
Type Description
IntPtr

udnDenoiseBuffer(IntPtr, StringBuilder, void*, GraphicsFormat)

Declaration
protected static extern int udnDenoiseBuffer(IntPtr denoiser, StringBuilder bufferType, void* data, GraphicsFormat format)
Parameters
Type Name Description
IntPtr denoiser
StringBuilder bufferType
void* data
GraphicsFormat format
Returns
Type Description
int

udnDisposeDenoiser(IntPtr)

Declaration
protected static extern void udnDisposeDenoiser(IntPtr denoiser)
Parameters
Type Name Description
IntPtr denoiser

udnGetResult(IntPtr, void*)

Declaration
protected static extern int udnGetResult(IntPtr denoiser, void* data)
Parameters
Type Name Description
IntPtr denoiser
void* data
Returns
Type Description
int

udnSetPath(IntPtr, StringBuilder)

Declaration
protected static extern int udnSetPath(IntPtr denoiser, StringBuilder bufferType)
Parameters
Type Name Description
IntPtr denoiser
StringBuilder bufferType
Returns
Type Description
int