StereoKit Files

This update comes after a year of hard work on the still upcoming v0.4! Effort is still ongoing there, but it seemed worthwhile to wrap up all the non-breaking changes into a nice back-compatible release with some very nice additions! Many thanks go to @ponugotimanasaqc, @isacantarerom, @keveleigh, and the rest of my team at Qualcomm for their contributions to this release, as well as @austinbhale, @mvvvv and the rest of the community for their contributions and and feedback :)

This update has a hodgepodge of work in it, but notable highlights are MSAA in XR (4x MSAA is now on by default!) as well as major performance related improvements! Compressed .KTX2 texture support and various other GLTF improvement now also allow for GLTFPacking your assets for even more perf! New APIs are the RenderList API for drawing things offscreen, and the top level C# Easing library for easy animation effects!

Please enjoy! :)

RenderList API

• Added the RenderList API. [#473]
• Added Default.RenderList for access to the primary RenderList.

Easing API

• Added the StereoKit.Framework.Ease API for tweening animations. [#999]

New API Features

• Added Transparency.MSAA, which uses MSAA support to implement a limited depth aware transparency. [#1088]
• Added Renderer.ViewportScaling. [#1043]
• UI.PushEnabled now takes a HierarchyParent to modify its hierarchy inheritance behavior. [#1017]
• Hierarchy.Push now takes a HierarchyParent to modify its hierarchy inheritance behavior. [#1017]
• Added Tex.RenderTarget as a simpler option for making render target textures. [#1019]
• Added SK.QuitReason, SK.Quit can now also provide a reason. [#890]
• Added SK.Steppers for iterating over the list of registered ISteppers. [#1089]
• Added Matrix.LookAt, useful for functions like RenderList.DrawNow. [#1027]
• Added Vec3.XY1. [#1019]
• Added Hierarchy.ToLocal and Hierarchy.ToWorld for Ray types. [#1104]
• Added Input.FingerGlow to disable or enable the finger glow feature on UI materials. [#1139]
• Added Log.Diag. [#880]
• Added Text.Size with a width constraint. [#1003]
• Added UI.Enabled for reading current UI enabled state. [#887]
• UI.Text UI.TextAt, and Text.Add now support scrolling. [#1003]
• Added Platform.KeyboardSetLayout for customizing SK's fallback soft keyboard. [#873] See demo usage here.

Library Improvements

• MSAA now works in XR. [#990]
• Added support for basisu compressed KTX2 textures. [#1063]
• Added support for GLTFs using EXT_meshopt_compression. [#955]
• Added support for GLTFs using KHR_texture_transform (minus rotation). [#958]
• Added support for GLTFPacked GLTFs.
• Added support for lightmaps in GLTF files. [#964]
• StereoKit will now exit gracefully if the OpenXR runtime crashes underneath the app. [#1134]
• Various improvements for boosting performance! [#910], [#911], [#924], [#947], [#956], [#1066], [#1069]
• Added support for XR_KHR_android_thread_settings. [#942]
• Improved specular aliasing on PBR shaders. [#989]
• Audio pauses when the OpenXR session is suspended. [#1022]
• Enhanced UI.PopupPose behavior. [#1034]
• Improved UI Box shader. [#1131]
• ModelNodes no longer require both Mesh and Material. [#1161]
• SKSettings.assetsFolder will now default to "Assets" if not provided.

SDK Improvements

• SK's skshaderc compiler will now run on Arm64 devices.
• Updated skshaderc to use latest SPIRV tools. May fix various shader compilation issues.
• Added skshaderc support for OES External Texture samplers. [#1084]
• Android binaries are now byte aligned as per Google Play recommendations. [#1148]

Deprecations

• Tex.FromCubemapEquirectangular is now deprecated, use Tex.FromCubemap instead. This allows for loading cubemaps from other formats such as KTX2 in addition to Equirectangular. [#1117]
• MatParamName.TexScale (single float) is now deprecated, use MatParamName.TexTransform (float4, offx, offy, xscale, yscale) instead. If you are directly referencing tex_scale by string in SK standard shaders you'll need to update to tex_trans, but MatParamName.TexScale will continue to work as-is. [#958]
• SKSettings.disableUnfocusedSleep is now deprecated, use SKSettings.standbyMode instead. [#1124]
• SystemInfo.displayType is now deprecated, use Device.DisplayBlend instead.

Fixes

• Thread safety for SK.GetStepper. [#949]
• No more catch/rethrow in SK.Run. [#888]
• Fixed an issue with sprites randomly vanishing. [#1070]
• Fixed an issue with password inputs not bringing up a keyboard. [#889]
• Fixed hand mesh corruption when switching between fallback hand meshes and OpenXR provided hand meshes. [#899]
• Fixed an issue where reading from blank textures would hang the thread. [#971]
• Fixed an issue where disabled images would not look disabled. [#973]
• Fixed a small drift in the position of maximized simulator windows. [#1059]
• Fixed an issue with jumping joint scales on the hand fallback mesh. [#1073]
• Fix issue with Input cursor and text selection size/position being incorrect for non-default TextStyles. [#1151]

Install or Update

Installation is via the dotnet templates and NuGet, please refer here for instructions! https://stereokit.net/Pages/Guides/Getting-Started.html

If you already have a project using StereoKit, go to Project->Manage NuGet Packages, and update to this version! Do a full rebuild of your project afterwards.