HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
HdAovDescriptor Class Reference

#include <aov.h>

Public Member Functions

 HdAovDescriptor ()
 
 HdAovDescriptor (HdFormat f, bool ms, VtValue const &c)
 

Public Attributes

HdFormat format
 The AOV output format. See also HdRenderBufferDescriptor::format. More...
 
bool multiSampled
 
VtValue clearValue
 
HdAovSettingsMap aovSettings
 

Detailed Description

A bundle of state describing an AOV ("Arbitrary Output Variable") display channel. Note that in hydra API, this data is split between HdRenderPassAovBinding and HdRenderBufferDescriptor. This class is provided for use in higher level application-facing API.

Definition at line 46 of file aov.h.

Constructor & Destructor Documentation

HdAovDescriptor::HdAovDescriptor ( )
inline

Definition at line 48 of file aov.h.

HdAovDescriptor::HdAovDescriptor ( HdFormat  f,
bool  ms,
VtValue const &  c 
)
inline

Definition at line 51 of file aov.h.

Member Data Documentation

HdAovSettingsMap HdAovDescriptor::aovSettings

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

Definition at line 77 of file aov.h.

VtValue HdAovDescriptor::clearValue

The clear value to apply to the render buffer before rendering. The type of "clearValue" should match the provided format. If clearValue is empty, no clear will be performed. See also HdRenderPassAovBinding::clearValue.

Definition at line 73 of file aov.h.

HdFormat HdAovDescriptor::format

The AOV output format. See also HdRenderBufferDescriptor::format.

Definition at line 59 of file aov.h.

bool HdAovDescriptor::multiSampled

Whether the render buffer should be multisampled. See also HdRenderBufferDescriptor::multiSampled.

Definition at line 63 of file aov.h.

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