HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
XUSD_HydraRenderBuffer Class Referenceabstract

#include <XUSD_HydraRenderBuffer.h>

+ Inheritance diagram for XUSD_HydraRenderBuffer:

Public Member Functions

 XUSD_HydraRenderBuffer (SdfPath const &primId)
 
 ~XUSD_HydraRenderBuffer () override
 
virtual int NumExtra () const =0
 Return the number of extra image planes. More...
 
virtual HdFormat GetFormatExtra (int idx) const =0
 Get the extra buffer's per-pixel format. More...
 
virtual const UT_StringHolderGetPlaneName (int idx) const =0
 Get the extra buffer's plane name. More...
 
virtual voidMapExtra (int idx)=0
 Map the extra buffer for reading. More...
 
virtual void UnmapExtra (int idx)=0
 Unmap the extra buffer. It is no longer safe to read from the buffer. More...
 
virtual const UT_OptionsGetMetadata () const =0
 
- Public Member Functions inherited from HdRenderBuffer
HD_API HdRenderBuffer (SdfPath const &id)
 
virtual HD_API ~HdRenderBuffer ()
 
virtual HD_API HdDirtyBits GetInitialDirtyBitsMask () const override
 Get initial invalidation state. More...
 
virtual HD_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Get allocation information from the scene delegate. More...
 
virtual HD_API void Finalize (HdRenderParam *renderParam) override
 Deallocate before deletion. More...
 
virtual bool Allocate (GfVec3i const &dimensions, HdFormat format, bool multiSampled)=0
 
virtual unsigned int GetWidth () const =0
 Get the buffer's width. More...
 
virtual unsigned int GetHeight () const =0
 Get the buffer's height. More...
 
virtual unsigned int GetDepth () const =0
 Get the buffer's depth. More...
 
virtual HdFormat GetFormat () const =0
 Get the buffer's per-pixel format. More...
 
virtual bool IsMultiSampled () const =0
 Get whether the buffer is multisampled. More...
 
virtual voidMap ()=0
 Map the buffer for reading. More...
 
virtual void Unmap ()=0
 Unmap the buffer. It is no longer safe to read from the buffer. More...
 
virtual bool IsMapped () const =0
 Return whether the buffer is currently mapped by anybody. More...
 
virtual void Resolve ()=0
 
virtual bool IsConverged () const =0
 
virtual VtValue GetResource (bool multiSampled) const
 
- Public Member Functions inherited from HdBprim
HD_API HdBprim (SdfPath const &id)
 
virtual HD_API ~HdBprim ()
 
SdfPath constGetId () const
 

Additional Inherited Members

- Public Types inherited from HdRenderBuffer
enum  DirtyBits : HdDirtyBits { Clean = 0, DirtyDescription = 1 << 0, AllDirty = (DirtyDescription) }
 
- Protected Member Functions inherited from HdRenderBuffer
virtual void _Deallocate ()=0
 Deallocate the buffer, freeing any owned resources. More...
 

Detailed Description

Definition at line 32 of file XUSD_HydraRenderBuffer.h.

Constructor & Destructor Documentation

XUSD_HydraRenderBuffer::XUSD_HydraRenderBuffer ( SdfPath const primId)
inline

Definition at line 35 of file XUSD_HydraRenderBuffer.h.

XUSD_HydraRenderBuffer::~XUSD_HydraRenderBuffer ( )
inlineoverride

Definition at line 39 of file XUSD_HydraRenderBuffer.h.

Member Function Documentation

virtual HdFormat XUSD_HydraRenderBuffer::GetFormatExtra ( int  idx) const
pure virtual

Get the extra buffer's per-pixel format.

virtual const UT_Options& XUSD_HydraRenderBuffer::GetMetadata ( ) const
pure virtual

Return arbitrary metadata associated with this AOV. Only string values are allowed at the moment.

virtual const UT_StringHolder& XUSD_HydraRenderBuffer::GetPlaneName ( int  idx) const
pure virtual

Get the extra buffer's plane name.

virtual void* XUSD_HydraRenderBuffer::MapExtra ( int  idx)
pure virtual

Map the extra buffer for reading.

virtual int XUSD_HydraRenderBuffer::NumExtra ( ) const
pure virtual

Return the number of extra image planes.

virtual void XUSD_HydraRenderBuffer::UnmapExtra ( int  idx)
pure virtual

Unmap the extra buffer. It is no longer safe to read from the buffer.


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