---
title: "Astra.Components.UiCanvas"
version: snapshot-2026-10-06
engineGeneration: astra-current
language: C#
status: semantic-reference
runtimeVerified: false
platformEvidence: []
url: https://astraengine.com.br/pt-br/snapshot-2026-10-06/api/astra-components-uicanvas/
---

# Astra.Components.UiCanvas

Canvas UI: Instância independente de documento de UI, na tela ou no objeto. Família Renderização · Interface.

**Namespace:** `Astra.Components` · **Assembly:** `Astra.Scripting` · **Tipo:** Struct

:::note[Sobre esta referência]
Assinaturas extraídas semanticamente com Roslyn/MSBuild. Isso confirma a superfície do código deste snapshot; não comprova execução no Android. As descrições vêm dos comentários da API. Membros sem explicação ainda exigem revisão editorial.
:::

## Declaração

```csharp
readonly struct Astra.Components.UiCanvas
```

Canvas UI: Instância independente de documento de UI, na tela ou no objeto. Família Renderização · Interface.

Referência estudada: https://docs.unity3d.com/Packages/com.unity.ugui@2.0/manual/class-Canvas.html

**Interfaces:** `Astra.Components.IComponentFacade<Astra.Components.UiCanvas>`.

## Onde acessar este tipo

Hierarquia → selecione o objeto → Inspector → Adicionar componente → **Renderização** / **Interface** → **Canvas UI**.

No Behavior em Play, obtenha a fachada com `Object.GetComponent<UiCanvas>()`; trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar `new UiCanvas(component)` envolve um componente existente; não adiciona um componente à cena.

## Roadmap e uso

[Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/): o membro presente nesta referência pertence ao contrato atual. O roadmap registra a família; não há promessa/data individual de evolução para cada membro. Membros ainda sem explicação especializada são indicados como revisão editorial pendente.

Para ler os campos e recursos pelo caminho do editor, use [mapa de acesso](/pt-br/snapshot-2026-10-06/editor/mapa-de-acesso/).

Consulte também [Canvas UI](/pt-br/snapshot-2026-10-06/componentes/astra-ui-canvas/) para propriedades, valores iniciais, requisitos e edição em Play.

## Membros

