Class Canvas

Inheritance
Object
Object
Component
Behaviour
Canvas
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
[RequireComponent(typeof(RectTransform))]
public sealed class Canvas : Behaviour

Properties

additionalShaderChannels

Declaration
public AdditionalCanvasShaderChannels additionalShaderChannels { get; set; }
Property Value
Type Description
AdditionalCanvasShaderChannels

cachedSortingLayerValue

Declaration
public int cachedSortingLayerValue { get; }
Property Value
Type Description
Int32

isRootCanvas

Declaration
public bool isRootCanvas { get; }
Property Value
Type Description
Boolean

normalizedSortingGridSize

Declaration
public float normalizedSortingGridSize { get; set; }
Property Value
Type Description
Single

overridePixelPerfect

Declaration
public bool overridePixelPerfect { get; set; }
Property Value
Type Description
Boolean

overrideSorting

Declaration
public bool overrideSorting { get; set; }
Property Value
Type Description
Boolean

pixelPerfect

Declaration
public bool pixelPerfect { get; set; }
Property Value
Type Description
Boolean

pixelRect

Declaration
public Rect pixelRect { get; }
Property Value
Type Description
Rect

planeDistance

Declaration
public float planeDistance { get; set; }
Property Value
Type Description
Single

referencePixelsPerUnit

Declaration
public float referencePixelsPerUnit { get; set; }
Property Value
Type Description
Single

renderMode

Declaration
public RenderMode renderMode { get; set; }
Property Value
Type Description
RenderMode

renderOrder

Declaration
public int renderOrder { get; }
Property Value
Type Description
Int32

rootCanvas

Declaration
public Canvas rootCanvas { get; }
Property Value
Type Description
Canvas

scaleFactor

Declaration
public float scaleFactor { get; set; }
Property Value
Type Description
Single

sortingGridNormalizedSize

Declaration
[Obsolete("Setting normalizedSize via a int is not supported. Please use normalizedSortingGridSize", false)]
public int sortingGridNormalizedSize { get; set; }
Property Value
Type Description
Int32

sortingLayerID

Declaration
public int sortingLayerID { get; set; }
Property Value
Type Description
Int32

sortingLayerName

Declaration
public string sortingLayerName { get; set; }
Property Value
Type Description
String

sortingOrder

Declaration
public int sortingOrder { get; set; }
Property Value
Type Description
Int32

targetDisplay

Declaration
public int targetDisplay { get; set; }
Property Value
Type Description
Int32

worldCamera

Declaration
public Camera worldCamera { get; set; }
Property Value
Type Description
Camera

Methods

| Improve this Doc View Source

ForceUpdateCanvases()

Declaration
public static void ForceUpdateCanvases()

GetDefaultCanvasMaterial()

Declaration
public static Material GetDefaultCanvasMaterial()
Returns
Type Description
Material

GetDefaultCanvasTextMaterial()

Declaration
[Obsolete("Shared default material now used for text and general UI elements, call Canvas.GetDefaultCanvasMaterial()", false)]
public static Material GetDefaultCanvasTextMaterial()
Returns
Type Description
Material

GetETC1SupportedCanvasMaterial()

Declaration
public static Material GetETC1SupportedCanvasMaterial()
Returns
Type Description
Material

Events

| Improve this Doc View Source

willRenderCanvases

Declaration
public static event Canvas.WillRenderCanvases willRenderCanvases
Event Type
Type Description
Canvas.WillRenderCanvases

Extension Methods