class
FPieClientChannel
- Module
- Game
- Header
#include "Game/PieClientChannel.h"- Namespace
Mowo
Properties
| Type | Name | Description |
|---|---|---|
static constexpr uint32_t | skMagic | Default 0x4D504543u. |
static constexpr uint32_t | skVersion | Default 1. |
static constexpr uint32_t | skMaxWidth | Default 2560. |
static constexpr uint32_t | skMaxHeight | Default 1600. |
static constexpr uint32_t | skSlots | Default 3. |
static constexpr uint32_t | skInputCapacity | Default 512. |
static constexpr uint32_t | skNoSlot | Default 0xFFFFFFFFu. |
Constructors
| Signature | Name | Description |
|---|---|---|
FPieClientChannel() = default | FPieClientChannel | |
~FPieClientChannel() | ~FPieClientChannel | |
FPieClientChannel(const FPieClientChannel&) = delete | FPieClientChannel |
Public functions
| Returns | Name | Description |
|---|---|---|
FPieClientChannel& | operator= | |
bool | Create | The editor's side: a fresh, zeroed block under name. |
bool | Open | The client's side. |
void | Close | |
bool | IsOpen | |
const std::string& | GetName | |
std::string | MakeName | A short name unique to this editor process and client index; POSIX hosts cap shm names near 30 characters. |
size_t | RegionSize | |
void | SetRequestedSize | Editor -> client. |
void | SetFocused | |
void | RequestQuit | |
bool | PushInput | |
bool | AcquireFrame | The newest frame since lastSeq, held for reading until ReleaseFrame: the client will not write that slot meanwhile. |
void | ReleaseFrame | |
FStats | ReadStats | |
bool | PopInput | Client side. |
void | GetRequestedSize | |
bool | IsFocused | |
bool | IsQuitRequested | |
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. |
void | PublishFrame | |
bool | IsEditorCaughtUp | |
void | WriteStats |
Function details
FPieClientChannel
C++
FPieClientChannel() = default~FPieClientChannel
C++
~FPieClientChannel()FPieClientChannel
C++
FPieClientChannel(const FPieClientChannel&) = deleteoperator=
C++
FPieClientChannel& operator=(const FPieClientChannel&) = deleteCreate
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() constGetName
C++
const std::string& GetName() constMakeName
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() constPopInput
C++
bool PopInput(FInputEvent& out)Client side.
GetRequestedSize
C++
void GetRequestedSize(uint32_t& width, uint32_t& height) constIsFocused
C++
bool IsFocused() constIsQuitRequested
C++
bool IsQuitRequested() constBeginFrame
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() constWriteStats
C++
void WriteStats(const FStats& stats)Generated from Game/PieClientChannel.h via game.json · Nov 5, 2026Version 1.0.0