All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdRenderPassAovBinding Class Reference

#include <aov.h>

Public Member Functions

 HdRenderPassAovBinding ()

Public Attributes

TfToken aovName
SdfPath renderBufferId
 The render buffer to be bound to the above terminal output. More...
VtValue clearValue
HdAovSettingsMap aovSettings

Detailed Description

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

Definition at line 111 of file aov.h.

Constructor & Destructor Documentation

HdRenderPassAovBinding::HdRenderPassAovBinding ( )

Definition at line 113 of file aov.h.

Member Data Documentation

TfToken HdRenderPassAovBinding::aovName

The identifier of the renderer output to be consumed. This should take a value from HdAovTokens. XXX: Depth aov bindings are identified by the "depth" suffix. See HdAovHasDepthSemantic().

Definition at line 120 of file aov.h.

HdAovSettingsMap HdRenderPassAovBinding::aovSettings

Extra settings for AOV rendering, such as pixel filtering options. See also HdAovDescriptor::aovSettings.

Definition at line 144 of file aov.h.

VtValue HdRenderPassAovBinding::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 140 of file aov.h.

HdRenderBuffer* HdRenderPassAovBinding::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 131 of file aov.h.

SdfPath HdRenderPassAovBinding::renderBufferId

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

Definition at line 134 of file aov.h.

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