1. Epic GamesDeveloper
  3. FImageDataStorage

FImageDataStorage

API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR

References

   
Module MutableRuntime
Header /Engine/Plugins/Experimental/Mutable/Source/MutableRuntime/Public/MuR/ImageDataStorage.h
Include #include "MuR/ImageDataStorage.h"

Syntax

class FImageDataStorage

Variables

  Type Name Description
Public variable TArray< FImageArray, TInlineAllocator< 1 > > Buffers  
Public variable TStaticArray< uint16, NumLODsInCompactedTail > CompactedTailOffsets This is needed for images its size cannot be known from dimensions and format, e.g., RLE compressed formats.
Public variable EImageFormat ImageFormat  
Public variable FImageSize ImageSize  
Public variable uint8 NumLODs  

Constructors

  Type Name Description
Public function    
Public function  

FImageDataStorage ( const FImageDesc& Desc
)

  
Public function    
Public function    

Functions

  Type Name Description
Public function Const int32  
Public function void

CopyFrom ( const FImageDataStorage& Other
)

  
Public function void

DropLODs ( int32 NumLODsToDrop
)

 Remove NumLODsToDrop starting form LOD 0. The resulting image will be smaller.
Public function Const int32  
Public function TArrayView< uint8 >

GetBatch ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes
)

  
Public function Const TArrayView< const uint8 >

GetBatch ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes
)

  
Public function Const TArrayView< const uint8 >

GetBatchFirstLODOffset ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 OffsetInBytes
)

 Returns a non modifiable view to the portion of the first LOD buffer with OffsetInBytes for the BatchId
Public function TArrayView< uint8 >

GetBatchFirstLODOffset ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 OffsetInBytes
)

 Non const version of GetBatchFirstLODOffset().
Public function TArrayView< uint8 >

GetBatchLODRange ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 LODBegin,
int32 LODEnd
)

 Non const version of GetBatchLODRange().
Public function Const TArrayView< const uint8 >

GetBatchLODRange ( int32 BatchId,
int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 LODBegin,
int32 LODEnd
)

 Returns a non modifiable view to the portion of the [LODBegin, LODEnd) for the BatchId.
Public function Const int32  
Public function FImageArray &

GetInternalArray ( int32 LODIndex
)

  
Public function Const const FImageArray &

GetInternalArray ( int32 LODIndex
)

  
Public function TArrayView< uint8 >

GetLOD ( int32 LODIndex
)

 Get a view to the data containing the LODIndex.
Public function Const TArrayView< const uint8 >

GetLOD ( int32 LODIndex
)

 Get a const view to the data containing the LODIndex.
Public function Const int32

GetNumBatches ( int32 BatchSizeInElems,
int32 BatchElemSizeInBytes
)

 Stateless iteration in batches.
Public function Const int32

GetNumBatchesFirstLODOffset ( int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 OffsetInBytes
)

 Returns the number of batches GetBatchFirtsLODOffet will admit and that will cover the first LOD buffer with OffsetInBytes removed from the front.
Public function Const int32

GetNumBatchesLODRange ( int32 BatchSizeInElems,
int32 BatchElemSizeInBytes,
int32 LODBegin,
int32 LODEnd
)

 Returns the number of batches GetBatchLODRange will admit and that will cover the [LODBegin, LODEnd) range.
Public function Const int32  
Public function void

Init ( const FImageDesc& ImageDesc,
EInitializationType InitType
)

  
Public function void

InitInternalArray ( int32 Index,
int32 Size,
EInitializationType InitType
)

  
Public function void

InitVoid ( const FImageDesc& Desc
)

  
Public function Const bool

IsEmpty ()

 Returns true if all buffers are empty.
Public function Const bool

IsVoid ()

  
Public function Const FImageDesc  
Public function void

ResizeLOD ( int32 LODIndex,
int32 NewSizeBytes
)

 Resizes LODIndex Data to NewSizeBytes
Public function Const void  
Public function void

SetNumLODs ( int32 InNumLODs,
EInitializationType InitType
)

 Change the number of lods in the image.
Public function void  

Operators

  Type Name Description
Public function FImageDataStorage &  
Public function FImageDataStorage &

operator= ( const FImageDataStorage& Other
)

  
Public function Const bool

operator== ( const FImageDataStorage& Other
)

  

Constants

Name Description
NumLODsInCompactedTail  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page