Struct OpenXrExternalUiHostFrameParts

pub struct OpenXrExternalUiHostFrameParts<'a, 'ctx> {
    pub instance: &'a Instance,
    pub session: &'a Session<Vulkan>,
    pub reference_space: &'a Space,
    pub context: OpenXrExternalVulkanContext<'ctx>,
    pub predicted_display_time: Time,
    pub frame_time_ms: u128,
    pub input_focused: bool,
}

Borrowed host state required to render one externally driven frame.

frame_time_ms defaults to zero and input_focused defaults to true. The context lifetime may be shorter than the OpenXR handle lifetime.

Examples

use ailloli_ui_openxr::{OpenXrExternalUiHostFrameParts, OpenXrExternalVulkanContext};
fn make<'a>(instance: &'a openxr::Instance, session: &'a openxr::Session<openxr::Vulkan>, space: &'a openxr::Space, context: OpenXrExternalVulkanContext<'a>, time: openxr::Time) -> OpenXrExternalUiHostFrameParts<'a, 'a> {
    OpenXrExternalUiHostFrameParts::new(instance, session, space, context, time)
}

Fields

instance: &'a Instance

Instance used for action-profile and hand-extension calls.

session: &'a Session<Vulkan>

Running Vulkan-backed session.

reference_space: &'a Space

Space in which UI layer and input rays are expressed.

context: OpenXrExternalVulkanContext<'ctx>

Borrowed Vulkan device, queue, pool, and optional memory properties.

predicted_display_time: Time

Runtime-predicted display time used to locate input.

frame_time_ms: u128

Host frame interval in milliseconds; zero is allowed.

input_focused: bool

Whether input is accepted; false clears retained UI and action state.

Implementations

impl<'a, 'ctx> OpenXrExternalUiHostFrameParts<'a, 'ctx>

pub fn new( instance: &'a Instance, session: &'a Session<Vulkan>, reference_space: &'a Space, context: OpenXrExternalVulkanContext<'ctx>, predicted_display_time: Time, ) -> Self

Creates frame parts with zero frame time and focused input.

Examples

use ailloli_ui_openxr::{OpenXrExternalUiHostFrameParts, OpenXrExternalVulkanContext};
fn make<'a, 'ctx>(instance: &'a openxr::Instance, session: &'a openxr::Session<openxr::Vulkan>, space: &'a openxr::Space, context: OpenXrExternalVulkanContext<'ctx>, time: openxr::Time) -> OpenXrExternalUiHostFrameParts<'a, 'ctx> {
    OpenXrExternalUiHostFrameParts::new(instance, session, space, context, time)
}

pub fn with_frame_time_ms(self, frame_time_ms: u128) -> Self

Sets the UI runtime frame time in milliseconds.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHostFrameParts;
fn timed<'a, 'ctx>(frame: OpenXrExternalUiHostFrameParts<'a, 'ctx>) -> OpenXrExternalUiHostFrameParts<'a, 'ctx> { frame.with_frame_time_ms(16) }

pub fn with_input_focused(self, input_focused: bool) -> Self

Sets whether this frame may poll and route input.

Examples

use ailloli_ui_openxr::OpenXrExternalUiHostFrameParts;
fn unfocused<'a, 'ctx>(frame: OpenXrExternalUiHostFrameParts<'a, 'ctx>) -> OpenXrExternalUiHostFrameParts<'a, 'ctx> { frame.with_input_focused(false) }