Struct Backend

pub struct Backend;

This class exposes some of StereoKit’s backend functionality. This allows for tighter integration with certain platforms, but also means your code becomes less portable. Everything in this class should be guarded by availability checks.

https://stereokit.net/Pages/StereoKit/Backend.html

Examples

use stereokit_rust::system::{Backend, BackendGraphics, BackendPlatform, BackendXRType, BackendOpenXR};

let graphics = Backend::graphics();
let platform = Backend::platform();
let xr_type = Backend::xr_type();

if cfg!(target_os = "windows") {
    assert_eq!(graphics, BackendGraphics::D3D11);
    assert_eq!(platform, BackendPlatform::Win32);
} else {
    assert_eq!(graphics, BackendGraphics::OpenGLESEGL);
    assert_eq!(platform, BackendPlatform::Linux);
}
assert_eq!(xr_type, BackendXRType::None);

assert_eq!(BackendOpenXR::eyes_sample_time(), 0);

Implementations

impl Backend

pub fn graphics() -> BackendGraphics

This describes the graphics API thatStereoKit is using for rendering. StereoKit uses D3D11 for Windows platforms, and a flavor of OpenGL for Linux, Android, and Web. https://stereokit.net/Pages/StereoKit/Backend/Graphics.html

see also backend_graphics_get

Examples

use stereokit_rust::system::{Backend, BackendGraphics};

let graphics = Backend::graphics();
if cfg!(target_os = "windows") {
    assert_eq!(graphics, BackendGraphics::D3D11);
} else {
    assert_eq!(graphics, BackendGraphics::OpenGLESEGL);
}

pub fn platform() -> BackendPlatform

What kind of platform is StereoKit running on? This can be important to tell you what APIs or functionality is available to the app. https://stereokit.net/Pages/StereoKit/Backend/Platform.html

see also backend_platform_get

Examples

use stereokit_rust::system::{Backend, BackendPlatform};

let platform = Backend::platform();
if cfg!(target_os = "windows") {
    assert_eq!(platform, BackendPlatform::Win32);
} else {
    assert_eq!(platform, BackendPlatform::Linux);
}

pub fn xr_type() -> BackendXRType

What technology is being used to drive StereoKit’s XR functionality? OpenXR is the most likely candidate here, but if you’re running the flatscreen Simulator, or running in the web with WebXR, then this will reflect that. https://stereokit.net/Pages/StereoKit/Backend/XRType.html

see also backend_xr_get_type

Examples

use stereokit_rust::system::{Backend, BackendXRType};

let xr_type = Backend::xr_type();
assert_eq!(xr_type, BackendXRType::None);