Renderer-independent state engine for one running GPUI.Application.
A session owns declarative windows, root-view assigns, rendered snapshots, resources, strict event dispatch, and atomic callback transitions. It has no knowledge of native GPUI, displays, or network transports.
Ordinary applications should use GPUI.Runtime, which composes this state
engine with a display and synchronization lifecycle. Direct session use is an
advanced infrastructure boundary for remote hosting, custom runtimes, and
renderer-independent protocol integration.
Summary
Functions
Returns a specification to start this module under a supervisor.
Removes one declarative window by stable key or native session ID.
Validates and dispatches one display event, returning the handled fact and current snapshot.
Validates and dispatches display events in order, returning handled facts and current snapshot.
Removes one renderer-independent resource from the next snapshot.
Adds a keyed declarative window without remounting the application.
Stores one renderer-independent resource in the next snapshot.
Rerenders every window with its current module and assigns.
Delivers an OTP message to a window's root view.
Returns the current authoritative renderer-independent snapshot.
Starts the renderer-independent state engine linked to the caller.
Starts a session whose application mount is completed by its supervisor.
Converts a declarative window into its serializable representation.
Returns the session's declarative windows.
Types
@type operation_error() :: {:render_failed, term(), Exception.stacktrace()} | {:callback_failed, module(), atom(), term(), Exception.stacktrace()} | {:invalid_callback_return, module(), atom(), term()}
@type snapshot() :: GPUI.Snapshot.t()
@type state() :: %{ windows: [GPUI.WindowSpec.t()], resources: %{optional(String.t()) => map()}, next_window_id: pos_integer() }
@type topology_error() :: :duplicate_window_key | :window_not_found | :window_limit_reached | {:too_many_windows, pos_integer()}
Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec close_window(GenServer.server(), GPUI.WindowSpec.key() | pos_integer()) :: {:ok, snapshot()} | {:error, topology_error()}
Removes one declarative window by stable key or native session ID.
@spec dispatch_event(GenServer.server(), map()) :: {:ok, map(), snapshot()} | {:error, operation_error()}
Validates and dispatches one display event, returning the handled fact and current snapshot.
@spec dispatch_events(GenServer.server(), [map()]) :: {:ok, [map()], snapshot()} | {:error, operation_error()}
Validates and dispatches display events in order, returning handled facts and current snapshot.
@spec drop_resource(GenServer.server(), String.Chars.t()) :: :ok
Removes one renderer-independent resource from the next snapshot.
@spec open_window(GenServer.server(), GPUI.WindowSpec.t()) :: {:ok, pos_integer(), snapshot()} | {:error, topology_error()}
Adds a keyed declarative window without remounting the application.
@spec put_resource(GenServer.server(), String.Chars.t(), map()) :: :ok
Stores one renderer-independent resource in the next snapshot.
@spec refresh(GenServer.server()) :: {:ok, snapshot()} | {:error, term()}
Rerenders every window with its current module and assigns.
@spec send_view(GenServer.server(), pos_integer(), term()) :: {:ok, snapshot()} | {:error, :window_not_found | topology_error() | operation_error()}
Delivers an OTP message to a window's root view.
@spec snapshot(GenServer.server()) :: snapshot() | {:error, operation_error()}
Returns the current authoritative renderer-independent snapshot.
@spec start_link(keyword()) :: GenServer.on_start()
Starts the renderer-independent state engine linked to the caller.
@spec start_link_deferred(keyword()) :: GenServer.on_start()
Starts a session whose application mount is completed by its supervisor.
@spec window_payload(GPUI.WindowSpec.t()) :: map()
Converts a declarative window into its serializable representation.
@spec windows(GenServer.server()) :: [GPUI.WindowSpec.t()]
Returns the session's declarative windows.