coderofsalvation/xrfragment
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update documentation

Browse source
This commit is contained in:
Leon van Kammen 2023-03-31 17:10:03 +02:00
parent 009d2d18f0
commit cd8c698a08
2 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/RFC.md
View file

@ -14,9 +14,13 @@
# XR Fragments (key/value params)
| param | type | category | notes |
|---------|---------------|-------------------------|-------------------------|
| prio | int (-10..1) | Asset loading / linking | \#static allow client to ignore lower-prio objects in the renderloop, to compensate frame-drop/cpu/gpu-overload scenario’soc/notes/prio.md |
```
⛁ = fragment in 3D asset-file (custom property)
⚂ = fragment in navigator URI (`document.location.href` e.g.)
```
| param | type | scope | navigator override |category | notes |
|---------|---------------|-------|--------------------|-------------------------|
| prio | int (-10..1) | ⛁ | Asset loading / linking | \#static allow client to ignore lower-prio objects in the renderloop, to compensate frame-drop/cpu/gpu-overload scenario’soc/notes/prio.md |
| pos | 3D vector | HREF navigation/portals | |

12
src/xrfragment/Parser.hx
View file

@ -5,12 +5,14 @@ package xrfragment;
class Parser { // # XR Fragments (key/value params)
public static var error:String = ""; //
@:keep
// ```
// ⛁ = fragment in 3D asset-file (custom property)
// ⚂ = fragment in navigator URI (`document.location.href` e.g.)
@:keep // ```
public static function parse(key:String,value:String,resultMap:haxe.DynamicAccess<Dynamic>):Bool {
var Frag:Map<String, EReg> = new Map<String, EReg>(); // | param | type | category | notes |
// |---------|---------------|-------------------------|-------------------------|
Frag.set("prio", Type.isInt); // | prio | int (-10..1) | Asset loading / linking | #include doc/notes/prio.md |
var Frag:Map<String, EReg> = new Map<String, EReg>(); // | param | type | scope | navigator override |category | notes |
// |---------|---------------|-------|--------------------|-------------------------|
Frag.set("prio", Type.isInt); // | prio | int (-10..1) | ⛁ | Asset loading / linking | #include doc/notes/prio.md |
Frag.set("pos", Type.isVector); // | pos | 3D vector | HREF navigation/portals | |
//