Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · function

Native::

EncodeSculptCommand

Experimental

Write one command as kSculptCommandBytes little-endian bytes.

Declaration

size_t EncodeSculptCommand(const FSculptCommand& Command, uint8_t* Out, size_t Capacity);
Header
#include "Native/SculptCommand.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.

Parameters

NameTypeDefaultMeaning
Commandconst FSculptCommand&—

The command to write.

Outuint8_t*—

Destination; at least kSculptCommandBytes.

Capacitysize_t—

Bytes Out can take.

Returns

Bytes written: kSculptCommandBytes, or 0 when Capacity is too small.

Note.

Pure, any thread.