FUniqueBuffer

A reference to a single-ownership mutable buffer.

Ownership can be transferred by moving to FUniqueBuffer or it can be converted to an immutable shared buffer with MoveToShared().


Name	FUniqueBuffer
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Memory/SharedBuffer.h
Include Path	#include "Memory/SharedBuffer.h"

Syntax

class FUniqueBuffer

Name	Remarks	Include Path
FUniqueBuffer ()	Construct a null unique buffer.	Memory/SharedBuffer.h
FUniqueBuffer ( FOwnerPtrType&& SharedOwner )		Memory/SharedBuffer.h
FUniqueBuffer ( const FUniqueBuffer& )		Memory/SharedBuffer.h
FUniqueBuffer ( FUniqueBuffer&& )		Memory/SharedBuffer.h
FUniqueBuffer ( FBufferOwner* Owner )	Construct a unique buffer from a new unreferenced buffer owner.	Memory/SharedBuffer.h

Name	Type	Remarks	Include Path
FOwnerPtrType	UE::SharedBuffer::Private::TBufferOwnerPtr< UE::SharedBuffer::Private::FSharedOps >		Memory/SharedBuffer.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Owner	FOwnerPtrType		Memory/SharedBuffer.h

Name	Remarks	Include Path
const void * GetData ()		Memory/SharedBuffer.h
void * GetData ()	Returns a pointer to the start of the buffer.	Memory/SharedBuffer.h
uint64 GetSize()	Returns the size of the buffer in bytes.	Memory/SharedBuffer.h
FMemoryView GetView ()		Memory/SharedBuffer.h
FMutableMemoryView GetView ()	Returns a view of the buffer.	Memory/SharedBuffer.h
bool IsMaterialized()	Returns true if the referenced buffer has been materialized.	Memory/SharedBuffer.h
bool IsNull ()	Returns true if this does not point to a buffer owner.	Memory/SharedBuffer.h
bool IsOwned()	Returns true if this keeps the referenced buffer alive.	Memory/SharedBuffer.h
FUniqueBuffer MakeOwned()	Returns a buffer that is owned, by cloning if not owned.	Memory/SharedBuffer.h
void Materialize ()	Materialize the buffer by making its data and size available.	Memory/SharedBuffer.h
FSharedBuffer MoveToShared ()	Convert this to an immutable shared buffer, leaving this null.	Memory/SharedBuffer.h
void Reset()	Reset this to null.	Memory/SharedBuffer.h

Name	Remarks	Include Path
static FUniqueBuffer Alloc ( uint64 Size )	Make an uninitialized owned buffer of the specified size.	Memory/SharedBuffer.h
static FUniqueBuffer AllocZeroed ( uint64 Size )	Make a zeroed owned buffer of the specified size.	Memory/SharedBuffer.h
static FUniqueBuffer Clone ( const void* Data, uint64 Size )		Memory/SharedBuffer.h
static FUniqueBuffer Clone ( FMemoryView View )	Make an owned clone of the input.	Memory/SharedBuffer.h
static FUniqueBuffer MakeView ( FMutableMemoryView View )	Make a non-owned view of the input.	Memory/SharedBuffer.h
static FUniqueBuffer MakeView ( void* Data, uint64 Size )		Memory/SharedBuffer.h
static FUniqueBuffer TakeOwnership ( void* Data, uint64 Size, DeleteFunctionType&& DeleteFunction )	Make an owned buffer by taking ownership of the input.	Memory/SharedBuffer.h
static FUniqueBuffer TakeOwnership ( void* Data, uint64 Size, DeleteFunctionType&& DeleteFunction )	Make an owned buffer by taking ownership of the input.	Memory/SharedBuffer.h

Name	Remarks	Include Path
operator bool()	Returns true if this points to a buffer owner.	Memory/SharedBuffer.h
operator FMemoryView()		Memory/SharedBuffer.h
operator FMutableMemoryView()		Memory/SharedBuffer.h
bool operator!= ( const FUniqueBuffer& BufferB ) const		Memory/SharedBuffer.h
FUniqueBuffer & operator= ( FUniqueBuffer&& )		Memory/SharedBuffer.h
FUniqueBuffer & operator= ( const FUniqueBuffer& )		Memory/SharedBuffer.h
bool operator== ( const FUniqueBuffer& BufferB ) const		Memory/SharedBuffer.h