# Canvas

The `Canvas` class describes a scene canvas.

## Properties

| Property             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bounds`             | <p><code>(get) bounds: Bounds2D (set) (Not Available)</code></p><p>Represents the current 2D bounds relative to the parent element. This is the result of the layout calculation. Values are measured in 3D units.</p><p><strong>Note</strong>: The <code>Canvas.transform</code> property doesn't affect the layout, the transformation it specifies is applied on top of it.</p>                                                                                                                                                              |
| `height`             | <p><code>(get) height: ScalarSignal (set) height: ScalarSignal</code></p><p>Specifies the vertical size, in 3D units. <strong>Note:</strong> this is only effective when <code>renderMode</code> property is set to WORLD_SPACE.</p>                                                                                                                                                                                                                                                                                                            |
| `renderMode`         | <p><code>(get) renderMode: SceneModule.RenderMode (set) renderMode: SceneModule.RenderMode</code></p><p>Specifies how Canvas should be rendered. In SCREEN_SPACE mode, Canvas is automatically placed and sized to fit the screen, <code>width</code> and <code>height</code> properties are ignored. <code>transform</code> property is still used, it is applied on top of the focal plane transform. In WORLD_SPACE Canvas behaves as regular 3D object and is sized according to <code>width</code> and <code>height</code> properties.</p> |
| `useSafeAreaMargins` | <p><code>(get) useSafeAreaMargins: BoolSignal (set) useSafeAreaMargins: BoolSignal</code></p><p>Specifies if Canvas should automatically include SafeArea margin to its content. <strong>Note:</strong> this is only effective when <code>renderMode</code> property is set to SCREEN_SPACE.</p>                                                                                                                                                                                                                                                |
| `width`              | <p><code>(get) width: ScalarSignal (set) width: ScalarSignal</code></p><p>Specifies the horizontal size, in 3D units. <strong>Note:</strong> this is only effective when <code>renderMode</code> property is set to WORLD_SPACE.</p>                                                                                                                                                                                                                                                                                                            |

## Methods

This module exposes no methods.
