ezGALReadbackBufferHelper Class Reference

Helper class that automatically creates a readback buffer and controls it's lifetime. More...

#include <ReadbackHelper.h>

Inheritance diagram for ezGALReadbackBufferHelper:

Public Member Functions
void	Reset ()
	Free the memory of the readback buffer.
ezGALFenceHandle	ReadbackBuffer (ezGALCommandEncoder &ref_encoder, ezGALBufferHandle hBuffer)
	Starts a readback of a buffer. A new readback buffer will be created if the current one does not match the new buffer.
ezReadbackBufferLock	LockBuffer (ezArrayPtr< const ezUInt8 > &out_memory)
	Same as ezGALDevice::LockBuffer, but checks that the fence has been reached. If not, returns an invalid lock object.
Public Member Functions inherited from ezGALReadbackHelper
EZ_FORCE_INLINE ezGALFenceHandle	GetCurrentFence () const
	Returns the fence of the last readback operation.
ezEnum< ezGALAsyncResult >	GetReadbackResult (ezTime timeout) const
	Returns the current status of the readback.

Additional Inherited Members
Protected Attributes inherited from ezGALReadbackHelper
ezGALDevice *	m_pDevice = nullptr
ezGALFenceHandle	m_hFence = 0

Detailed Description

Helper class that automatically creates a readback buffer and controls it's lifetime.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/RendererFoundation/Resources/ReadbackHelper.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/RendererFoundation/Resources/Implementation/ReadbackHelper.cpp