You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/reference/needle-engine-attributes.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,10 @@ The table below shows a list of available attributes and their descriptions.
16
16
| --- | --- |
17
17
|**Loading**||
18
18
|`src`| Path to one or multiple glTF or glb files.<br/>Supported types are `string`, `string[]` or a stringified array (`,` separated) |
19
-
|`dracoDecoderPath`| URL to the draco decoder e.g. `./include/draco/` to use the local Draco decoder |
20
-
|`dracoDecoderType`| draco decoder type. Options are `wasm` or `js`. See [three.js documentation](https://threejs.org/docs/#examples/en/loaders/DRACOLoader.setDecoderConfig)|
21
-
|`ktx2DecoderPath`| URL to the KTX2 decoder e.g. `./include/ktx2/` to use the local KTX2 decoder |
19
+
|**Loading Display**|*Available options to change how the Needle Engine loading display looks. Use `?debugloadingrendering` for easier editing*|
20
+
|`loading-background`|**PRO** — Default: `transparent`. Change the loading background color (e.g. `#dd5500`) |
21
+
|`loading-logo-src`|**PRO** — Change the loading logo image (e.g. `https://yourdomain.com/logo.png` or `/logo.png`) |
22
+
| `hide-loading-overlay` | **PRO** — Do not show the loading overlay
22
23
|**Rendering**||
23
24
|`background-color`| optional, hex color to be used as a background color. Examples: `rgb(255, 200, 100)`, `#dddd00`|
24
25
|`background-image`| optional, URL to a skybox image (background image) or a preset string: `studio`, `blurred-skybox`, `quicklook`, `quicklook-ar`|
@@ -35,10 +36,10 @@ The table below shows a list of available attributes and their descriptions.
35
36
|`loadstart`| Name of the function to call when loading starts. Note that the arguments are `(ctx:Context, evt:Event)`. You can call `evt.preventDefault()` to hide the default loading overlay |
36
37
|`progress`| Name of the function to call when loading updates. `onProgress(ctx:Context, evt: {detail: {context:Context, name:string, index:number, count:number, totalProgress01:number, progress:ProgressEvent}) { ... }`|
37
38
|`loadfinished`| Name of the function to call when loading finishes |
38
-
|**Loading Display**|*Available options to change how the Needle Engine loading display looks. Use `?debugloadingrendering` for easier editing*|
39
-
|`loading-background`|**PRO** — Default: `transparent`. Change the loading background color (e.g. `#dd5500`)|
40
-
|`loading-logo-src`|**PRO** — Change the loading logo image (e.g. `https://yourdomain.com/logo.png` or `/logo.png`) |
41
-
| `hide-loading-overlay` | **PRO** — Do not show the loading overlay
39
+
|**Advanced**|*Available options to change how the Needle Engine loading display looks. Use `?debugloadingrendering` for easier editing*|
40
+
|`dracoDecoderPath`|URL to the draco decoder e.g. `./include/draco/` to use the local Draco decoder|
41
+
|`dracoDecoderType`|draco decoder type. Options are `wasm` or `js`. See [three.js documentation](https://threejs.org/docs/#examples/en/loaders/DRACOLoader.setDecoderConfig)|
42
+
|`ktx2DecoderPath`|URL to the KTX2 decoder e.g. `./include/ktx2/` to use the local KTX2 decoder |
42
43
|**Internal**||
43
44
|`hash`| Used internally, is appended to the files being loaded to force an update (e.g. when the browser has cached a glb file). Should not be edited manually. |
0 commit comments