Scripting API

Canvas

class in UnityEngine · UnityEngine.UIModule · inherits from Behaviour

27 of 28 of Unity's membersUnity's documentation

In Tassix

The root of a UI: everything below it is laid out in its rect. A screen-space root canvas covers the screen: its rect is the screen size over the scale factor, set at the end of every frame (before the canvases update, when layouts rebuild).

Constructors 1

Canvas()

Properties 21

AdditionalCanvasShaderChannels additionalShaderChannels { get; set; }

int cachedSortingLayerValue { get; }

bool isRootCanvas { get; }

float normalizedSortingGridSize { get; set; }

bool overridePixelPerfect { get; set; }

bool overrideSorting { get; set; }

bool pixelPerfect { get; set; }

Rect pixelRect { get; }

float planeDistance { get; set; }

float referencePixelsPerUnit { get; set; }

RenderMode renderMode { get; set; }

int renderOrder { get; }

Vector2 renderingDisplaySize { get; }

Canvas rootCanvas { get; }

float scaleFactor { get; set; }

int sortingLayerID { get; set; }

string sortingLayerName { get; set; }

int sortingOrder { get; set; }

int targetDisplay { get; set; }

bool vertexColorAlwaysGammaSpace { get; set; }

Camera? worldCamera { get; set; }

Methods 3

static void ForceUpdateCanvases()

static Material GetDefaultCanvasMaterial()

static Material GetETC1SupportedCanvasMaterial()

Events 2

static event WillRenderCanvases? preWillRenderCanvases

static event WillRenderCanvases? willRenderCanvases

Not in Tassix yet 1

updateRectTransformForStandalone