pub struct OpenXrUiLayer<A> { /* private fields */ }Expand description
Headless Ailloli runtime and lazy Vulkan renderer for an OpenXR UI layer.
The renderer is allocated on the first frame, while runtime reconciliation is
performed during construction. Actions accumulate until Self::take_actions.
§Examples
use ailloli_ui_openxr::OpenXrUiLayer;
fn clear<A: 'static>(layer: &mut OpenXrUiLayer<A>) { layer.clear_input(); }Implementations§
Source§impl<A: 'static> OpenXrUiLayer<A>
impl<A: 'static> OpenXrUiLayer<A>
Sourcepub fn new(
runtime_handle: RuntimeHandle<A>,
root: impl IntoView<A>,
options: OpenXrUiLayerOptions,
) -> Result<Self, OpenXrRuntimeError>
pub fn new( runtime_handle: RuntimeHandle<A>, root: impl IntoView<A>, options: OpenXrUiLayerOptions, ) -> Result<Self, OpenXrRuntimeError>
Reconciles the root view and prepares a lazy renderer.
§Errors
The current constructor performs no fallible Vulkan work, but returns the runtime error type so initialization can remain uniform with future setup.
§Examples
use ailloli_ui_openxr::{OpenXrRuntimeError, OpenXrUiLayer, OpenXrUiLayerOptions};
use ailloli_ui_runtime::{app::RuntimeHandle, component::IntoView};
fn create<A: 'static>(handle: RuntimeHandle<A>, root: impl IntoView<A>) -> Result<OpenXrUiLayer<A>, OpenXrRuntimeError> { OpenXrUiLayer::new(handle, root, OpenXrUiLayerOptions::default()) }Sourcepub fn layout_paint_render(
&mut self,
frame: OpenXrExternalHostFrame<'_>,
) -> Result<VulkanRendererStats, OpenXrRuntimeError>
pub fn layout_paint_render( &mut self, frame: OpenXrExternalHostFrame<'_>, ) -> Result<VulkanRendererStats, OpenXrRuntimeError>
Lays out, routes optional input, paints, and renders one Vulkan frame.
Layout is tight to Self::logical_size. The first call allocates the
renderer. Pointer events are routed before paint; None retains existing
pointer/focus state. Text face blobs are refreshed before rendering.
§Errors
Returns Vulkan renderer initialization or frame-render errors.
§Panics
Panics only if successful renderer initialization fails to populate the layer’s internal renderer slot.
§Examples
use ailloli_ui_openxr::{OpenXrExternalHostFrame, OpenXrRuntimeError, OpenXrUiLayer};
use ailloli_ui_render_vulkan::VulkanRendererStats;
fn render<A: 'static>(layer: &mut OpenXrUiLayer<A>, frame: OpenXrExternalHostFrame<'_>) -> Result<VulkanRendererStats, OpenXrRuntimeError> { layer.layout_paint_render(frame) }Sourcepub fn clear_input(&mut self)
pub fn clear_input(&mut self)
Cancels captured pointer gestures, then clears mapper and keyboard focus.
§Examples
use ailloli_ui_openxr::OpenXrUiLayer;
fn clear<A: 'static>(layer: &mut OpenXrUiLayer<A>) { layer.clear_input(); }Sourcepub fn take_actions(&self) -> Vec<A>
pub fn take_actions(&self) -> Vec<A>
Drains and returns actions queued by the reconciled runtime.
An empty vector means no action was dispatched since the previous drain.
§Examples
use ailloli_ui_openxr::OpenXrUiLayer;
fn actions<A: 'static>(layer: &OpenXrUiLayer<A>) -> Vec<A> { layer.take_actions() }Sourcepub fn renderer_stats(&self) -> VulkanRendererStats
pub fn renderer_stats(&self) -> VulkanRendererStats
Returns the latest renderer counters or zeroed defaults before first frame.
§Examples
use ailloli_ui_openxr::OpenXrUiLayer;
use ailloli_ui_render_vulkan::VulkanRendererStats;
fn stats<A: 'static>(layer: &OpenXrUiLayer<A>) -> VulkanRendererStats { layer.renderer_stats() }Sourcepub fn logical_size(&self) -> Size
pub fn logical_size(&self) -> Size
Returns physical pixels divided by DPR as logical dimensions.
DPR is clamped to at least 0.0001; pixel axes are otherwise unmodified,
so zero pixels produce zero logical extent.
§Examples
use ailloli_ui_core::Size;
use ailloli_ui_openxr::OpenXrUiLayer;
fn size<A: 'static>(layer: &OpenXrUiLayer<A>) -> Size { layer.logical_size() }Auto Trait Implementations§
impl<A> !Freeze for OpenXrUiLayer<A>
impl<A> !RefUnwindSafe for OpenXrUiLayer<A>
impl<A> !Send for OpenXrUiLayer<A>
impl<A> !Sync for OpenXrUiLayer<A>
impl<A> Unpin for OpenXrUiLayer<A>
impl<A> !UnwindSafe for OpenXrUiLayer<A>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more