Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrainCore module · function

Native::

DecodeBrushMaskRecord

Experimental

Read a BrushMask payload, all of Size.

Declaration

ENetDecode DecodeBrushMaskRecord(const uint8_t* Data, size_t Size, FNetBrushMask& Out, bool bBuildMask = true);
Header
#include "Native/Net/NetRecord.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrainCore"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Pure, any thread.

Parameters

NameTypeDefaultMeaning
Dataconst uint8_t*—

The payload.

Sizesize_t—

Its bytes.

OutFNetBrushMask&—

The hash, the canonical size, the form and (when bBuildMask) the mask.

bBuildMaskbooltrue

Make the FBrushMask (its levels); false only checks the bytes and the hash.

Returns

Ok; BadLength (a size that is no mask's), BadPayload (hash 0, an unknown codec, bytes that do not decode to a mask, or a hash that is not theirs), NonCanonical (the codec the encoder would not pick, a split zero run), Truncated or TrailingBytes. Out is unspecified unless Ok.

Note.

Pure, any thread. O(samples).