Pular para o conteúdo
AstraDOCS

Astra.Components.UiCanvas

Astra atual · C# · 06 out. 2026Referência de assinaturas

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

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>.

Consulte também Canvas UI para propriedades, valores iniciais, requisitos e edição em Play.

Membro Categoria
.ctor Method
GetDocument Method
Remove Method
SetDocument Method
Wrap Method
Component Property
Enabled Property
InputCamera Property
InputReceiver Property
InstanceId Property
IsAlive Property
Mode Property
MovementSpace Property
Object Property
Occlusion Property
Offset Property
Order Property
Resolution Property
Rotation Property
TypeId Property
UnitsPerPixel Property

.ctor

public UiCanvas(Astra.Component component)
Parâmetro Tipo Contrato
component Astra.Component

GetDocument

public Astra.AssetGuid GetDocument(uint slot = 0)

Documento UI. Recurso do projeto por slot

Parâmetro Tipo Contrato
slot uint · Opcional: 0

Remove

public void Remove()

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

SetDocument

public void SetDocument(Astra.AssetGuid value, uint slot = 0)
Parâmetro Tipo Contrato
value Astra.AssetGuid
slot uint · Opcional: 0

Wrap

public static Astra.Components.UiCanvas Wrap(Astra.Component component)
Parâmetro Tipo Contrato
component Astra.Component

Component

public Astra.Component Component { get; }

Enabled

public bool Enabled { get; set; }

Habilitado

InputCamera

public Astra.ObjectReference InputCamera { get; set; }

Camera de entrada

InputReceiver

public Astra.ObjectReference InputReceiver { get; set; }

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

InstanceId

public ulong InstanceId { get; }

IsAlive

public bool IsAlive { get; }

Mode

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

Apresentação

MovementSpace

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

Espaço do movimento

Object

public Astra.GameObject Object { get; }

Occlusion

public bool Occlusion { get; set; }

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

Offset

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

Deslocamento local

Order

public float Order { get; set; }

Ordem

Faixa válida: -10000 a 10000.

Resolution

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

Resolução

Rotation

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

Rotação local

TypeId

public static string TypeId { get; }

UnitsPerPixel

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.