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 が有効かどうか
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject (null if there is none attached).
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateReturns a copy of the object original.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.