Navigation
API > API/Plugins > API/Plugins/MutableRuntime
Image block layout class. It contains the information about what blocks are defined in a texture layout (texture coordinates set from a mesh). It is usually not necessary to use this objects, except for some advanced cases.
| Name | FLayout |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Layout.h |
| Include Path | #include "MuR/Layout.h" |
Syntax
class FLayout : public mu::FResource
Inheritance Hierarchy
- FResource → FLayout
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Blocks | TArray< FLayoutBlock > | MuR/Layout.h | ||
| MaxSize | FIntVector2 | Maximum size in layout blocks that this layout can grow to. | MuR/Layout.h | |
| ReductionMethod | EReductionMethod | MuR/Layout.h | ||
| Size | FIntVector2 | MuR/Layout.h | ||
| Strategy | EPackStrategy | Packing strategy. | MuR/Layout.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FLayout > Clone () |
Life cycle. | MuR/Layout.h | |
int32 FindBlock
(
uint64 Id |
Find a block by id. | MuR/Layout.h | |
int32 GetBlockCount() |
Return the number of blocks in this layout. | MuR/Layout.h | |
FIntPoint GetGridSize() |
Get the resolution of the grid where the blocks are defined. | MuR/Layout.h | |
EPackStrategy GetLayoutPackingStrategy() |
Set the texture layout packing strategy. | MuR/Layout.h | |
void GetMaxGridSize
(
int32* SizeX, |
Get the maximum resolution of the grid where the blocks are defined. | MuR/Layout.h | |
bool IsSimilar
(
const FLayout& o |
MuR/Layout.h | ||
bool IsSingleBlockAndFull() |
Return true if the layout is a single block filling all area. | MuR/Layout.h | |
void Serialise
(
FOutputArchive& arch |
MuR/Layout.h | ||
void SetBlockCount
(
int32 |
Set the number of blocks in this layout. | MuR/Layout.h | |
void SetGridSize
(
int32 SizeX, |
Get the resolution of the grid where the blocks are defined. It must be bigger than 0 on each axis. | MuR/Layout.h | |
void SetLayoutPackingStrategy
(
EPackStrategy |
Set the texture layout packing strategy By default the texture layout packing strategy is set to resizable layout | MuR/Layout.h | |
void SetMaxGridSize
(
int32 SizeX, |
Get the maximum resolution of the grid where the blocks are defined. | MuR/Layout.h | |
void Unserialise
(
FInputArchive& arch |
MuR/Layout.h |
Overridden from FResource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetDataSize() |
Return the size in bytes of all the LODs of the image. | MuR/Layout.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void Serialise
(
const FLayout* p, |
Serialisation. | MuR/Layout.h | |
static TSharedPtr< FLayout > StaticUnserialise
(
FInputArchive& arch |
MuR/Layout.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FLayout& other |
Full compare. | MuR/Layout.h |