FComputeBufferReader | Unreal Engine 5.4 Documentation

References


Module	Horde
Header	/Engine/Source/Developer/Horde/Public/Compute/ComputeBuffer.h
Include	#include "Compute/ComputeBuffer.h"

class FComputeBufferReader

Facilitates reading data from a compute buffer

	Type	Name	Description
		FComputeBufferReader ()
		FComputeBufferReader ( const FComputeBufferReader& Other )
		FComputeBufferReader ( FComputeBufferReader&& Other )

	Type	Name	Description
		~FComputeBufferReader ()

Type	Name	Description
void	AdvanceReadPosition ( size_t Size )	Move the read cursor forwards by the given number of bytes.
void	Close ()	Closes the handle to the underlying reader instance, resetting this instance back to empty.
void	Detach ()	Detaches this reader from the buffer, causing all pending and subsequent reads to return immediately.
size_t	GetMaxReadSize ()	Gets the amount of data that is ready to be read from a contiguous block of memory.
bool	IsComplete ()	Test whether the buffer has finished being written to (ie. MarkComplete() has been called by the writer) and all data has been read from it.
bool	IsValid ()	Test if the reader is valid.
size_t	Read ( void* Buffer, size_t MaxSize, int TimeoutMs )	Reads data into the given buffer.
const unsigned char *	WaitToRead ( size_t MinSize, int TimeoutMs )	Waits until the given amount of data has been read, and returns a pointer to it.