Skip to content

ludus::platform::HostedWindowEndpoint::StartInfo

Ludus Wiki · API overview · Browse API

Struct

Session parameters for Start().

Declared in modules/platform/include/ludus/platform/hosted_window.h

#include <ludus/platform/hosted_window.h>
struct ludus::platform::HostedWindowEndpoint::StartInfo final

Fields

ParentDirectory

std::string_view ludus::platform::HostedWindowEndpoint::StartInfo::ParentDirectory
Existing absolute directory in which Start() creates the private session directory. Borrowed for the call. The resulting socket path must fit in 103 bytes, so prefer a short temporary directory.

Declared in modules/platform/include/ludus/platform/hosted_window.h

Width

foundation::uint32 ludus::platform::HostedWindowEndpoint::StartInfo::Width = 0
Initial extent in backing pixels; at most 32768 per axis. Zero is allowed.

Related types: foundation::uint32

Declared in modules/platform/include/ludus/platform/hosted_window.h

Height

foundation::uint32 ludus::platform::HostedWindowEndpoint::StartInfo::Height = 0
Initial extent in backing pixels; at most 32768 per axis. Zero is allowed.

Related types: foundation::uint32

Declared in modules/platform/include/ludus/platform/hosted_window.h

Scale

foundation::float32 ludus::platform::HostedWindowEndpoint::StartInfo::Scale = 1.0F
Initial backing scale (backing pixels per logical point), in (0, 16].

Related types: foundation::float32

Declared in modules/platform/include/ludus/platform/hosted_window.h

Visibility

WindowVisibility ludus::platform::HostedWindowEndpoint::StartInfo::Visibility = WindowVisibility::Visible
Initial visibility.

Related types: WindowVisibility

Declared in modules/platform/include/ludus/platform/hosted_window.h

ConsumerAdapterOrNull

const HostedAdapterIdentity* ludus::platform::HostedWindowEndpoint::StartInfo::ConsumerAdapterOrNull = nullptr
The adapter that imports the window's hosted surface, or null when there is none to announce (Metal, or a consumer without an adapter identity).
Borrowed for the call; the endpoint copies it and sends it in the Welcome. The window then reports it from HostedSurfaceChannel::TryGetConsumerAdapter(), and a Vulkan game prefers the matching adapter.

Related types: HostedAdapterIdentity

Declared in modules/platform/include/ludus/platform/hosted_window.h