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

#include <drawTargetAttachmentDescArray.h>

Public Member Functions

HDST_API HdStDrawTargetAttachmentDescArray ()
 Default constructor for container purposes. More...
 
HDST_API HdStDrawTargetAttachmentDescArray (size_t attachmentCount)
 
virtual ~HdStDrawTargetAttachmentDescArray ()=default
 
HDST_API HdStDrawTargetAttachmentDescArray (const HdStDrawTargetAttachmentDescArray &copy)
 
HDST_API
HdStDrawTargetAttachmentDescArray
operator= (const HdStDrawTargetAttachmentDescArray &copy)
 
HDST_API void AddAttachment (const std::string &name, HdFormat format, const VtValue &clearColor, HdWrap wrapS, HdWrap wrapT, HdMinFilter minFilter, HdMagFilter magFilter)
 Pushes a new attachment onto the end of the list of attachments. More...
 
HDST_API size_t GetNumAttachments () const
 
HDST_API const
HdStDrawTargetAttachmentDesc
GetAttachment (size_t idx) const
 
HDST_API void SetDepthSampler (HdWrap depthWrapS, HdWrap depthWrapT, HdMinFilter depthMinFilter, HdMagFilter depthMagFilter)
 Sampler State for Depth attachment. More...
 
HdWrap GetDepthWrapS () const
 
HdWrap GetDepthWrapT () const
 
HdMinFilter GetDepthMinFilter () const
 
HdMagFilter GetDepthMagFilter () const
 
HDST_API void SetDepthPriority (HdDepthPriority depthPriority)
 
HdDepthPriority GetDepthPriority () const
 
HDST_API size_t GetHash () const
 
HDST_API void Dump (std::ostream &out) const
 
HDST_API bool operator== (const HdStDrawTargetAttachmentDescArray &other) const
 
HDST_API bool operator!= (const HdStDrawTargetAttachmentDescArray &other) const
 

Detailed Description

Describes all the color buffer attachments for a draw target. The array should not contain a depth buffer - that is managed separately.

Note
This is a temporary API to aid transition to Storm, and is subject to major changes.

class is derivable for TfAny support.

Definition at line 47 of file drawTargetAttachmentDescArray.h.

Constructor & Destructor Documentation

HDST_API HdStDrawTargetAttachmentDescArray::HdStDrawTargetAttachmentDescArray ( )

Default constructor for container purposes.

HDST_API HdStDrawTargetAttachmentDescArray::HdStDrawTargetAttachmentDescArray ( size_t  attachmentCount)
virtual HdStDrawTargetAttachmentDescArray::~HdStDrawTargetAttachmentDescArray ( )
virtualdefault
HDST_API HdStDrawTargetAttachmentDescArray::HdStDrawTargetAttachmentDescArray ( const HdStDrawTargetAttachmentDescArray copy)

Member Function Documentation

HDST_API void HdStDrawTargetAttachmentDescArray::AddAttachment ( const std::string name,
HdFormat  format,
const VtValue clearColor,
HdWrap  wrapS,
HdWrap  wrapT,
HdMinFilter  minFilter,
HdMagFilter  magFilter 
)

Pushes a new attachment onto the end of the list of attachments.

HDST_API void HdStDrawTargetAttachmentDescArray::Dump ( std::ostream &  out) const
HDST_API const HdStDrawTargetAttachmentDesc& HdStDrawTargetAttachmentDescArray::GetAttachment ( size_t  idx) const
HdMagFilter HdStDrawTargetAttachmentDescArray::GetDepthMagFilter ( ) const
inline

Definition at line 90 of file drawTargetAttachmentDescArray.h.

HdMinFilter HdStDrawTargetAttachmentDescArray::GetDepthMinFilter ( ) const
inline

Definition at line 89 of file drawTargetAttachmentDescArray.h.

HdDepthPriority HdStDrawTargetAttachmentDescArray::GetDepthPriority ( ) const
inline

Definition at line 96 of file drawTargetAttachmentDescArray.h.

HdWrap HdStDrawTargetAttachmentDescArray::GetDepthWrapS ( ) const
inline

Definition at line 87 of file drawTargetAttachmentDescArray.h.

HdWrap HdStDrawTargetAttachmentDescArray::GetDepthWrapT ( ) const
inline

Definition at line 88 of file drawTargetAttachmentDescArray.h.

HDST_API size_t HdStDrawTargetAttachmentDescArray::GetHash ( ) const
HDST_API size_t HdStDrawTargetAttachmentDescArray::GetNumAttachments ( ) const
HDST_API HdStDrawTargetAttachmentDescArray& HdStDrawTargetAttachmentDescArray::operator= ( const HdStDrawTargetAttachmentDescArray copy)
HDST_API bool HdStDrawTargetAttachmentDescArray::operator== ( const HdStDrawTargetAttachmentDescArray other) const
HDST_API void HdStDrawTargetAttachmentDescArray::SetDepthPriority ( HdDepthPriority  depthPriority)
HDST_API void HdStDrawTargetAttachmentDescArray::SetDepthSampler ( HdWrap  depthWrapS,
HdWrap  depthWrapT,
HdMinFilter  depthMinFilter,
HdMagFilter  depthMagFilter 
)

Sampler State for Depth attachment.


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