class

FPieClientChannel

Module
Game
Header
#include "Game/PieClientChannel.h"
Namespace
Mowo

Properties

TypeNameDescription
static constexpr uint32_tskMagicDefault 0x4D504543u.
static constexpr uint32_tskVersionDefault 1.
static constexpr uint32_tskMaxWidthDefault 2560.
static constexpr uint32_tskMaxHeightDefault 1600.
static constexpr uint32_tskSlotsDefault 3.
static constexpr uint32_tskInputCapacityDefault 512.
static constexpr uint32_tskNoSlotDefault 0xFFFFFFFFu.

Constructors

SignatureNameDescription
FPieClientChannel() = defaultFPieClientChannel
~FPieClientChannel()~FPieClientChannel
FPieClientChannel(const FPieClientChannel&) = deleteFPieClientChannel

Public functions

ReturnsNameDescription
FPieClientChannel&operator=
boolCreateThe editor's side: a fresh, zeroed block under name.
boolOpenThe client's side.
voidClose
boolIsOpen
const std::string&GetName
std::stringMakeNameA short name unique to this editor process and client index; POSIX hosts cap shm names near 30 characters.
size_tRegionSize
voidSetRequestedSizeEditor -> client.
voidSetFocused
voidRequestQuit
boolPushInput
boolAcquireFrameThe newest frame since lastSeq, held for reading until ReleaseFrame: the client will not write that slot meanwhile.
voidReleaseFrame
FStatsReadStats
boolPopInputClient side.
voidGetRequestedSize
boolIsFocused
boolIsQuitRequested
uint8_t*BeginFrameA slot the editor is not reading and that is not the one last published; write at most skMaxWidth x skMaxHeight RGBA8 into it, then Publish.
voidPublishFrame
boolIsEditorCaughtUp
voidWriteStats

Function details

FPieClientChannel

C++
FPieClientChannel() = default

~FPieClientChannel

C++
~FPieClientChannel()

FPieClientChannel

C++
FPieClientChannel(const FPieClientChannel&) = delete

operator=

C++
FPieClientChannel& operator=(const FPieClientChannel&) = delete

Create

C++
bool Create(const std::string& name)

The editor's side: a fresh, zeroed block under name.

Open

C++
bool Open(const std::string& name)

The client's side.

Close

C++
void Close()

IsOpen

C++
bool IsOpen() const

GetName

C++
const std::string& GetName() const

MakeName

C++
static std::string MakeName(uint32_t processId, int32_t clientIndex)

A short name unique to this editor process and client index; POSIX hosts cap shm names near 30 characters.

RegionSize

C++
static size_t RegionSize()

SetRequestedSize

C++
void SetRequestedSize(uint32_t width, uint32_t height)

Editor -> client.

SetFocused

C++
void SetFocused(bool focused)

RequestQuit

C++
void RequestQuit()

PushInput

C++
bool PushInput(const FInputEvent& event)

AcquireFrame

C++
bool AcquireFrame(uint32_t& lastSeq, const uint8_t*& pixels, uint32_t& width, uint32_t& height)

The newest frame since lastSeq, held for reading until ReleaseFrame: the client will not write that slot meanwhile. False when nothing is new.

ReleaseFrame

C++
void ReleaseFrame()

ReadStats

C++
FStats ReadStats() const

PopInput

C++
bool PopInput(FInputEvent& out)

Client side.

GetRequestedSize

C++
void GetRequestedSize(uint32_t& width, uint32_t& height) const

IsFocused

C++
bool IsFocused() const

IsQuitRequested

C++
bool IsQuitRequested() const

BeginFrame

C++
uint8_t* BeginFrame()

A slot the editor is not reading and that is not the one last published; write at most skMaxWidth x skMaxHeight RGBA8 into it, then Publish.

PublishFrame

C++
void PublishFrame(uint32_t width, uint32_t height)

IsEditorCaughtUp

C++
bool IsEditorCaughtUp() const

WriteStats

C++
void WriteStats(const FStats& stats)
Generated from Game/PieClientChannel.h via game.json · Nov 5, 2026Version 1.0.0