Version: 5.4 (switch to 5.5b)
言語English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Canvas

class in UnityEngine

/

Inherits from: Behaviour

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

マニュアルに切り替える

Description

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

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

#pragma strict
@script RequireComponent(Canvas)
@script RequireComponent(UIRenderer)

var verts : UIVertex[];

function Start () { var canvas : Canvas = GetComponent ("Canvas"); canvas.renderMode = RenderMode.Overlay; verts = new UIVertex[4]; GenerateVerts(); }

function GenerateVerts() { GenerateSquare(); var uiRenderer : UIRenderer = GetComponent ("UIRenderer") ; uiRenderer.SetVertices (verts); var mat = Material (Shader.Find ("Sprites/Default")); uiRenderer.SetMaterial (mat, null); }

function GenerateSquare() { var vert : UIVertex; vert.color = Color32 (255, 0, 0, 255); vert.uv = Vector2 (0, 0); vert.position = Vector3 (0, 0); verts[0] = vert; vert.position = Vector3 (0, 300); verts[1] = vert; vert.position = Vector3 (300, 300); verts[2] = vert; vert.position = Vector3 (300, 0); verts[3] = vert; }

Variables

cachedSortingLayerValue選択されたレイヤー ID(SortingLayerID)に基づいてキャッシュされた値が計算されます。
isRootCanvas Canvas がルートかどうか
overridePixelPerfect階層内にあるネストされた Canvas で親から継承された pixelPerfect 設定で上書きするのを可能にします
overrideSortingCanvas のソートを上書きします
pixelPerfectピクセルと整列するようにキャンバスの要素を焼成します。renderMode が Screen Space のときのみ適用されます。
pixelRect Canvas のためのレンダー矩形を取得します。
planeDistance生成する Canvas のカメラからの距離
referencePixelsPerUnitデフォルトの 1unit あたりのピクセル数
renderMode Canvas がワールドかオーバーレイモードかどうか
renderOrderCanvas をシーンに描画する順番
rootCanvas各親を確認し見つけた最後の canvas を返すことによって、ルートに最も近い Canvas を返します。他に canvas が見つからない場合は、自身を返します。
scaleFactorスクリーンにフィットさせながらキャンバス全体のスケールするために使用します。renderMode が Screen Space のときのみ適用されます。
sortingGridNormalizedSizeキャンバスが分割するレンダリング可能なエリアの正規化されたグリッドサイズ。
sortingLayerIDCanvas のソーティングレイヤーのユニーク ID
sortingLayerNameCanvas のソーティングレイヤーの名前
sortingOrderソーティングレイヤーのオーダー順
targetDisplayOverlay モードで、どのディスプレイ番号に対して UI Canvas を表示するか
worldCamera「Screen Space - Camera」のとき、Cameraは Canvas のサイジングに使用されます。また、イベントが World Space を介して送信され、Camera 上で使用されます。

Static Functions

ForceUpdateCanvasesコンテンツを更新するために強制的にすべての Canvas を更新します
GetDefaultCanvasMaterialCanvas 上にある通常の要素のレンダリングで使用されるデフォルトのマテリアルを取得します
GetETC1SupportedCanvasMaterialETC1 マテリアルを取得、または、生成します。

Events

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

Inherited members

Variables

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

Public Functions

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 を返します
ToStringゲームオブジェクトの名前を返します

Static Functions

Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateオブジェクト obj を破棄します。
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateオブジェクト original のコピーを返します

Operators

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