Version: 2023.2
言語: 日本語


class in UnityEngine






Elements on a canvas are rendered AFTER Scene rendering, either from an attached camera or using overlay mode.

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using UnityEngine.UI;

// Create a Canvas that holds a Text GameObject.

public class ExampleClass : MonoBehaviour { void Start() { GameObject myGO; GameObject myText; Canvas myCanvas; Text text; RectTransform rectTransform;

// Canvas myGO = new GameObject(); = "TestCanvas"; myGO.AddComponent<Canvas>();

myCanvas = myGO.GetComponent<Canvas>(); myCanvas.renderMode = RenderMode.ScreenSpaceOverlay; myGO.AddComponent<CanvasScaler>(); myGO.AddComponent<GraphicRaycaster>();

// Text myText = new GameObject(); myText.transform.parent = myGO.transform; = "wibble";

text = myText.AddComponent<Text>(); text.font = (Font)Resources.Load("MyFont"); text.text = "wobble"; text.fontSize = 100;

// Text position rectTransform = text.GetComponent<RectTransform>(); rectTransform.localPosition = new Vector3(0, 0, 0); rectTransform.sizeDelta = new Vector2(400, 200); } }


additionalShaderChannelsGet or set the mask of additional shader channels to be used when creating the Canvas mesh.
cachedSortingLayerValue選択されたレイヤー ID(SortingLayerID)に基づいてキャッシュされた値が計算されます。
isRootCanvas Canvas がルートかどうか
overridePixelPerfect階層内にあるネストされた Canvas で親から継承された pixelPerfect 設定で上書きするのを可能にします
overrideSortingCanvas のソートを上書きします
pixelPerfectピクセルと整列するようにキャンバスの要素を焼成します。renderMode が Screen Space のときのみ適用されます。
pixelRect Canvas のためのレンダー矩形を取得します。
planeDistance生成する Canvas のカメラからの距離
referencePixelsPerUnitデフォルトの 1unit あたりのピクセル数
renderingDisplaySizeReturns the canvas display size based on the selected render mode and target display.
renderMode Canvas がワールドかオーバーレイモードかどうか
renderOrderThe render order in which the canvas is being emitted to the Scene. (Read Only)
rootCanvas各親を確認し見つけた最後の canvas を返すことによって、ルートに最も近い Canvas を返します。他に canvas が見つからない場合は、自身を返します。
scaleFactorスクリーンにフィットさせながらキャンバス全体のスケールするために使用します。renderMode が Screen Space のときのみ適用されます。
sortingLayerIDCanvas のソーティングレイヤーのユニーク ID
sortingLayerNameCanvas のソーティングレイヤーの名前
targetDisplayOverlay モードで、どのディスプレイ番号に対して UI Canvas を表示するか
updateRectTransformForStandaloneShould the Canvas size be updated based on the render target when a manual Camera.Render call is performed.
vertexColorAlwaysGammaSpaceShould the Canvas vertex color always be in gamma space before passing to the UI shaders in linear color space work flow.
worldCamera Camera used for sizing the Canvas when in Screen Space - Camera. Also used as the Camera that events will be sent through for a World Space Canvas.

Static 関数

ForceUpdateCanvasesコンテンツを更新するために強制的にすべての Canvas を更新します
GetDefaultCanvasMaterialCanvas 上にある通常の要素のレンダリングで使用されるデフォルトのマテリアルを取得します
GetETC1SupportedCanvasMaterialGets or generates the ETC1 Material.


preWillRenderCanvases Canvas のレンダリングが発生する前に呼び出されるイベント
willRenderCanvases Canvas のレンダリングが発生する前に呼び出されるイベント



isActiveAndEnabledReports whether a GameObject and its associated Behaviour is active and enabled.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagChecks the GameObject's tag against the defined tag.
GetComponentGets a reference to a component of type T on the same GameObject as the component specified.
GetComponentInChildrenGets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject.
GetComponentInParentGets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject.
GetComponentsGets references to all components of type T on the same GameObject as the component specified.
GetComponentsInChildrenGets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject.
GetComponentsInParentGets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject.
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
TryGetComponentGets the component of the specified type, if it exists.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static 関数

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
Instantiateoriginal のオブジェクトをクローンします


operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。