HdRenderPassAovBinding Class Reference

A renderpass AOV represents a binding of some output of the rendering process to an output buffer. More...

Public Attributes

TfToken aovName
 The identifier of the renderer output to be consumed. More...
 
HdRenderBufferrenderBuffer
 The render buffer to be bound to the above terminal output. More...
 
SdfPath renderBufferId
 The render buffer to be bound to the above terminal output. More...
 
VtValue clearValue
 The clear value to apply to the bound render buffer, before rendering. More...
 
HdAovSettingsMap aovSettings
 Extra settings for AOV rendering, such as pixel filtering options. More...
 

Detailed Description

A renderpass AOV represents a binding of some output of the rendering process to an output buffer.

Definition at line 117 of file aov.h.

Member Data Documentation

◆ aovName

TfToken aovName

The identifier of the renderer output to be consumed.

This should take a value from HdAovTokens. Bindings for depth and depthStencil are identified by the "depth" or "depthStencil" suffix, respectively. See HdAovHasDepthSemantic() and HdAovHadDepthStencilSemantic().

Definition at line 127 of file aov.h.

◆ aovSettings

HdAovSettingsMap aovSettings

Extra settings for AOV rendering, such as pixel filtering options.

See also HdAovDescriptor::aovSettings.

Definition at line 151 of file aov.h.

◆ clearValue

VtValue clearValue

The clear value to apply to the bound render buffer, before rendering.

The type of "clearValue" should match the type of the bound buffer. If clearValue is empty, it indicates no clear should be performed. See also HdAovDescriptor::clearValue.

Definition at line 147 of file aov.h.

◆ renderBuffer

HdRenderBuffer* renderBuffer

The render buffer to be bound to the above terminal output.

From the app or scene, this can be specified as either a pointer or a path to a renderbuffer in the render index. If both are specified, the pointer is used preferentially.

Note: hydra never takes ownership of the renderBuffer, but assumes it will be alive until the end of the renderpass, or whenever the buffer is marked converged, whichever is later.

Definition at line 138 of file aov.h.

◆ renderBufferId

SdfPath renderBufferId

The render buffer to be bound to the above terminal output.

Definition at line 141 of file aov.h.


The documentation for this class was generated from the following file: