FCompressedGrowableBuffer

Growable compressed buffer.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/CompressedGrowableBuffer.h

Include

#include "Misc/CompressedGrowableBuffer.h"

Syntax

struct FCompressedGrowableBuffer

Remarks

Growable compressed buffer. Usage is to append frequently but only request and therefore decompress very infrequently. The prime usage case is the memory profiler keeping track of full call stacks.

Constructors

Name Description

Public function

FCompressedGrowableBuffer

(
    int32 MaxPendingBufferSize,
    ECompressionFlags CompressionFlags
)

Use FName version of FCompressedGrowableBuffer constructor

Public function

FCompressedGrowableBuffer

(
    int32 MaxPendingBufferSize,
    FName COmpressionFormat,
    ECompressionFlags CompressionFlags
)

Functions

Name Description

Public function

void *

 

Access

(
    int32 Offset
)

Accesses the data at passed in offset and returns it.

Public function

int32

 

Append

(
    void* Data,
    int32 Size
)

Appends passed in data to the buffer.

Public function Const

SIZE_T

 

GetAllocatedSize()

Helper function to return the amount of memory allocated by this buffer

Public function

void

 

Lock()

Locks the buffer for reading.

Public function Const

int32

 

Num()

Public function

void

 

Unlock()

Unlocks the buffer and frees temporary resources used for accessing.

Enums

Name

Description

Private enum

EVS2015Redirector

This enum and the following constructor is a workaround for VC compiler bug that prevents using attributes on constructors without inline implementation.

Deprecated Functions

Name Description

Public function

 

FCompressedGrowableBuffer

(
    int32 MaxPendingBufferSize,
    ECompressionFlags CompressionFlags
)

Use FName version of FCompressedGrowableBuffer constructor

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss