Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · struct

Native::

FNetBrushMask

Experimental

One BrushMask record's content: the mask, or only its name.

Declaration

struct FNetBrushMask
Header
#include "Native/Net/NetRecord.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainCore"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.

Description

Payload layout: U64 hash (FBrushMask::Hash, never 0), U32 canonical size (FBrushMask::Encode's bytes), and nothing more for the hash-only form (kNetBrushMaskHashOnlyBytes). The full form goes on with U8 codec (ENetBrushMaskCodec) and the coded bytes; the encoder picks Predicted only when it is strictly smaller than Raw, and the decoder refuses the other choice (NonCanonical). A decoder rebuilds the canonical bytes and holds HashBytesV5 of them to the hash.

Properties

NameTypeDefaultMeaning
Hashuint64_t0—
CanonicalBytesuint32_t0

kBrushMaskHeaderBytes plus the samples: up to 8 MiB + 8 for a 16-bit 2048² mask.

bHashOnlyboolfalse—
Maskstd::shared_ptr<const FBrushMask>—

The decoded mask; null for the hash-only form or when the decoder was asked not to build it.