Navigation
API > API/Runtime > API/Runtime/Core
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.
| Name | FCompressedGrowableBuffer |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/CompressedGrowableBuffer.h |
| Include Path | #include "Misc/CompressedGrowableBuffer.h" |
Syntax
struct FCompressedGrowableBuffer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCompressedGrowableBuffer
(
int32 MaxPendingBufferSize, |
Constructor | Misc/CompressedGrowableBuffer.h |
Structs
| Name | Remarks |
|---|---|
| FBufferBookKeeping | Helper structure for book keeping. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BookKeepingInfo | TArray< FBufferBookKeeping > | Book keeping information for decompression/ access. | Misc/CompressedGrowableBuffer.h | |
| CompressedBuffer | TArray< uint8 > | Compressed data. | Misc/CompressedGrowableBuffer.h | |
| CompressionFlags | ECompressionFlags | Compression flags used to compress the data. | Misc/CompressedGrowableBuffer.h | |
| CompressionFormat | FName | Compression format used to compress the data. | Misc/CompressedGrowableBuffer.h | |
| CurrentOffset | int32 | Current offset in uncompressed data. | Misc/CompressedGrowableBuffer.h | |
| DecompressedBuffer | TArray< uint8 > | Temporary decompression buffer used between Lock/ Unlock. | Misc/CompressedGrowableBuffer.h | |
| DecompressedBufferBookKeepingInfoIndex | int32 | Index into book keeping info associated with decompressed buffer. | Misc/CompressedGrowableBuffer.h | |
| MaxPendingBufferSize | int32 | Maximum chunk size to compress in uncompressed bytes. | Misc/CompressedGrowableBuffer.h | |
| NumEntries | int32 | Number of entries in buffer. | Misc/CompressedGrowableBuffer.h | |
| PendingCompressionBuffer | TArray< uint8 > | Data pending compression once size limit is reached. | Misc/CompressedGrowableBuffer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void * Access
(
int32 Offset |
Accesses the data at passed in offset and returns it. | Misc/CompressedGrowableBuffer.h | |
int32 Append
(
void* Data, |
Appends passed in data to the buffer. | Misc/CompressedGrowableBuffer.h | |
SIZE_T GetAllocatedSize() |
Helper function to return the amount of memory allocated by this buffer | Misc/CompressedGrowableBuffer.h | |
void Lock () |
Locks the buffer for reading. | Misc/CompressedGrowableBuffer.h | |
int32 Num() |
Misc/CompressedGrowableBuffer.h | ||
void Unlock() |
Unlocks the buffer and frees temporary resources used for accessing. | Misc/CompressedGrowableBuffer.h |