Struct OpenXrExternalUiHost

pub struct OpenXrExternalUiHost<A> { /* private fields */ }

Reusable renderer/input compositor driven by an application-owned XR loop.

It owns UI and optional ray swapchains but does not wait, begin, or end XR frames. Callers provide predicted time and submit returned layer references.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHost;
fn clear<A: 'static>(host: &mut OpenXrExternalUiHost<A>) { host.clear_input(); }

Implementations

impl<A: 'static> OpenXrExternalUiHost<A>

pub fn new( instance: &Instance, session: &Session<Vulkan>, context: OpenXrExternalVulkanContext<'_>, capabilities: OpenXrInputCapabilities, runtime_handle: RuntimeHandle<A>, root: impl IntoView<A>, options: OpenXrExternalUiHostOptions, ) -> Result<Self, OpenXrRuntimeError>

Allocates swapchains, renderer, input actions, and optional ray resources.

The caller retains ownership of the instance, session, and Vulkan context. Input actions are attached to session during construction.

Errors

Returns swapchain, renderer, action, session-attachment, or ray-resource initialization failures. Zero pixel extents are rejected.

Examples

use ailloli_ui_openxr::{OpenXrExternalUiHost, OpenXrExternalUiHostOptions, OpenXrExternalVulkanContext, OpenXrInputCapabilities, OpenXrRuntimeError};
use ailloli_ui_runtime::{app::RuntimeHandle, component::IntoView};
fn build<A: 'static>(instance: &openxr::Instance, session: &openxr::Session<openxr::Vulkan>, context: OpenXrExternalVulkanContext<'_>, handle: RuntimeHandle<A>, root: impl IntoView<A>) -> Result<OpenXrExternalUiHost<A>, OpenXrRuntimeError> {
    OpenXrExternalUiHost::new(instance, session, context, OpenXrInputCapabilities::new(false, false), handle, root, OpenXrExternalUiHostOptions::default())
}

pub fn render_frame<'a>( &'a mut self, frame: OpenXrExternalUiHostFrameParts<'a, '_>, ) -> Result<OpenXrExternalUiHostFrameResult<'a, A>, OpenXrRuntimeError>

Polls input, renders UI, releases the acquired image, and builds layers.

When input is unfocused, retained pointer state is cleared and the frame contains no input. UI image release is attempted even when rendering fails; if both fail, the render error takes precedence.

Errors

Returns input polling, ray upload, swapchain, rendering, or release errors.

Examples

use ailloli_ui_openxr::{OpenXrExternalUiHost, OpenXrExternalUiHostFrameParts, OpenXrExternalUiHostFrameResult, OpenXrRuntimeError};
fn render<'a, A: 'static>(host: &'a mut OpenXrExternalUiHost<A>, frame: OpenXrExternalUiHostFrameParts<'a, '_>) -> Result<OpenXrExternalUiHostFrameResult<'a, A>, OpenXrRuntimeError> {
    host.render_frame(frame)
}

pub fn clear_input(&mut self)

Clears retained UI pointer state and OpenXR source locks.

No release events are synthesized.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHost;
fn clear<A: 'static>(host: &mut OpenXrExternalUiHost<A>) { host.clear_input(); }

pub fn log_interaction_profiles( &self, instance: &Instance, session: &Session<Vulkan>, )

Logs active left and right interaction profiles when input is enabled.

Disabled input is a no-op.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHost;
fn log<A: 'static>(host: &OpenXrExternalUiHost<A>, instance: &openxr::Instance, session: &openxr::Session<openxr::Vulkan>) { host.log_interaction_profiles(instance, session); }

pub fn logical_size(&self) -> Size

Returns UI logical dimensions derived from pixel extent and DPR.

Examples

use ailloli_ui_core::Size;
use ailloli_ui_openxr::OpenXrExternalUiHost;
fn size<A: 'static>(host: &OpenXrExternalUiHost<A>) -> Size { host.logical_size() }

pub fn set_layer_options(&mut self, layer: OpenXrQuadLayerOptions)

Replaces the quad pose and geometry used for input mapping and submission.

This does not recreate pixel swapchains or renderer resources.

Examples

use ailloli_ui_openxr::{OpenXrExternalUiHost, OpenXrQuadLayerOptions};
fn move_panel<A: 'static>(host: &mut OpenXrExternalUiHost<A>) { host.set_layer_options(OpenXrQuadLayerOptions::default()); }

pub fn renderer_stats(&self) -> VulkanRendererStats

Returns counters from the most recently completed renderer frame.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHost;
use ailloli_ui_render_vulkan::VulkanRendererStats;
fn stats<A: 'static>(host: &OpenXrExternalUiHost<A>) -> VulkanRendererStats { host.renderer_stats() }