HUSD_RenderBuffer Class Reference

Simple interface around HdRenderBuffer. More...

#include <HUSD_RenderBuffer.h>

Inheritance diagram for HUSD_RenderBuffer:

Public Member Functions
	HUSD_RenderBuffer ()
	HUSD_RenderBuffer (PXR_NS::HdRenderBuffer *b)
	HUSD_RenderBuffer (HUSD_RenderBuffer &&src)
	~HUSD_RenderBuffer ()
HUSD_RenderBuffer &	operator= (HUSD_RenderBuffer &&src)
bool	isValid () const
	Check whether the buffer is valid or not. More...
SYS_SAFE_BOOL	operator bool () const
	Simple bool operator for validity check. More...
void	setBuffer (PXR_NS::HdRenderBuffer *b)
	Set the render buffer. More...
PXL_Packing	packing () const
	Query the pixel packing for the buffer. More...
PXL_DataFormat	dataFormat () const
	Query the pixel data format for the buffer. More...
const void *	map ()
void	unmap ()
bool	isMapped () const
	Test if the buffer is mapped (for debugging) More...
void	mergeMetaData (UT_Options &metadata) const
int	numExtraBuffers () const
	Return the number of extra buffers associated with this render buffer. More...
HUSD_RenderBuffer	extraBuffer (int idx)
	Return an HUSD_RenderBuffer for the extra buffer. More...
UT_StringHolder	extraName (int idx) const
	Return the name of the extra buffer. More...
exint	xres () const
exint	yres () const

Detailed Description

Simple interface around HdRenderBuffer.

Definition at line 28 of file HUSD_RenderBuffer.h.

Constructor & Destructor Documentation

HUSD_RenderBuffer::HUSD_RenderBuffer

(

)

HUSD_RenderBuffer::HUSD_RenderBuffer

(

PXR_NS::HdRenderBuffer *

b

)

HUSD_RenderBuffer::HUSD_RenderBuffer

(

HUSD_RenderBuffer &&

src

)

HUSD_RenderBuffer::~HUSD_RenderBuffer

(

)

Member Function Documentation

PXL_DataFormat HUSD_RenderBuffer::dataFormat

(

)

const

Query the pixel data format for the buffer.

HUSD_RenderBuffer HUSD_RenderBuffer::extraBuffer

(

int

idx

)

Return an HUSD_RenderBuffer for the extra buffer.

UT_StringHolder HUSD_RenderBuffer::extraName

(

int

idx

)

const

Return the name of the extra buffer.

bool HUSD_RenderBuffer::isMapped ( ) const

inline

Test if the buffer is mapped (for debugging)

Definition at line 66 of file HUSD_RenderBuffer.h.

bool HUSD_RenderBuffer::isValid ( ) const

inline

Check whether the buffer is valid or not.

Definition at line 39 of file HUSD_RenderBuffer.h.

const void* HUSD_RenderBuffer::map

(

)

Map the data from the buffer. This can only be called if the buffer is not currently mapped.

void HUSD_RenderBuffer::mergeMetaData

(

UT_Options &

metadata

)

const

This method will merge in any additional extra metadata available if the buffer has a cryptomatte resource

int HUSD_RenderBuffer::numExtraBuffers

(

)

const

Return the number of extra buffers associated with this render buffer.

SYS_SAFE_BOOL HUSD_RenderBuffer::operator bool ( ) const

inline

Simple bool operator for validity check.

Definition at line 42 of file HUSD_RenderBuffer.h.

HUSD_RenderBuffer& HUSD_RenderBuffer::operator=

(

HUSD_RenderBuffer &&

src

)

PXL_Packing HUSD_RenderBuffer::packing

(

)

const

Query the pixel packing for the buffer.

void HUSD_RenderBuffer::setBuffer

(

PXR_NS::HdRenderBuffer *

b

)

Set the render buffer.

void HUSD_RenderBuffer::unmap

(

)

Unmap the buffer's data. Note that the destructor for this class will automatically unmap the buffer if it's been mapped.

exint HUSD_RenderBuffer::xres

(

)

const

Resolution information

exint HUSD_RenderBuffer::yres

(

)

const

Resolution information

---

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

• HUSD/HUSD_RenderBuffer.h