This class contains functions for running the StereoKit library!

Static Fields and Properties

DisplayMode ActiveDisplayMode Since we can fallback to a different DisplayMode, this lets you check to see which Runtime was successfully initialized.
bool IsInitialized Has StereoKit been successfully initialized already? If initialization was attempted and failed, this value will be false.
SKSettings Settings This is a copy of the settings that StereoKit was initialized with, so you can refer back to them a little easier. These are read only, and keep in mind that some settings are only requests! Check SK.System and other properties for the current state of StereoKit.
SystemInfo System This structure contains information about the current system and its capabilites. There’s a lot of different MR devices, so it’s nice to have code for systems with particular characteristics!
UInt64 VersionId An integer version Id! This is defined using a hex value with this format: 0xMMMMiiiiPPPPrrrr in order of Major.mInor.Patch.pre-Release
string VersionName Human-readable version name embedded in the StereoKitC DLL.

Static Methods

Initialize Initializes StereoKit window, default resources, systems, etc.
Quit Lets StereoKit know it should quit! It’ll finish the current frame, and after that Step will return that it wants to exit.
Shutdown Shuts down all StereoKit initialized systems. Release your own StereoKit created assets before calling this.
Step Steps all StereoKit systems, and inserts user code via callback between the appropriate system updates.

Found an issue with these docs, or have some additional questions? Create an Issue on Github!