Canvas

class in UnityEngine

/

継承:Behaviour

マニュアルに切り替える

説明

スクリーンレンダリングのために使用することができる要素

キャンバス上の要素はオーバーレイモードを使用しているかカメラがアタッチされているかどちらかでシーンのレンダリングが行われた後レンダリングされます。

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(); myGO.name = "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; myText.name = "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 がルートかどうか
normalizedSortingGridSizeキャンバスが分割するレンダリング可能なエリアの正規化されたグリッドサイズ。
overridePixelPerfect階層内にあるネストされた Canvas で親から継承された pixelPerfect 設定で上書きするのを可能にします
overrideSortingCanvas のソートを上書きします
pixelPerfectピクセルと整列するようにキャンバスの要素を焼成します。renderMode が Screen Space のときのみ適用されます。
pixelRect Canvas のためのレンダー矩形を取得します。
planeDistance生成する Canvas のカメラからの距離
referencePixelsPerUnitデフォルトの 1unit あたりのピクセル数
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 のソーティングレイヤーの名前
sortingOrderソーティングレイヤーのオーダー順
targetDisplayOverlay モードで、どのディスプレイ番号に対して UI Canvas を表示するか
worldCamera「Screen Space - Camera」のとき、Cameraは Canvas のサイジングに使用されます。また、イベントが World Space を介して送信され、Camera 上で使用されます。

Static 関数

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

Events

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

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectこのコンポーネントはゲームオブジェクトにアタッチされます。コンポーネントはいつもゲームオブジェクトにアタッチされています。
tagゲームオブジェクトのタグ
transformThe Transform attached to this GameObject.
hideFlagsオブジェクトは非表示、シーンに保存、ユーザーが編集可能、などを設定する。
nameオブジェクト名

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagこのゲームオブジェクトは tag とタグ付けされているかどうか
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを取得します。
GetComponents GameObject から type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringReturns the name of the GameObject.

Static 関数

Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateoriginal のオブジェクトをクローンします

Operator

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