diff --git a/404.html b/404.html index d42d6f26..494a9ca5 100644 --- a/404.html +++ b/404.html @@ -5,13 +5,13 @@ Page Not Found | Stardust XR - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/2a2a0c40.1be62d7b.js b/assets/js/2a2a0c40.df427140.js similarity index 97% rename from assets/js/2a2a0c40.1be62d7b.js rename to assets/js/2a2a0c40.df427140.js index 823e5a18..8d67e3a1 100644 --- a/assets/js/2a2a0c40.1be62d7b.js +++ b/assets/js/2a2a0c40.df427140.js @@ -1 +1 @@ -(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[697],{3905:function(e,t,r){"use strict";r.d(t,{Zo:function(){return d},kt:function(){return f}});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),u=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},p=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),p=u(r),f=a,m=p["".concat(o,".").concat(f)]||p[f]||c[f]||i;return r?n.createElement(m,l(l({ref:t},d),{},{components:r})):n.createElement(m,l({ref:t},d))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=p;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var u=2;u= 1.12.0")),(0,i.kt)("h3",{id:"download"},"Download"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/StardustXR/libstardustxr.git\ncd libstardustxr\n")),(0,i.kt)("h3",{id:"build"},"Build"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"meson build --prefix=/usr\ncd build\nninja\n")),(0,i.kt)("h3",{id:"install"},"Install"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"ninja install\n")),(0,i.kt)("h2",{id:"stardust-xr-reference-server"},(0,i.kt)("a",{parentName:"h2",href:"https://github.com/StardustXR/stardust-xr"},"stardust-xr")," (reference server)"),(0,i.kt)("h3",{id:"prerequisites-1"},"Prerequisites"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Meson >= 0.55.0"),(0,i.kt)("li",{parentName:"ol"},"Ninja"),(0,i.kt)("li",{parentName:"ol"},"CMake"),(0,i.kt)("li",{parentName:"ol"},"Flatbuffers >= 1.12.0"),(0,i.kt)("li",{parentName:"ol"},"EGL+GLES 3.2"),(0,i.kt)("li",{parentName:"ol"},"GLX+Xlib"),(0,i.kt)("li",{parentName:"ol"},"fontconfig"),(0,i.kt)("li",{parentName:"ol"},"dlopen"),(0,i.kt)("li",{parentName:"ol"},"OpenXR Loader (required even if run in flatscreen mode)")),(0,i.kt)("h3",{id:"download-1"},"Download"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/StardustXR/stardust-xr.git\ncd stardust-xr\n")),(0,i.kt)("h3",{id:"build-1"},"Build"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"meson build --prefix=/usr\ncd build\nninja\n")),(0,i.kt)("h3",{id:"install-1"},"Install"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"ninja install\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file +(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[697],{3905:function(e,t,r){"use strict";r.d(t,{Zo:function(){return d},kt:function(){return f}});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),u=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},p=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),p=u(r),f=a,m=p["".concat(o,".").concat(f)]||p[f]||c[f]||i;return r?n.createElement(m,l(l({ref:t},d),{},{components:r})):n.createElement(m,l({ref:t},d))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=p;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var u=2;u= 1.12.0")),(0,i.kt)("h3",{id:"download"},"Download"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/StardustXR/libstardustxr.git\ncd libstardustxr\n")),(0,i.kt)("h3",{id:"build"},"Build"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"meson build --prefix=/usr\ncd build\nninja\n")),(0,i.kt)("h3",{id:"install"},"Install"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"ninja install\n")),(0,i.kt)("h2",{id:"stardust-xr-reference-server"},(0,i.kt)("a",{parentName:"h2",href:"https://github.com/StardustXR/stardust-xr"},"stardust-xr")," (reference server)"),(0,i.kt)("h3",{id:"prerequisites-1"},"Prerequisites"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Meson >= 0.55.0"),(0,i.kt)("li",{parentName:"ol"},"Ninja"),(0,i.kt)("li",{parentName:"ol"},"CMake"),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"#libstardustxr-server-client-and-fusion"},"libstardustxr")),(0,i.kt)("li",{parentName:"ol"},"Flatbuffers >= 1.12.0"),(0,i.kt)("li",{parentName:"ol"},"EGL+GLES 3.2"),(0,i.kt)("li",{parentName:"ol"},"GLX+Xlib"),(0,i.kt)("li",{parentName:"ol"},"fontconfig"),(0,i.kt)("li",{parentName:"ol"},"dlopen"),(0,i.kt)("li",{parentName:"ol"},"OpenXR Loader (required even if run in flatscreen mode)")),(0,i.kt)("h3",{id:"download-1"},"Download"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/StardustXR/stardust-xr.git\ncd stardust-xr\n")),(0,i.kt)("h3",{id:"build-1"},"Build"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"meson build --prefix=/usr\ncd build\nninja\n")),(0,i.kt)("h3",{id:"install-1"},"Install"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"ninja install\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.8aafd5b2.js b/assets/js/runtime~main.cec72fb8.js similarity index 60% rename from assets/js/runtime~main.8aafd5b2.js rename to assets/js/runtime~main.cec72fb8.js index da4313f0..42469ba4 100644 --- a/assets/js/runtime~main.8aafd5b2.js +++ b/assets/js/runtime~main.cec72fb8.js @@ -1 +1 @@ -!function(){"use strict";var e,t,r,n,f,c={},o={};function a(e){var t=o[e];if(void 0!==t)return t.exports;var r=o[e]={id:e,loaded:!1,exports:{}};return c[e].call(r.exports,r,r.exports,a),r.loaded=!0,r.exports}a.m=c,a.c=o,e=[],a.O=function(t,r,n,f){if(!r){var c=1/0;for(d=0;d=f)&&Object.keys(a.O).every((function(e){return a.O[e](r[u])}))?r.splice(u--,1):(o=!1,f0&&e[d-1][2]>f;d--)e[d]=e[d-1];e[d]=[r,n,f]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var f=Object.create(null);a.r(f);var c={};t=t||[null,r({}),r([]),r(r)];for(var o=2&n&&e;"object"==typeof o&&!~t.indexOf(o);o=r(o))Object.getOwnPropertyNames(o).forEach((function(t){c[t]=function(){return e[t]}}));return c.default=function(){return e},a.d(f,c),f},a.d=function(e,t){for(var r in t)a.o(t,r)&&!a.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,r){return a.f[r](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({16:"1fbe18c3",53:"935f2afb",74:"86790a84",85:"1f391b9e",121:"4cc9031b",195:"c4f5d8e4",272:"3e4d3f97",300:"b4e94af8",342:"003df647",347:"1134c138",351:"1dea05a0",487:"c9dc9d85",500:"614808c6",514:"1be78505",523:"c5e91741",587:"42ef8d41",659:"255c4b9f",672:"5f7b5dec",697:"2a2a0c40",734:"78a5a427",770:"493a26d0",835:"7a96ca3d",852:"e3f705b4",855:"40d7c56e",881:"1dc27c04",918:"17896441",925:"57a1f8cb",993:"2bb13bfd"}[e]||e)+"."+{16:"99f31c05",53:"514c8858",74:"669ae4bd",85:"2f7cafbf",111:"75041932",121:"6f727758",195:"2a45bcd0",272:"f19a020b",300:"4dc3481a",342:"8de77408",347:"4af2cbb7",351:"464fc163",486:"58eb0f8c",487:"b9bf6ecb",500:"b001d3fa",514:"41ee86ca",523:"a9ddcc87",587:"3edccf78",608:"7f4ce0f0",615:"e1d6d5a1",659:"c65b0156",668:"6e212175",672:"fc261658",697:"1be62d7b",734:"0cdd6bb5",770:"a3eb14ea",835:"bbf96481",852:"9fccf29c",855:"4a8b2815",881:"a3c02258",918:"0ff9f9f9",925:"9da7858d",993:"e204e0d9"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.bd63019b.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},f="stardust-website:",a.l=function(e,t,r,c){if(n[e])n[e].push(t);else{var o,u;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d=f)&&Object.keys(a.O).every((function(e){return a.O[e](r[u])}))?r.splice(u--,1):(c=!1,f0&&e[d-1][2]>f;d--)e[d]=e[d-1];e[d]=[r,n,f]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var f=Object.create(null);a.r(f);var o={};t=t||[null,r({}),r([]),r(r)];for(var c=2&n&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((function(t){o[t]=function(){return e[t]}}));return o.default=function(){return e},a.d(f,o),f},a.d=function(e,t){for(var r in t)a.o(t,r)&&!a.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,r){return a.f[r](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({16:"1fbe18c3",53:"935f2afb",74:"86790a84",85:"1f391b9e",121:"4cc9031b",195:"c4f5d8e4",272:"3e4d3f97",300:"b4e94af8",342:"003df647",347:"1134c138",351:"1dea05a0",487:"c9dc9d85",500:"614808c6",514:"1be78505",523:"c5e91741",587:"42ef8d41",659:"255c4b9f",672:"5f7b5dec",697:"2a2a0c40",734:"78a5a427",770:"493a26d0",835:"7a96ca3d",852:"e3f705b4",855:"40d7c56e",881:"1dc27c04",918:"17896441",925:"57a1f8cb",993:"2bb13bfd"}[e]||e)+"."+{16:"99f31c05",53:"514c8858",74:"669ae4bd",85:"2f7cafbf",111:"75041932",121:"6f727758",195:"2a45bcd0",272:"f19a020b",300:"4dc3481a",342:"8de77408",347:"4af2cbb7",351:"464fc163",486:"58eb0f8c",487:"b9bf6ecb",500:"b001d3fa",514:"41ee86ca",523:"a9ddcc87",587:"3edccf78",608:"7f4ce0f0",615:"e1d6d5a1",659:"c65b0156",668:"6e212175",672:"fc261658",697:"df427140",734:"0cdd6bb5",770:"a3eb14ea",835:"bbf96481",852:"9fccf29c",855:"4a8b2815",881:"a3c02258",918:"0ff9f9f9",925:"9da7858d",993:"e204e0d9"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.bd63019b.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},f="stardust-website:",a.l=function(e,t,r,o){if(n[e])n[e].push(t);else{var c,u;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d Installation | Stardust XR - +
-

Installation

libstardustxr (server, client, and fusion)#

Prerequisites#

  1. Meson
  2. Ninja
  3. Flatbuffers >= 1.12.0

Download#

git clone https://github.com/StardustXR/libstardustxr.gitcd libstardustxr

Build#

meson build --prefix=/usrcd buildninja

Install#

ninja install

stardust-xr (reference server)#

Prerequisites#

  1. Meson >= 0.55.0
  2. Ninja
  3. CMake
  4. Flatbuffers >= 1.12.0
  5. EGL+GLES 3.2
  6. GLX+Xlib
  7. fontconfig
  8. dlopen
  9. OpenXR Loader (required even if run in flatscreen mode)

Download#

git clone https://github.com/StardustXR/stardust-xr.gitcd stardust-xr

Build#

meson build --prefix=/usrcd buildninja

Install#

ninja install
- +

Installation

libstardustxr (server, client, and fusion)#

Prerequisites#

  1. Meson
  2. Ninja
  3. Flatbuffers >= 1.12.0

Download#

git clone https://github.com/StardustXR/libstardustxr.gitcd libstardustxr

Build#

meson build --prefix=/usrcd buildninja

Install#

ninja install

stardust-xr (reference server)#

Prerequisites#

  1. Meson >= 0.55.0
  2. Ninja
  3. CMake
  4. libstardustxr
  5. Flatbuffers >= 1.12.0
  6. EGL+GLES 3.2
  7. GLX+Xlib
  8. fontconfig
  9. dlopen
  10. OpenXR Loader (required even if run in flatscreen mode)

Download#

git clone https://github.com/StardustXR/stardust-xr.gitcd stardust-xr

Build#

meson build --prefix=/usrcd buildninja

Install#

ninja install
+ \ No newline at end of file diff --git a/docs/getting-started/overview.html b/docs/getting-started/overview.html index 9b045535..d059d71c 100644 --- a/docs/getting-started/overview.html +++ b/docs/getting-started/overview.html @@ -5,13 +5,13 @@ Overview | Stardust XR - +

Overview

Description#

Stardust XR (informally known as Stardust) is an XR display server for Linux-based distros. Unlike display servers of the past that were run on bounded 2D screens, Stardust has to break convention in order to account for unbounded 3D space in any potential virtual or real environment.

Put simply, Stardust is a system UI framework where multiple different clients (programs that connect to Stardust directly) can create objects for the user to interact with. The user can choose to use the objects that work best for their current scenario, and default setups can easily be created so users start out with all the essentials.

Server#

The server is what renders all the meshes of each client, takes in input from input methods, and spits out input to input handlers according to the SUIS (Spatial Universal Interaction System). As well, the server is going to be part Wayland compositor and OpenXR runtime so all 2D and XR applications can be used together at once (if the hardware allows). It is the glue of Stardust, allowing any number of clients and apps to work in harmony while allowing the user full control in an intuitive way.

As new technologies come out, keeping the same server and trying to progressively upgrade it may lead to bloat and issues, so the protocol is designed to make creating new servers possible without too much hassle. Old interfaces can be deprecated without breaking the overall system, and new interfaces can be added if needed due to the object-oriented design. The design is highly inspired by game engines, however the reference server is made in StereoKit due to it being more optimal.

Reference Server#

Stardust has a reference server, but unlike other display servers this reference server is just as functional as any other Stardust server would be, because all the functionality is implemented in the clients. The server is just the glue.

The reference server uses StereoKit as its backend for many reasons:

  • Much more lightweight than any other framework/other engine
    • It was originally designed to run AR apps on HoloLens, and now it works on Quest
    • It's able to render thousands of objects on a HoloLens without breaking a sweat
  • Does not include unnecessary features that slow down performance
    • Physics and UI are not needed for Stardust, but those do not actively run and can always have an option to not be compiled at all.
  • Uses C-style C++ meaning not bytecode or interpreted (however has a C# API that is not used by Stardust)
  • Uses immediate mode rendering meaning the logic is many times easier to implement
  • Exposes its rendering insides whenever needed
    • Very needed for Wayland when it needs to display EGL Wayland surface textures on meshes
    • Overriding the depthbuffer per-pixel in fragment shader is useful for XR depth compositing
  • Is constantly getting new updates faster than most engines
    • World semantics for OpenXR was implemented ~1 week after the official OpenXR extension release
  • Is optimized to load resources JIT
    • Many game engines are best at caching their assets, but this is not practical in a display server
  • Uses OpenXR as its backend out of the box

IPC#

The Stardust XR IPC uses Unix domain sockets for initial connection and establishes anonymous pipes for communication.

Protocol#

The Stardust XR protocol is object-oriented, depending on a scenegraph on the server end and scenegraph or functionally equivalent structure on the client end. This allows easier implementation of the protocol while still remaining fast and reliable.

Clients#

The clients tell the server what models to draw, where they would like to accept input in, etc. Stardust clients are much more suited to widgets or user interfaces to 2D/XR apps. However, if a more fully featured application works better in Stardust it can do that too.

- + \ No newline at end of file diff --git a/docs/getting-started/run.html b/docs/getting-started/run.html index 1104ce91..fda74dae 100644 --- a/docs/getting-started/run.html +++ b/docs/getting-started/run.html @@ -5,14 +5,14 @@ Use | Stardust XR - +

Use

Server#

Stardust XRUsage: stardustxr [OPTIONS]
 Options:  -h,--help                   Print this help message and exit  -F,--flatscreen             Run Stardust in flatscreen mode  --field-debug               Draw translucent meshes around fields
- + \ No newline at end of file diff --git a/docs/stardust-protocol/client/initial-connection.html b/docs/stardust-protocol/client/initial-connection.html index ee995c02..5cdab53c 100644 --- a/docs/stardust-protocol/client/initial-connection.html +++ b/docs/stardust-protocol/client/initial-connection.html @@ -5,13 +5,13 @@ Initial Client Connection | Stardust XR - +
- + \ No newline at end of file diff --git a/docs/stardust-protocol/protocol.html b/docs/stardust-protocol/protocol.html index 80c89fdf..42565ccd 100644 --- a/docs/stardust-protocol/protocol.html +++ b/docs/stardust-protocol/protocol.html @@ -5,7 +5,7 @@ Protocol | Stardust XR - + @@ -13,7 +13,7 @@

Protocol

Data#

Every message uses flatbuffers and flexbuffers to add variant data such as method arguments and return values. The Stardust XR Message schema is:

namespace StardustXR;
 table Message {    type: ubyte;    id: uint;    object: string;    method: string;    error: string;    data:[ubyte] (flexbuffer);}
 root_type Message;

Message Types#

All fields not accounted for are assumed to be not included or 0 or ""

Error#

Field NameValue
type0
id0 or ID of method call
objectPath to the object the error comes from
methodWhat method caused the error (if applicable, otherwise this is an empty string)
errorString containing the error message itself
dataEmpty vector

Signal#

Signals are method calls that do not expect a response of any kind.

Field NameValue
type1
objectPath to object to send signal to
methodName of the method to execute
dataFlexbuffer containing arguments to pass to remote method

Method Call#

Method calls allow for remote procedure calling.

Field NameValue
type2
idDynamically generated ID to identify method return for this method
objectPath to object to execute method on
methodName of the method to execute
dataFlexbuffer containing arguments to pass to remote method

Method Return#

Message to pass the return value back to the program.

Field NameValue
type3
idThe same as the message call's ID
dataFlexbuffer containing return value

Data Types#

Stardust does not support the Map or FixedTypedVector flexbuffers datatypes.

Color#

A Vector of 4 float is treated as a Color in the form RGBA.

Vector2#

A Vector of 2 double is treated as a Vector2.

Vector3#

A Vector of 3 double is treated as a Vector3.

Quaternion#

A Vector of 4 double is treated as a Quaternion.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/environment.html b/docs/stardust-protocol/server/objects/environment.html index d784b171..e9d6a70c 100644 --- a/docs/stardust-protocol/server/objects/environment.html +++ b/docs/stardust-protocol/server/objects/environment.html @@ -5,13 +5,13 @@ /environment | Stardust XR - +

/environment

Interface managing the skytex and skylight (equivalent of desktop background).

Signals#

visible(bool enable)#

Enable or disables the skybox visibility (lighting remains active). This is not meant to be used for an additive AR mode as StereoKit will perform that when the OpenXR runtime indicates the layer's blend mode is additive.

setSkytex(string path)#

Sets the sky texture to be the image (HDR) at the absolute path.

setLighting(string path)#

Sets the ambient lighting (using spherical harmonics) to the HDR at the absolute path.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/field.html b/docs/stardust-protocol/server/objects/field.html index 9daa7c38..2f73dfa6 100644 --- a/docs/stardust-protocol/server/objects/field.html +++ b/docs/stardust-protocol/server/objects/field.html @@ -5,13 +5,13 @@ /field | Stardust XR - +

/field

Object managing fields for interaction.

Signals#

createBoxField(string name, Vector3 origin, Quaternion orientation, Vector3 size)#

Creates a new BoxField at /field/[name].

createSphereField(string name, Vector3 origin, float radius)#

Creates a new SphereField at /field/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/hmd.html b/docs/stardust-protocol/server/objects/hmd.html index 28643110..bf78ed23 100644 --- a/docs/stardust-protocol/server/objects/hmd.html +++ b/docs/stardust-protocol/server/objects/hmd.html @@ -5,13 +5,13 @@ /hmd | Stardust XR - +

/hmd

Reference object to the HMD being used to render content and track head position. This does not currently work, but is planned to.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/input.html b/docs/stardust-protocol/server/objects/input.html index e09d6082..d87cd605 100644 --- a/docs/stardust-protocol/server/objects/input.html +++ b/docs/stardust-protocol/server/objects/input.html @@ -5,13 +5,13 @@ /input | Stardust XR - +

/input

Object managing input and interaction.

Signals#

registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)#

Creates a new InputHandler with the specified name and field, located relative to the space referenced in spacePath and the postion + rotation.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/lifecycle.html b/docs/stardust-protocol/server/objects/lifecycle.html index 5b36cbfa..77cf2c7f 100644 --- a/docs/stardust-protocol/server/objects/lifecycle.html +++ b/docs/stardust-protocol/server/objects/lifecycle.html @@ -5,13 +5,13 @@ /lifecycle | Stardust XR - +

/lifecycle

Object representing the life cycle of the Stardust server, from start to each frame to end.

Signals#

subscribeLogicStep(string path, string method)#

Executes method on object at path on the client when the main logic loop of the server starts each frame.

method must have arguments of (double delta, double timeToRender).

delta gives the time in seconds between the current time and the last time the logic loop executed while timeToRender gives the time in ms since epoch when the current frame is expected to reach the user's eyes (returns 0 for now).

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/model.html b/docs/stardust-protocol/server/objects/model.html index 48f3775c..ed04d8ad 100644 --- a/docs/stardust-protocol/server/objects/model.html +++ b/docs/stardust-protocol/server/objects/model.html @@ -5,13 +5,13 @@ /model | Stardust XR - +

/model

Object managing graphical models.

Signals#

createFromFile(string name, string path)#

Creates a new Model at /model/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/spatial.html b/docs/stardust-protocol/server/objects/spatial.html index 8c97dcf8..6862c59f 100644 --- a/docs/stardust-protocol/server/objects/spatial.html +++ b/docs/stardust-protocol/server/objects/spatial.html @@ -5,13 +5,13 @@ /spatial | Stardust XR - +

/spatial

Object managing spatial nodes for parenting.

Signals#

create(string name, Vector3 origin, Quat orientation, Vector3 scale, bool translatable, bool rotatable, bool scalable)#

Creates a new Spatial at /spatial/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Model.html b/docs/stardust-protocol/server/types/Model.html index 6139f4c5..a07acfa5 100644 --- a/docs/stardust-protocol/server/types/Model.html +++ b/docs/stardust-protocol/server/types/Model.html @@ -5,13 +5,13 @@ Model | Stardust XR - +

Model

Derived from Spatial#

A graphical model.

Properties#

setOrigin(Vector3 origin)#

Sets the origin to origin.

setOrientation(Quat orientation)#

Sets the orientation to orientation.

setPose(Vector3 origin, Quat orientation)#

Sets the pose using origin and orientation absolutely.

destroy()#

Destroys the model instance. Resources like the mesh and material and textures may be in memory still, but the resource manager will clean it up if needed.

setMaterialProperty(uint32 submeshIndex, string propertyName, float value)#

setMaterialProperty(uint32 submeshIndex, string propertyName, Color value)#

setMaterialProperty(uint32 submeshIndex, string propertyName, string value)#

Sets the material property propertyName on this model's submesh at submeshIndex to value. Valid material names are:

NameTypeDescription
colorColorTint/multiply the shader's output color by this amount. (default is opaque white)
roughnessfloatScale the metal texture's roughness by this amount
metallicfloatScale the metal texture's metalness by this amount
tex_scalefloatScale the UV coordinates of all textures by this amount
diffusestringPath to the diffuse texture of the material (if it has one).
emissionstringPath to the emission texture of the material (if it has one).
metalstringPath to the metalness texture of the material (if it has one).
normalstringPath to the normal map texture of the material (if it has one).
occlusionstringPath to the occlusion map texture of the material (if it has one).
- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Node.html b/docs/stardust-protocol/server/types/Node.html index 083a88f7..3b8588b8 100644 --- a/docs/stardust-protocol/server/types/Node.html +++ b/docs/stardust-protocol/server/types/Node.html @@ -5,13 +5,13 @@ Node | Stardust XR - +

Node

A base type for all other types that exist in 3D space.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Spatial.html b/docs/stardust-protocol/server/types/Spatial.html index 6a45be77..7d5f421a 100644 --- a/docs/stardust-protocol/server/types/Spatial.html +++ b/docs/stardust-protocol/server/types/Spatial.html @@ -5,13 +5,13 @@ Spatial | Stardust XR - +

Spatial

Derived from Node#

A base type for types that exist in 3D space, always relative to another space or the engine's world space. Spatials are always relative because in AR or XXR reference spaces change constantly in response to new environments.

Internal Properties#

Sometimes it makes sense for a Spatial to not be scalable (like in Fields where scaling dramatically increases the number of steps to raymarch for pointers) or not be rotatable (point lights) or such, so these are disabled for certain Spatial-derived objects, mentioned right after "Derived from Spatial".

translatable: bool#

If false, object's origin cannot be modified from a client.

rotatable: bool#

If false, object's rotation cannot be modified from a client (e.g. point lights, point sound sources).

scalable: bool#

If false, object's scale cannot be modified from a client (e.g. Fields, PointerInput).

Methods#

move(Vector3 position)#

Moves the Spatial relative to itself if translatable is not false.

rotate(Quat rotation)#

Rotates the Spatial relative to itself if rotatable is not false.

rotateAround(Vector3 point, Quat rotation)#

Rotates the Spatial around point (relative to itself) if rotatable is not false.

scale(float scale)#

Multiplies the Spatial's scale vector by scale if scalable is not false.

setOrigin(Vector3 origin)#

Sets the origin to origin if translatable is not false.

setOrientation(Quat orientation)#

Sets the orientation to orientation if rotatable is not false.

setScale(Vector3 scale)#

Sets the scale to scale if scalable is not false.

setPose(Vector3 origin, Quat orientation)#

Sets the pose relative to the Spatial's space if translatable and rotatable are true. This method saves on IPC calls compared to setOrigin and setOrientation in sequence.

setTransform(Vector3 origin, Quat orientation)#

Sets the transform relative to the Spatial's space if translatable, rotatable and scalable are true. This method saves on IPC calls compared to setOrigin, setOrientation, and setScale in sequence.

setSpatialParent(string parentPath)#

Sets the spatial parent of this Spatial while keeping the "absolute" position in space intact.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/BoxField.html b/docs/stardust-protocol/server/types/field/BoxField.html index b9e1ca3b..c47f36db 100644 --- a/docs/stardust-protocol/server/types/field/BoxField.html +++ b/docs/stardust-protocol/server/types/field/BoxField.html @@ -5,13 +5,13 @@ BoxField | Stardust XR - +

BoxField

Derived from Field#

This field is in a rectangular prism shape.

Properties#

setSize(Vector3 size)#

Sets the size of the box.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/Field.html b/docs/stardust-protocol/server/types/field/Field.html index ce60d5c5..aae7ab4f 100644 --- a/docs/stardust-protocol/server/types/field/Field.html +++ b/docs/stardust-protocol/server/types/field/Field.html @@ -5,13 +5,13 @@ Field | Stardust XR - +

Field

Derived from Spatial#

Type that contains methods all Fields share. All fields created are under /field. See /field for the field factory.

Methods#

double distance(string spacePath, Vector3 point)#

Returns the distance from point to the surface of the object, positive if the point is outside and negative if inside. When point is far enough away the object will give an approximate distance to the origin instead of the surface.

Vector3 normal(string spacePath, Vector3 point)#

Returns the normal of point compared to the surface of the object. Normal always points toward object.

Vector3 closestPoint(string spacePath, Vector3 point)#

Returns the closest point from point to the surface of the object. Use this instead of distance and normal when best to limit IPC calls.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/SphereField.html b/docs/stardust-protocol/server/types/field/SphereField.html index b58bd30f..3ceb54b2 100644 --- a/docs/stardust-protocol/server/types/field/SphereField.html +++ b/docs/stardust-protocol/server/types/field/SphereField.html @@ -5,13 +5,13 @@ SphereField | Stardust XR - +

SphereField

Derived from Field#

This Field is in a sphere shape.

Properties#

setRadius(double size)#

Sets the radius of the sphere.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/InputHandler.html b/docs/stardust-protocol/server/types/input/InputHandler.html index 30726385..d2641464 100644 --- a/docs/stardust-protocol/server/types/input/InputHandler.html +++ b/docs/stardust-protocol/server/types/input/InputHandler.html @@ -5,13 +5,13 @@ InputHandler | Stardust XR - +

InputHandler

Derived from Spatial (scalable: false)#

A handler to allow clients to recieve input.

Methods#

setOrigin(Vector3 origin)#

Sets the origin to origin.

setOrientation(Quat orientation)#

Sets the orientation to orientation.

setPose(Vector3 origin, Quat orientation)#

Sets the pose using origin and orientation relative to the pose's space.

setField(string field)#

Sets the field this input handler will use.

setCallback(string callbackPath, string callbackMethod)#

Sets the callback this input handler will use.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/InputMethod.html b/docs/stardust-protocol/server/types/input/InputMethod.html index 4693a6f8..2cf6cd2e 100644 --- a/docs/stardust-protocol/server/types/input/InputMethod.html +++ b/docs/stardust-protocol/server/types/input/InputMethod.html @@ -5,13 +5,13 @@ InputMethod | Stardust XR - +

InputMethod

Derived from Spatial (scalable: false)#

Represents an input device generically, with specifics being fleshed out in subclasses.

Internal Properties#

type: uint8#

NameDescription
0GlobalA non-spatial input, used for power buttons and system volume and such
1ControllerContains a pose and datamap for buttons, trackpad, joystick, grip, trigger, etc.
2PointerInputDefined by origin, direction, and tilt with datamap for buttons, trackpad, etc.
3HandInputContains a full 27-bone hand skeleton (including forearm) and datamap for abstractions like grip, pinch distance/point, etc.

datamap: Dictionary#

See Datamap:

Internal Methods#

distanceToField(string field)#

Returns the distance from this input to a field in meters. field is the name of the field, not the full path.

serialize()#

Returns a serialized version of the InputMethod, each serialized schema is shown under #Serialization in the respective Input subclasses.

Serialization#

KeyValue Type
typeint
distancefloat

Datamap#

The datamap is a dictionary containing abstracted and raw data related to the input that clients can use to analyze input in the most optimal way. It has keys of type Key(Flexbuffers-specific, in any other language use a String) and values:

TypeExample UsesUsage Notes
boolDigital buttonsIf values are analog, use a float instead with 1.0 being considered true.
floatAnalog trigger, gripFor values such as grip/trigger, make the range 0.0-1.0, for something like a scroll wheel -0.5-0.5.
Vector2Touchpad, joystickFor values such as trackpad and joystick, make each component in the range of -0.5-0.5 and calculate+apply deadzone before setting these values.
Vector3Pinch position, grip axis vectorFor points and directions, make this a value inside the InputMethod's local space. Raw hand pose data should not be put in the datamap.

Standard supported datamap keys will be put in the individual type's documentation, however you can put more data in and some input handlers may be able to use that data for better interactions.

Methods#

modifyDatamap(Dictionary data)#

Merges the datamap of this InputMethod with data. Each key here will add to the datamap if not present and set the existing value if present. Any key not present in data will be unaffected.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html b/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html index ff90643a..712b6828 100644 --- a/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html +++ b/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html @@ -5,13 +5,13 @@ HandInput | Stardust XR - +

HandInput

Derived from InputMethod#

A full 27-bone hand+forearm input with useful abstractions provided through the datamap.

The local space of a hand is where +Z is away from the palm, +Y is from the palm to the fingers, and +X is orthogonal and to the right.

Serialization#

KeyValue Type
originVector3
directionVector3
tiltfloat
datamapDictionary
[    thumb metacarpal,    thumb proximal,    thumb distal,    thumb tip,    index metacarpal,    index proximal,    index intermediate,    index distal,    index tip,    middle metacarpal,    middle proximal,    middle intermediate,    middle distal,    middle tip,    ring metacarpal,    ring proximal,    ring intermediate,    ring distal,    ring tip,    little metacarpal,    little proximal,    little intermediate,    little distal,    little tip]

(This section is WIP)

Datamap#

Required#

KeyValue TypeDescription
confidencefloat (range 0.0-1.0)How confident the hand tracker is of the pose of the hand
isLeftbooltrue if this hand is the left hand, false if not
pinchStrengthfloat (range 0.0-1.0)How much the hand is pinching
pinchDistancefloat (>0.0)The distance in meters between the thumb and index finger
grabStrengthfloat (range 0.0-1.0)How much the hand is making a fist

Methods#

TODO: Properly secured field distance calculation accessible to clients

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html b/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html index 06d9b998..e629d5db 100644 --- a/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html +++ b/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html @@ -5,13 +5,13 @@ PointerInput | Stardust XR - +

PointerInput

Derived from InputMethod#

An input method for pointers, such as the Daydream's remote, a pointer put on an Index controller, Oculus style laser mouse, and your desktop's mouse in flatscreen.

The local space for a pointer is where +Z is along the pointer's direction, +X is to the right of the pointer when laying face up, and +Y is upward when laying face up.

Serialization#

KeyValue Type
originVector3
directionVector3
tiltfloat
datamapDictionary

Datamap#

Required#

KeyValue TypeDescription
selectfloat (range 0.0-1.0)Whether the pointer is attempting to select an object, usually through trigger. 1.0 is selected, 0.0 is not selected, and inbetween is to add smoothness to the interaction.
grabfloat (range 0.0-1.0)How much the pointer is attempting to grab an object. 0.0 is not grabbing at all, 1.0 is grabbing the strongest, and inbetween is to add smoothness.
scrollVector2 (component range -0.5-0.5)The amount to scroll on this input tick (sensitivity determined on the receiving client). Can be used for 2D scrolling as well as adjusting depth/size when grabbing an object.

Built in#

KeyValue TypeDescription
deepestPointDistancefloat (>=0.0)The distance along the ray where the deepest surface point resides.

Methods#

setDirection(Vector3 direction)#

Sets the direction the pointer is pointing in stage space.

setTilt(float angle)#

Sets the tilt of the pointer (rotation about the pointer direction) clockwise in radians.

setOrientation(Vector3 direction, float angle)#

Sets the direction and tilt of the pointer to save on IPC calls.

setPose(Vector3 origin, Vector3 direction, float angle)#

Sets the origin, direction, and tilt of the pointer to save on IPC calls.

- + \ No newline at end of file diff --git a/index.html b/index.html index 2c085e04..c038e8fc 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Stardust XR - +

Stardust XR

We Fight for the Users!

Get Started
Flexible

Flexible

Stardust allows you to make XR widgets or interfaces and run them among others. You don't have to make a whole system UI, just a few pieces.

Streamlined

Streamlined

Stardust is made using StereoKit, an XR application/rendering toolkit allowing for a fast and lightweight display server. The compiled server binary when statically linking StereoKit is less than 20MB and uses ~50MB of RAM (varies depending on clients).

  • To the left, a code editor showing Stardust Fusion creating several models and transforming them on the logicStep. To the right is the program running in Stardust.

    Code vs output of the Spatial Fusion demo.

  • A scene showing multiple widgets, including sliders like an equalizer and a virtual touchscreen.

    Multiple objects working independently all at once.

  • To the left, a code editor showing Stardust Fusion creating several models and transforming them on the logicStep. To the right is the program running in Stardust.

    Code vs output of the Spatial Fusion demo.

  • A scene showing multiple widgets, including sliders like an equalizer and a virtual touchscreen.

    Multiple objects working independently all at once.

1 of 2

- + \ No newline at end of file diff --git a/roadmap.html b/roadmap.html index 194d0bb7..10117219 100644 --- a/roadmap.html +++ b/roadmap.html @@ -5,13 +5,13 @@ Roadmap | Stardust XR - +

Roadmap

1.0 (Minimum Viable Product)#

  • Core functionality
    • IPC+RPC
    • Protocol documentation
  • Client
    • Fusion
      • Initial connection
      • Node type creation/destruction
      • Interface interaction
      • Callbacks
  • Server
    • Per-client scenegraph
    • Statically link StereoKit
    • Basic features
      • Logic step
      • Spatial transforms
        • Absolute movement
        • Relative movement
        • Spatial parenting
      • Models
        • Loading
        • Setting material parameters
      • Fields (SDFs for interaction)
        • Box field
        • Rounded box field
        • Sphere field
      • Input
        • Input methods
          • Hand input
            • Creation from OpenXR
            • Creation from StereoKit (flatscreen)
            • Interaction with clients
          • Pointer input
            • Creation from StereoKit (flatscreen, mouse cursor ray)
            • Interaction with clients
        • Input handler
          • Async input propagation through distance
      • Environment
        • Set skytex
        • Set skylight
      • Items
        • Base item class
        • Base item accepter class
        • Environment equirectangular item
        • Environment equirectangular accepter
      • 2D integration
        • Panels
          • Panel item
          • sk-wlroots (for Wayland)
            • Statically link wlroots
            • Rendering
            • Input seats
        • Panel shells
          • Accept panel items
          • Put surface on model material's texture
          • Feed input through to panel
          • Release panel items
- + \ No newline at end of file