Struct openxr::Entry

pub struct Entry { /* fields omitted */ }

Entry point to the API. Start here.

An Entry represents access to an OpenXR implementation. When the crate is built with the linked feature, this can be obtained at compile time with the linked constructor. The static feature provides a built-in copy of the Khronos OpenXR loader for use in this pattern. Alternatively, the loaded feature exposes the load and load_from constructors to manually load an OpenXR implementation at run-time.

Methods

impl Entry

pub fn linked() -> Self

Access entry points linked directly into the binary at compile time

Available if the linked feature is enabled. You must ensure that the entry points are actually linked into the binary, e.g. by enabling the static feature.

pub fn load() -> Result<Self, LoadError>

Load entry points at run time from the dynamic library openxr_loader according to the target platform's naming conventions

Available if the loaded feature is enabled.

pub fn load_from(path: &Path) -> Result<Self, LoadError>

Load entry points at run time from the dynamic library identified by path

Available if the loaded feature is enabled.

pub fn fp(&self) -> &RawEntry

Access the raw function pointers

pub fn create_instance(
    &self,
    app_info: ApplicationInfo,
    required_extensions: &ExtensionSet
) -> Result<Instance>

Create an OpenXR instance with certain extensions enabled

Most applications will want to enable at least one graphics API extension (e.g. khr_vulkan_enable) so that a Session can be created for rendering.

pub fn enumerate_extensions(&self) -> Result<ExtensionSet>

Determine the set of extensions supported by this OpenXR implementation

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.