DevtoolsView
What the store reaches in the renderer, through the Frameloop, which sees the camera and the canvas.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
capture |
(entity) => string | undefined |
Frames the entity and reads the canvas. |
captureInstance |
(batch, index) => string | undefined |
Frames one instance of a batch and reads the canvas. |
captureScreen |
(options?) => string | undefined |
Renders the scene once from the camera the game draws with and reads the canvas: without the screen overlays where overlays is false. |
captureView |
(view, options?) => string | undefined |
Renders the scene once from a bookmarked camera and reads the canvas: with the screen overlays where overlays says. |
measureSeen? |
(groups) => SeenPixels[] |
Counts, for each group of objects, the pixels the camera draws of it with the scene in front and with nothing in front: what see reads. |
project |
(entity) => ScreenRect | undefined |
Where the entity stands on the canvas. |
projectInstance |
(batch, index) => ScreenRect | undefined |
Where one instance of a batch stands on the canvas. |
readBounds |
() => Box3 |
The box every object the scene draws stands in. |
readCamera? |
() => Camera |
The camera the game draws with, which the pick looks through, as project does. Where a view has none, the pick looks through the mounted orbit’s. |
readEntityBounds? |
(entity) => Box3 | undefined |
The box the entity’s drawn object stands in, its model as posed now, or undefined where it draws nothing. A view with none frames an entity by its body. |
readStats? |
(frames) => Promise<RenderStats> |
Draws frames frames and reads what the last one cost. |
readThree? |
() => RootState |
React Three Fiber’s state, which a read of the page reaches as three. |