Orrery Terrain · OrreryTerrainCore module · member function
Native::FBrushMask::
Decode
ExperimentalMake a mask from its canonical bytes.
Declaration
static std::shared_ptr<const FBrushMask> Decode(const uint8_t* Data, size_t Size, EBrushMaskRefusal* OutWhy = nullptr);- Header
#include "Native/BrushMask.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrainCore");in your module’s Build.cs.- Stability
- Experimental: supported, may change in a minor version, with a changelog line.
- Thread
- Pure, any thread; allocates the levels.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Data | const uint8_ | — | The bytes Encode writes; may be null when Size is 0. |
Size | size_ | — | Exactly kBrushMaskHeaderBytes plus the samples' bytes. |
OutWhy | EBrush | nullptr | Optional: why the bytes were refused, None on success. |
Returns
The mask, or null when refused (BadLength, BadMagic, BadVersion, BadBits, BadSide, ZeroHash).
Note.
Pure, any thread; allocates the levels.