Struct SystemInfo

#[repr(C)]
pub struct SystemInfo { /* private fields */ }

Information about a system’s capabilities and properties! https://stereokit.net/Pages/StereoKit/SystemInfo.html

see also: SkInfo::get_system Sk::get_system

Examples

use stereokit_rust::sk::{Sk, SkSettings, SystemInfo, AppMode};
use stereokit_rust::system::LogLevel;

let mut settings = SkSettings::default();
settings.app_name("Test").mode(AppMode::Offscreen);
let sk = Sk::init(&settings).unwrap();
let system_info: SystemInfo = sk.get_system();
// 0 everywhere:
assert_eq!(system_info, SystemInfo::default());
Sk::shutdown();

Implementations

impl SystemInfo

pub fn get_display_width(&self) -> i32

Width of the display surface, in pixels! For a stereo display, this will be the width of a single eye. https://stereokit.net/Pages/StereoKit/SystemInfo/displayWidth.html

pub fn get_display_height(&self) -> i32

Height of the display surface, in pixels! For a stereo display, this will be the height of a single eye. https://stereokit.net/Pages/StereoKit/SystemInfo/displayHeight.html

pub fn get_spatial_bridge_present(&self) -> bool

Does the device we’re currently on have the spatial graph bridge extension? The extension is provided through the function crate::system::World::from_spatial_node. This allows OpenXR to talk with certain windows APIs, such as the QR code API that provides Graph Node GUIDs for the pose. https://stereokit.net/Pages/StereoKit/SystemInfo/spatialBridgePresent.html

pub fn get_perception_bridge_present(&self) -> bool

Can the device work with externally provided spatial anchors, like UWP’s Windows.Perception.Spatial.SpatialAnchor https://stereokit.net/Pages/StereoKit/SystemInfo/perceptionBridgePresent.html

pub fn get_eye_tracking_present(&self) -> bool

Does the device we’re on have eye tracking support present? This is not an indicator that the user has given the application permission to access this information. See Input.Gaze for how to use this data. https://stereokit.net/Pages/StereoKit/SystemInfo/eyeTrackingPresent.html

pub fn get_overlay_app(&self) -> bool

This tells if the app was successfully started as an overlay application. If this is true, then expect this application to be composited with other content below it! https://stereokit.net/Pages/StereoKit/SystemInfo/overlayApp.html

pub fn get_world_occlusion_present(&self) -> bool

Does this device support world occlusion of digital objects? If this is true, then World.OcclusionEnabled can be set to true, and crate::system::World::occlusion_material can be modified. https://stereokit.net/Pages/StereoKit/SystemInfo/worldOcclusionPresent.html

pub fn get_world_raycast_present(&self) -> bool

Can this device get ray intersections from the environment? If this is true, then crate::system::World::raycast_enabled can be set to true, and crate::system::World::raycast can be used. https://stereokit.net/Pages/StereoKit/SystemInfo/worldRaycastPresent.html

Trait Implementations

impl Clone for SystemInfo

fn clone(&self) -> SystemInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SystemInfo

fn default() -> SystemInfo

Returns the “default value” for a type.

impl PartialEq for SystemInfo

fn eq(&self, other: &SystemInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SystemInfo