Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · member function

Native::FJoinStreamWriter::

Prepare

Experimental

Check the head's size, encode the start chunks, write the save into the store (memory when FJoinStreamConfig::MakeSaveStore is empty), read its header and index back through the store's file and plan the frames.

Declaration

EJoinWrite Prepare(FSaveParallelForFn ParallelFor = nullptr, void* ParallelContext = nullptr);
Header
#include "Native/Net/NetJoin.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
Any thread, once.

Description

Releases the plan.

Parameters

NameTypeDefaultMeaning
ParallelForFSaveParallelForFnnullptr

Handed to WriteSave for the cold pages; null reads them on this thread.

ParallelContextvoid*nullptr

Passed back to ParallelFor unchanged.

Returns

Ok; HeadTooLarge before any save work when the open strokes' tiles need a head over FJoinStreamConfig::MaxHeadBytes; SaveFailed; or the constructor's StrokeMismatch.

Note.

Any thread, once. Memory: the index's page plan and the start chunks, each freed once framed; the save itself only with the in-memory store. Disk: the save, once, with a file store.