Struct OpenXrUiLayer

Source
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>

Source

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()) }
Source

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) }
Source

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(); }
Source

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() }
Source

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() }
Source

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,