Skip to main content
Version: 0.9.0 (next)

Session

Functions Index​

static QarResultqar_session_find_render_target (const QarSession *session, const char *connection, QarPeerId *out_peer)

Find an already-connected render target from its connection string. More...

static QarResultqar_session_get_graphics_device_id (const QarSession *session, QarGraphicsDeviceId *out_device_id, bool *out_present)

The GPU adapter the session's graphics devices were created on. More...

static QarResultqar_session_get_id (const QarSession *session, QarSessionId *out_session_id)

Get the current session id. More...

static voidqar_session_handle_destroy (QarSession *handle)

Destroy a session opaque handle. More...

Functions​

qar_session_find_render_target()​

QarResult qar_session_find_render_target (const QarSession * session, const char * connection, QarPeerId * out_peer)
inline static

Find an already-connected render target from its connection string.

Definition at line 2610 of file qar_streaming.h.

qar_session_get_graphics_device_id()​

QarResult qar_session_get_graphics_device_id (const QarSession * session, QarGraphicsDeviceId * out_device_id, bool * out_present)
inline static

The GPU adapter the session's graphics devices were created on.

Every render sender's frame textures live on this adapter, so create your own graphics device on it. It is the adapter actually in use: the one a chained QarGraphicsDeviceId named, else the one QAROS selected - the GPU of the target named in the launch invite of an application QAROS started - else the one the library picked.

Parameters
session

Active session handle.

out_device_id

Receives id_type, and luid (Windows) or uuid (other platforms). Initialize it with qar_graphics_device_id_default(); its header is left untouched so it can be chained as it is. Left unchanged when no adapter is known.

out_present

Receives whether the session knows its adapter.

Returns

Success, or QAR_STATUS_LOGIC_ERROR for an invalid handle or a null output.

Definition at line 2632 of file qar_streaming.h.

qar_session_get_id()​

QarResult qar_session_get_id (const QarSession * session, QarSessionId * out_session_id)
inline static

Get the current session id.

Definition at line 2606 of file qar_streaming.h.

qar_session_handle_destroy()​

void qar_session_handle_destroy (QarSession * handle)
inline static

Destroy a session opaque handle.

Tears down the active session while keeping persisted state, so a later qar_runtime_rejoin can restore it without onboarding.

Definition at line 2602 of file qar_streaming.h.


Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.