HdStRenderBuffer Class Reference

#include <renderBuffer.h>

Inheritance diagram for HdStRenderBuffer:

Public Member Functions
HDST_API	HdStRenderBuffer (HdStResourceRegistry *resourceRegistry, SdfPath const &id)
HDST_API	~HdStRenderBuffer () override
HDST_API void	Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
	Get allocation information from the scene delegate. More...
HDST_API bool	Allocate (GfVec3i const &dimensions, HdFormat format, bool multiSampled) override
HDST_API unsigned int	GetWidth () const override
	Get the buffer's width. More...
HDST_API unsigned int	GetHeight () const override
	Get the buffer's height. More...
HDST_API unsigned int	GetDepth () const override
	Get the buffer's depth. More...
HDST_API HdFormat	GetFormat () const override
	Get the buffer's per-pixel format. More...
HDST_API bool	IsMultiSampled () const override
	Get whether the buffer is multisampled. More...
HDST_API uint32_t	GetMSAASampleCount () const
HDST_API void *	Map () override
HDST_API void	Unmap () override
	Unmap the buffer. More...
HDST_API bool	IsMapped () const override
HDST_API bool	IsConverged () const override
HDST_API void	Resolve () override
	Resolve the sample buffer into final values. More...
HDST_API VtValue	GetResource (bool multiSampled) const override
	Returns the texture handle. More...
HDST_API HdStTextureIdentifier	GetTextureIdentifier (bool multiSampled)
Public Member Functions inherited from HdRenderBuffer
HD_API	HdRenderBuffer (SdfPath const &id)
HD_API	~HdRenderBuffer () override
HD_API HdDirtyBits	GetInitialDirtyBitsMask () const override
	Get initial invalidation state. More...
HD_API void	Finalize (HdRenderParam *renderParam) override
	Deallocate before deletion. More...
Public Member Functions inherited from HdBprim
HD_API	HdBprim (SdfPath const &id)
virtual HD_API	~HdBprim ()
SdfPath const &	GetId () const

Protected Member Functions
void	_Deallocate () override
	Deallocate the buffer, freeing any owned resources. More...
Protected Member Functions inherited from HdRenderBuffer

Additional Inherited Members
Public Types inherited from HdRenderBuffer
enum	DirtyBits : HdDirtyBits { Clean = 0, DirtyDescription = 1 << 0, AllDirty = (DirtyDescription) }

Detailed Description

Definition at line 43 of file renderBuffer.h.

Constructor & Destructor Documentation

HDST_API HdStRenderBuffer::HdStRenderBuffer	(	HdStResourceRegistry *	resourceRegistry,
		SdfPath const &	id
	)

HDST_API HdStRenderBuffer::~HdStRenderBuffer ( )

override

Member Function Documentation

void HdStRenderBuffer::_Deallocate ( )

overrideprotectedvirtual

Deallocate the buffer, freeing any owned resources.

Implements HdRenderBuffer.

HDST_API bool HdStRenderBuffer::Allocate ( GfVec3i const &  dimensions, HdFormat  format, bool  multiSampled  )

overridevirtual

Allocate a buffer. Can be called from Sync(), or directly. If the buffer has already been allocated, calling Allocate() again will destroy the old buffer and allocate a new one.

A negative dimension or invalid format will cause an allocation error. If the requested buffer can't be allocated, the function will return false.

Implements HdRenderBuffer.

HDST_API unsigned int HdStRenderBuffer::GetDepth ( ) const

overridevirtual

Get the buffer's depth.

Implements HdRenderBuffer.

HDST_API HdFormat HdStRenderBuffer::GetFormat ( ) const

inlineoverridevirtual

Get the buffer's per-pixel format.

Implements HdRenderBuffer.

Definition at line 72 of file renderBuffer.h.

HDST_API unsigned int HdStRenderBuffer::GetHeight ( ) const

overridevirtual

Get the buffer's height.

Implements HdRenderBuffer.

HDST_API uint32_t HdStRenderBuffer::GetMSAASampleCount

(

)

const

HDST_API VtValue HdStRenderBuffer::GetResource ( bool  multiSampled ) const

overridevirtual

Returns the texture handle.

Reimplemented from HdRenderBuffer.

HDST_API HdStTextureIdentifier HdStRenderBuffer::GetTextureIdentifier

(

bool

multiSampled

)

The identifier that can be passed to, e.g., HdStResourceRegistry::AllocateTextureHandle so that a shader can bind this buffer as texture.

HDST_API unsigned int HdStRenderBuffer::GetWidth ( ) const

overridevirtual

Get the buffer's width.

Implements HdRenderBuffer.

HDST_API bool HdStRenderBuffer::IsConverged ( ) const

inlineoverridevirtual

Is the buffer converged?

Returns

True if the buffer is converged (not currently being rendered to).

Implements HdRenderBuffer.

Definition at line 102 of file renderBuffer.h.

HDST_API bool HdStRenderBuffer::IsMapped ( ) const

inlineoverridevirtual

Return whether any clients have this buffer mapped currently.

Returns

True if the buffer is currently mapped by someone.

Implements HdRenderBuffer.

Definition at line 94 of file renderBuffer.h.

HDST_API bool HdStRenderBuffer::IsMultiSampled ( ) const

overridevirtual

Get whether the buffer is multisampled.

Implements HdRenderBuffer.

HDST_API void* HdStRenderBuffer::Map ( )

overridevirtual

Map the buffer for reading. The control flow should be Map(), before any I/O, followed by memory access, followed by Unmap() when done.

Returns

The address of the buffer.

Implements HdRenderBuffer.

HDST_API void HdStRenderBuffer::Resolve ( )

overridevirtual

Resolve the sample buffer into final values.

Implements HdRenderBuffer.

HDST_API void HdStRenderBuffer::Sync ( HdSceneDelegate *  sceneDelegate, HdRenderParam *  renderParam, HdDirtyBits *  dirtyBits  )

overridevirtual

Get allocation information from the scene delegate.

Reimplemented from HdRenderBuffer.

HDST_API void HdStRenderBuffer::Unmap ( )

overridevirtual

Unmap the buffer.

Implements HdRenderBuffer.

---

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

• pxr/imaging/hdSt/renderBuffer.h