Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FUniqueBuffer

A reference to a single-ownership mutable buffer.

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Memory/SharedBuffer.h
Include	#include "Memory/SharedBuffer.h"

Syntax

class FUniqueBuffer

Remarks

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().

Constructors

	Name	Description
	FUniqueBuffer()	Construct a null unique buffer.
	FUniqueBuffer ( FBufferOwner* Owner )	Construct a unique buffer from a new unreferenced buffer owner.
	FUniqueBuffer ( FUniqueBuffer&& )
	FUniqueBuffer ( const FUniqueBuffer& )

Functions

	Name	Description
FUniqueBuffe...	Alloc ( uint64 Size )	Make an uninitialized owned buffer of the specified size.
FUniqueBuffe...	Clone ( FMemoryView View )	Make an owned clone of the input.
FUniqueBuffe...	Clone ( const void* Data, uint64 Size )	Make an owned clone of the input.
const void &...	GetData()
void *	GetData()	Returns a pointer to the start of the buffer.
uint64	GetSize()	Returns the size of the buffer in bytes.
FMemoryView	GetView()
FMutableMemo...	GetView()	Returns a view of the buffer.
bool	IsMaterialized()	Returns true if the referenced buffer has been materialized.
bool	IsNull()	Returns true if this does not point to a buffer owner.
bool	IsOwned()	Returns true if this keeps the referenced buffer alive.
FUniqueBuffe...	MakeOwned()	Returns a buffer that is owned, by cloning if not owned.
FUniqueBuffe...	MakeView ( FMutableMemoryView View )	Make a non-owned view of the input.
FUniqueBuffe...	MakeView ( void* Data, uint64 Size )	Make a non-owned view of the input.
void	Materialize()	Materialize the buffer by making its data and size available.
FSharedBuffe...	MoveToShared()	Convert this to an immutable shared buffer, leaving this null.
void	Reset()	Reset this to null.
FUniqueBuffe...	TakeOwnership ( void* Data, uint64 Size, DeleteFunctionType&& DeleteFunctio... )	Make an owned buffer by taking ownership of the input.
FUniqueBuffe...	TakeOwnership ( void* Data, uint64 Size, DeleteFunctionType&& DeleteFunctio... )	Make an owned buffer by taking ownership of the input.

Operators

	Name	Description
	operator bool()	Returns true if this points to a buffer owner.
	operator FMemoryView()
	operator FMutableMemoryView()
FUniqueBuffe...	operator= ( FUniqueBuffer&& )
FUniqueBuffe...	operator= ( const FUniqueBuffer& )

Typedefs

Name	Description
FOwnerPtrType