docs: add viewport notes

pmndrs · Dec 7, 2024 · 0edd1fa · 0edd1fa
1 parent 2cba879
commit 0edd1fa
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/API/hooks.mdx b/docs/API/hooks.mdx
@@ -66,7 +66,7 @@ The hook is reactive, if you resize the browser for instance, you get fresh meas
 | `frameloop`       | Render mode: always, demand, never                                               | `always`, `demand`, `never`                                                                                                                                                                                    |
 | `performance`     | System regression                                                                | `{ current: number, min: number, max: number, debounce: number, regress: () => void }`                                                                                                                         |
 | `size`            | Canvas size in pixels                                                            | `{ width: number, height: number, top: number, left: number, updateStyle?: boolean }`                                                                                                                          |
-| `viewport`        | Viewport size in three.js units                                                  | `{ width: number, height: number, initialDpr: number, dpr: number, factor: number, distance: number, aspect: number, getCurrentViewport: (camera?: Camera, target?: THREE.Vector3, size?: Size) => Viewport }` |
+| `viewport`        | Canvas viewport size in three.js units. Note: This is different from [`gl.getViewport`](https://threejs.org/docs/index.html?q=webglren#api/en/renderers/WebGLRenderer.getViewport) which returns the drawbuffer size                                                   | `{ width: number, height: number, initialDpr: number, dpr: number, factor: number, distance: number, aspect: number, getCurrentViewport: (camera?: Camera, target?: THREE.Vector3, size?: Size) => Viewport }` |
 | `xr`              | XR interface, manages WebXR rendering                                            | `{ connect: () => void, disconnect: () => void }`                                                                                                                                                              |
 | `set`             | Allows you to set any state property                                             | `(state: SetState<RootState>) => void`                                                                                                                                                                         |
 | `get`             | Allows you to retrieve any state property non-reactively                         | `() => GetState<RootState>`                                                                                                                                                                                    |