| Membro | Categoria |
|---|---|
| [.ctor](#member-706723e9affc38a5) | Method |
| [GetDocument](#member-eda975fe53a89291) | Method |
| [Remove](#member-2d9e8c3e181e785d) | Method |
| [SetDocument](#member-8585973dc4552982) | Method |
| [Wrap](#member-89705b7aa22a41ff) | Method |
| [Component](#member-08d571dd533bd2e6) | Property |
| [Enabled](#member-7cde971b39f68a2c) | Property |
| [InputCamera](#member-9429580b4c4d12cd) | Property |
| [InputReceiver](#member-58aeccd269f66471) | Property |
| [InstanceId](#member-5831e84f8405f826) | Property |
| [IsAlive](#member-2f03bbc5cecf6fbe) | Property |
| [Mode](#member-de309c4e6ca8f61f) | Property |
| [MovementSpace](#member-c52a0f29f65827e3) | Property |
| [Object](#member-d345cfde43355ce8) | Property |
| [Occlusion](#member-e1353dbc4b49273c) | Property |
| [Offset](#member-1a1be55ebc5c7fa4) | Property |
| [Order](#member-9bcd2e6bd8b3882d) | Property |
| [Resolution](#member-e61149985a6e062b) | Property |
| [Rotation](#member-07e04ab0e51212ad) | Property |
| [TypeId](#member-ea5ab67d9f162689) | Property |
| [UnitsPerPixel](#member-bd8a73af7da52e42) | Property |

<h3 id="member-706723e9affc38a5" class="astra-member">.ctor</h3>

```csharp
public UiCanvas(Astra.Component component)
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Constrói o tipo pela assinatura declarada. Um construtor de fachada envolve um componente existente; um record de configuração só tem efeito quando atribuído ao consumidor.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

| Parâmetro | Tipo | Contrato |
|---|---|---|
| `component` | `Astra.Component` |  |

<h3 id="member-eda975fe53a89291" class="astra-member">GetDocument</h3>

```csharp
public Astra.AssetGuid GetDocument(uint slot = 0)
```

Documento UI. Recurso do projeto por slot

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Documento UI. Recurso do projeto por slot

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

| Parâmetro | Tipo | Contrato |
|---|---|---|
| `slot` | `uint` |  · Opcional: `0` |

<h3 id="member-2d9e8c3e181e785d" class="astra-member">Remove</h3>

```csharp
public void Remove()
```

Remove a instância pelo ciclo nativo; dependências e ownership podem recusar.

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-8585973dc4552982" class="astra-member">SetDocument</h3>

```csharp
public void SetDocument(Astra.AssetGuid value, uint slot = 0)
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

| Parâmetro | Tipo | Contrato |
|---|---|---|
| `value` | `Astra.AssetGuid` |  |
| `slot` | `uint` |  · Opcional: `0` |

<h3 id="member-89705b7aa22a41ff" class="astra-member">Wrap</h3>

```csharp
public static Astra.Components.UiCanvas Wrap(Astra.Component component)
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Envolve um Component existente após conferir TypeId; não cria componente.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

| Parâmetro | Tipo | Contrato |
|---|---|---|
| `component` | `Astra.Component` |  |

<h3 id="member-08d571dd533bd2e6" class="astra-member">Component</h3>

```csharp
public Astra.Component Component { get; }
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Handle genérico da instância, usado para operações de reflexão e recursos.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-7cde971b39f68a2c" class="astra-member">Enabled</h3>

```csharp
public bool Enabled { get; set; }
```

Habilitado

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Habilitado:** Ativa/desativa a participação do componente no sistema consumidor; não remove seus dados.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-9429580b4c4d12cd" class="astra-member">InputCamera</h3>

```csharp
public Astra.ObjectReference InputCamera { get; set; }
```

Camera de entrada

**Caminho:** Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.

**Uso:** **Camera de entrada:** Câmera usada para o espaço de movimento/olhar dos controles do Canvas.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-58aeccd269f66471" class="astra-member">InputReceiver</h3>

```csharp
public Astra.ObjectReference InputReceiver { get; set; }
```

Jogador / receptor. Character ou motor de corpo dinâmico ativo.

**Caminho:** Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.

**Uso:** **Jogador / receptor:** Character ou motor de corpo dinâmico ativo.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-5831e84f8405f826" class="astra-member">InstanceId</h3>

```csharp
public ulong InstanceId { get; }
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Distingue a instância no mesmo objeto; importante para componentes múltiplos.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-2f03bbc5cecf6fbe" class="astra-member">IsAlive</h3>

```csharp
public bool IsAlive { get; }
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Validade do handle no mundo/geração atuais. Remoção e novo Play invalidam a referência.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-de309c4e6ca8f61f" class="astra-member">Mode</h3>

```csharp
public Astra.Components.UiCanvas.ModeOption Mode { get; set; }
```

Apresentação

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Apresentação:** Seleciona o modo do componente no domínio indicado; revise os campos que aparecem após trocar.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-c52a0f29f65827e3" class="astra-member">MovementSpace</h3>

```csharp
public Astra.Components.UiCanvas.MovementSpaceOption MovementSpace { get; set; }
```

Espaço do movimento

**Caminho:** Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.

**Uso:** **Espaço do movimento:** Escolhe espaço do vetor de movimento: mundo, jogador ou câmera de entrada.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-d345cfde43355ce8" class="astra-member">Object</h3>

```csharp
public Astra.GameObject Object { get; }
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Objeto dono deste componente; use para resolver composição.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-e1353dbc4b49273c" class="astra-member">Occlusion</h3>

```csharp
public bool Occlusion { get; set; }
```

Oclusão no mundo. Depth e hit de Canvas no mundo.

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Oclusão no mundo:** Depth e hit de Canvas no mundo.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-1a1be55ebc5c7fa4" class="astra-member">Offset</h3>

```csharp
public System.Numerics.Vector3 Offset { get; set; }
```

Deslocamento local

**Caminho:** Inspector → Canvas UI → Apresentação; ou fachada C# em um Behavior.

**Uso:** **Posição X:** Aplica-se ao Canvas no mundo; Tela usa o viewport. **Posição Y:** Aplica-se ao Canvas no mundo; Tela usa o viewport. **Posição Z:** Aplica-se ao Canvas no mundo; Tela usa o viewport.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-9bcd2e6bd8b3882d" class="astra-member">Order</h3>

```csharp
public float Order { get; set; }
```

Ordem

Faixa válida: -10000 a 10000.

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Ordem:** Ordena apresentação dos Canvas; compare sobreposição e entrada com o modo efetivo.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-e61149985a6e062b" class="astra-member">Resolution</h3>

```csharp
public System.Numerics.Vector2 Resolution { get; set; }
```

Resolução

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Largura:** Resolução local do plano no modo Mundo. No modo Tela, o retângulo é o viewport; não é resolução de referência para escala. **Altura:** Resolução local do plano no modo Mundo. No modo Tela, o retângulo é o viewport; não é resolução de referência para escala.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-07e04ab0e51212ad" class="astra-member">Rotation</h3>

```csharp
public System.Numerics.Vector3 Rotation { get; set; }
```

Rotação local

**Caminho:** Inspector → Canvas UI → Apresentação; ou fachada C# em um Behavior.

**Uso:** **Rotação X:** Aplica-se ao Canvas no mundo; Tela usa o viewport. **Rotação Y:** Aplica-se ao Canvas no mundo; Tela usa o viewport. **Rotação Z:** Aplica-se ao Canvas no mundo; Tela usa o viewport.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-ea5ab67d9f162689" class="astra-member">TypeId</h3>

```csharp
public static string TypeId { get; }
```

**Caminho:** Inspector → Canvas UI; ou fachada C# em um Behavior.

**Uso:** Identificador nativo usado em AddComponent/GetComponent.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

<h3 id="member-bd8a73af7da52e42" class="astra-member">UnitsPerPixel</h3>

```csharp
public float UnitsPerPixel { get; set; }
```

Unidades por pixel (m/px). Aplica-se ao Canvas no mundo; Tela usa o viewport.

Faixa válida: 0.00001 a 10.

**Caminho:** Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.

**Uso:** **Unidades por pixel:** Aplica-se ao Canvas no mundo; Tela usa o viewport.

**Roadmap deste membro:** [Canvas e UI de jogo](/pt-br/snapshot-2026-10-06/ui/roadmap/). Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.