FSharedBuffer

A reference to a shared-ownership immutable 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 FSharedBuffer

Remarks

A reference to a shared-ownership immutable buffer.

Constructors

	Name	Description
	FSharedBuffer()	Construct a null shared buffer.
	FSharedBuffer ( FBufferOwner* Owner )	Construct a shared buffer from a new unreferenced buffer owner.

Functions

	Name	Description
FSharedBuffe...	Clone ( const void* Data, uint64 Size )	Make an owned clone of the input.
FSharedBuffe...	Clone ( FMemoryView View )	Make an owned clone of the input.
const void &...	GetData()	Returns a pointer to the start of the buffer.
uint64	GetSize()	Returns the size of the buffer in bytes.
FMemoryView	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.
FSharedBuffe...	MakeOwned()	Returns a buffer that is owned, by cloning if not owned.
FSharedBuffe...	MakeOwned()
FSharedBuffe...	MakeView ( FMemoryView View )	Make a non-owned view of the input.
FSharedBuffe...	MakeView ( const void* Data, uint64 Size )	Make a non-owned view of the input.
FSharedBuffe...	MakeView ( FMemoryView View, FSharedBuffer&& OuterBuffer )	Make a view of the input within its outer buffer. Ownership matches OuterBuffer.
FSharedBuffe...	MakeView ( FMemoryView View, const FSharedBuffer& OuterBuffer )	Make a non-owned view of the input.
FSharedBuffe...	MakeView ( const void* Data, uint64 Size, FSharedBuffer&& OuterBuffer )	Make a non-owned view of the input.
FSharedBuffe...	MakeView ( const void* Data, uint64 Size, const FSharedBuffer& OuterBuffer )	Make a non-owned view of the input.
void	Materialize()	Materialize the buffer by making its data and size available.
FUniqueBuffe...	MoveToUnique()	Convert this to a unique buffer, leaving this null.
void	Reset()	Reset this to null.
FSharedBuffe...	TakeOwnership ( const void* Data, uint64 Size, DeleteFunctionType&& DeleteFunctio... )	Make an owned buffer by taking ownership of the input.
FSharedBuffe...	TakeOwnership ( const 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()

Typedefs

Name	Description
FOwnerPtrType
FWeakOwnerPtrType