1. Epic GamesDeveloper
  3. FSharedBuffer

FSharedBuffer

A reference to a shared-ownership immutable buffer.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Memory

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

  Type Name Description
Public function   Construct a null shared buffer.
Public function   Construct a shared buffer from a new unreferenced buffer owner.

Functions

  Type Name Description
Public function Static FSharedBuffer

Clone ( FMemoryView View
)

 Make an owned clone of the input.
Public function Static FSharedBuffer

Clone ( const void* Data,
uint64 Size
)

 Make an owned clone of the input.
Public function Const const void *

GetData ()

 Returns a pointer to the start of the buffer.
Public function Const uint64

GetSize ()

 Returns the size of the buffer in bytes.
Public function Const FMemoryView

GetView ()

 Returns a view of the buffer.
Public function Const bool Returns true if the referenced buffer has been materialized.
Public function Const bool

IsNull ()

 Returns true if this does not point to a buffer owner.
Public function Const bool

IsOwned ()

 Returns true if this keeps the referenced buffer alive.
Public function FSharedBuffer  
Public function Const FSharedBuffer Returns a buffer that is owned, by cloning if not owned.
Public function Static FSharedBuffer

MakeView ( const void* Data,
uint64 Size,
const FSharedBuffer& OuterBuffer
)

 Make a non-owned view of the input.
Public function Static FSharedBuffer

MakeView ( const void* Data,
uint64 Size,
FSharedBuffer&& OuterBuffer
)

 Make a non-owned view of the input.
Public function Static FSharedBuffer

MakeView ( FMemoryView View,
const FSharedBuffer& OuterBuffer
)

 Make a non-owned view of the input.
Public function Static FSharedBuffer

MakeView ( FMemoryView View
)

 Make a non-owned view of the input.
Public function Static FSharedBuffer

MakeView ( const void* Data,
uint64 Size
)

 Make a non-owned view of the input.
Public function Static FSharedBuffer

MakeView ( FMemoryView View,
FSharedBuffer&& OuterBuffer
)

 Make a view of the input within its outer buffer. Ownership matches OuterBuffer.
Public function Const void Materialize the buffer by making its data and size available.
Public function FUniqueBuffer Convert this to a unique buffer, leaving this null.
Public function void

Reset ()

 Reset this to null.
Public function Static FSharedBuffer

TakeOwnership ( const void* Data,
uint64 Size,
DeleteFunctionType&& DeleteFunction
)

 Make an owned buffer by taking ownership of the input.
Public function Static FSharedBuffer

TakeOwnership ( const void* Data,
uint64 Size,
DeleteFunctionType&& DeleteFunction
)

 Make an owned buffer by taking ownership of the input.

Operators

  Type Name Description
Public function Const   Returns true if this points to a buffer owner.
Public function Const    
Public function Const bool

operator!= ( const FSharedBuffer& BufferB
)

  
Public function Const bool

operator== ( const FSharedBuffer& BufferB
)

  

Typedefs

Name Description
FOwnerPtrType  
FWeakOwnerPtrType  

See Also

FBufferOwner

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page