ezEngine  Release 25.03
ezGALReadbackBuffer Class Referenceabstract

Allows for a GPU buffer to be read back to the CPU. Uses the same ezGALBufferCreationDescription as a normal buffer for convenience. While most of the properties may be irrelevant for this purpose, the user should not have to care about that and just request a readback buffer that can read back a buffer of the given description. More...

#include <ReadbackBuffer.h>

Inheritance diagram for ezGALReadbackBuffer:

Public Member Functions

EZ_ALWAYS_INLINE ezUInt32 GetSize () const
 
- Public Member Functions inherited from ezGALResource< ezGALBufferCreationDescription >
EZ_ALWAYS_INLINE ezGALResource (const ezGALBufferCreationDescription &description)
 
const EZ_ALWAYS_INLINE ezGALBufferCreationDescriptionGetDescription () const
 
- Public Member Functions inherited from ezGALResourceBase
void SetDebugName (const char *szName) const
 
virtual const ezGALResourceBaseGetParentResource () const
 
- Public Member Functions inherited from ezRefCounted
virtual ~ezRefCounted ()=default
 Adds a virtual destructor.
 
- Public Member Functions inherited from ezRefCountingImpl
 ezRefCountingImpl ()=default
 Constructor.
 
 ezRefCountingImpl (const ezRefCountingImpl &rhs)
 
void operator= (const ezRefCountingImpl &rhs)
 
ezInt32 AddRef () const
 Increments the reference counter. Returns the new reference count.
 
ezInt32 ReleaseRef () const
 Decrements the reference counter. Returns the new reference count.
 
bool IsReferenced () const
 Returns true if the reference count is greater than 0, false otherwise.
 
ezInt32 GetRefCount () const
 Returns the current reference count.
 

Protected Member Functions

 ezGALReadbackBuffer (const ezGALBufferCreationDescription &Description)
 
virtual ezResult InitPlatform (ezGALDevice *pDevice)=0
 
virtual ezResult DeInitPlatform (ezGALDevice *pDevice)=0
 
- Protected Member Functions inherited from ezGALResourceBase
virtual void SetDebugNamePlatform (const char *szName) const =0
 

Friends

class ezGALDevice
 

Additional Inherited Members

- Protected Attributes inherited from ezGALResource< ezGALBufferCreationDescription >
const ezGALBufferCreationDescription m_Description
 

Detailed Description

Allows for a GPU buffer to be read back to the CPU. Uses the same ezGALBufferCreationDescription as a normal buffer for convenience. While most of the properties may be irrelevant for this purpose, the user should not have to care about that and just request a readback buffer that can read back a buffer of the given description.


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