StardustXR/website
1
0
Fork 0
Code Issues 3 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
technobaboo
2021-07-22 08:57:39 -05:00
parent 1e35359000
commit 23574c8e18
4 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/stardust-protocol/server/objects/environment.md
View File

@@ -1,5 +1,7 @@
# /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.

12
docs/stardust-protocol/server/objects/hmd.md
View File

@@ -1,9 +1,9 @@
# /hmd
Reference object to the HMD being used to render content and track head position.
Reference object to the HMD being used to render content and track head position. This does not currently work, but is planned to.
## Signals
### `setPosition(Vector3 position)`
### `setRotation(Quaternion rotation)`
### `setPose(Vector3 position, Quaternion rotation)`
### `setIPD(double meters)`
<!-- ## Signals -->
<!-- ### `setPosition(Vector3 position)` -->
<!-- ### `setRotation(Quaternion rotation)` -->
<!-- ### `setPose(Vector3 position, Quaternion rotation)` -->
<!-- ### `setIPD(double meters)` -->

2
docs/stardust-protocol/server/objects/input.md
View File

@@ -5,6 +5,6 @@ Object managing input and interaction.
## Signals
<!-- ### `registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)` -->
<!-- Creates a new [PointerInput](../types/input/inputtypes/PointerInput.fbs) at `/input/methods/[name]` with the origin, direction, and tilt specified. -->
<!-- -->
### `registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)`
Creates a new [InputHandler](../types/input/InputHandler.md) with the specified `name` and `field`, located relative to the space referenced in `spacePath` and the `postion` + `rotation`.

3
docs/stardust-protocol/server/objects/lifecycle.md
View File

@@ -1,4 +1,5 @@
# /lifecycle
Object representing the life cycle of the Stardust server, from start to each frame to end.
## Signals
@@ -7,4 +8,4 @@ Executes `method` on object at `path` on the client when the main logic loop of
`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.
`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).