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

A bundle of state describing an AOV ("Alternate Output Value") display channel. More...

Public Member Functions

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

Public Attributes

HdFormat format
 The AOV output format. See also HdRenderBufferDescriptor::format. More...
 
bool multiSampled
 Whether the render buffer should be multisampled. More...
 
VtValue clearValue
 The clear value to apply to the render buffer before rendering. More...
 
HdAovSettingsMap aovSettings
 Extra settings for AOV rendering, such as pixel filtering options. More...
 

Detailed Description

A bundle of state describing an AOV ("Alternate Output Value") 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.

Member Data Documentation

HdAovSettingsMap aovSettings

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

See also HdRenderPassAovBinding::aovSettings.

Definition at line 77 of file aov.h.

VtValue 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 format

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

Definition at line 59 of file aov.h.

bool 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: