Module sk

Sk related structs, enums and functions.

Examples

which are also unit tests:

Structs

MainThreadToken

A token you only find on the main thread. It is required to call rendering functions

Sk

This class contains functions for running the StereoKit library! https://stereokit.net/Pages/StereoKit/SK.html

SkInfo

Non canonical structure whose purpose is to expose infos far from Sk

SkSettings

StereoKit initialization settings! Setup SkSettings with your data before calling SkSetting.Init(). https://stereokit.net/Pages/StereoKit/SKSettings.html

SystemInfo

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

Enums

AppFocus

This tells about the app’s current focus state, whether it’s active and receiving input, or if it’s backgrounded or hidden. This can be important since apps may still run and render when unfocused, as the app may still be visible behind the app that does have focus. https://stereokit.net/Pages/StereoKit/AppFocus.html

AppMode

Which operation mode should we use for this app? Default is XR, and by default the app will fall back to Simulator if XR fails or is unavailable. https://stereokit.net/Pages/StereoKit/AppMode.html

DepthMode

This is used to determine what kind of depth buffer StereoKit uses! https://stereokit.net/Pages/StereoKit/DepthMode.html

DisplayBlend

This describes the way the display’s content blends with whatever is behind it. VR headsets are normally Opaque, but some VR headsets provide passthrough video, and can support Opaque as well as Blend, like the Varjo. Transparent AR displays like the HoloLens would be Additive. https://stereokit.net/Pages/StereoKit/DisplayBlend.html

DisplayMode

Specifies a type of display mode StereoKit uses, like Mixed Reality headset display vs. a PC display, or even just rendering to an offscreen surface, or not rendering at all! https://stereokit.net/Pages/StereoKit/DisplayMode.html

OriginMode

This describes where the origin of the application should be. While these origins map closely to OpenXR features, not all runtimes support each feature. StereoKit will provide reasonable fallback behavior in the event the origin mode isn’t directly supported. https://stereokit.net/Pages/StereoKit/OriginMode.html

QuitReason

Provides a reason on why StereoKit has quit. https://stereokit.net/Pages/StereoKit/QuitReason.html

StandbyMode

When the device StereoKit is running on goes into standby mode, how should StereoKit react? Typically the app should pause, stop playing sound, and consume as little power as possible, but some scenarios such as multiplayer games may need the app to continue running. https://stereokit.net/Pages/StereoKit/StandbyMode.html

Constants

DEFAULT_NAME

Default name of the applications is StereoKitApp

Functions

sk_active_display_mode^⚠

sk_app_focus^⚠

sk_get_quit_reason^⚠

sk_get_settings^⚠

sk_init^⚠

sk_is_stepping^⚠

sk_quit^⚠

sk_run^⚠

sk_run_data^⚠

sk_set_window^⚠

sk_set_window_xam^⚠

sk_shutdown^⚠

sk_shutdown_unsafe^⚠

sk_step^⚠

sk_system_info^⚠

sk_version_id^⚠

sk_version_name^⚠