Version: 2018.1

CanvasScaler

class in UnityEngine.UI

/

継承:EventSystems.UIBehaviour

マニュアルに切り替える

説明

CanvasScaler コンポーネントは Canvas 内の UI 要素の全体的なスケールとピクセル密度を制御するために使用されます。このスケーリングはフォントのサイズと画像のボーダーを含め、Canvas 下のすべてに影響を与えます。

'Screen Space - Overlay' や 'Screen Space - Camera' に設定されている Canvas のために、Canvas Scaler の UI Scale Mode は Constant Pixel Size や、Scale With Screen Size、 Constant Physical Size に設定することができます。

Constant Pixel Size モードを使用すると、UI 要素の位置とサイズはスクリーン上のピクセルに指定されます。また、これは CanvasScaler がアタッチされていないときの Canvas のデフォルトの機能です。しかし、CanvasScaler のスケールファクタの設定で、一定のスケーリングを Canvas 内のすべての UI 要素に適用することができます。

Using the Scale With Screen Size mode, positions and sizes can be specified according to the pixels of a specified reference resolution. If the current screen resolution is larger than the reference resolution, the Canvas will keep having only the resolution of the reference resolution, but will scale up in order to fit the screen. If the current screen resolution is smaller than the reference resolution, the Canvas will similarly be scaled down to fit. If the current screen resolution has a different aspect ratio than the reference resolution, scaling each axis individually to fit the screen would result in non-uniform scaling, which is generally undesirable. Instead of this, the ReferenceResolution component will make the Canvas resolution deviate from the reference resolution in order to respect the aspect ratio of the screen. It is possible to control how this deviation should behave using the screenMatchMode setting.

Constant Physical Size モードを使用することで、ミリメートル(millimeter)、ポイント(point)、パイカ(pica)といった物理単位で UI 要素の位置とサイズが明確になります。このモードはデバイスが正確に報告するスクリーン DPI によります。DPI を報告しないデバイスに使用するために、代わりの DPI を指定することができます。

'World Space' に設定されている Canvas のために、Canvas Scaler は Canvas の UI 要素のピクセル密度を制御するために使用することができます。

See Also: Canvas.

変数

defaultSpriteDPI1 インチあたりのピクセルは 'Reference Pixels Per Unit' 設定にマッチする 'Pixels Per Unit' 設定を持つスプライトのために使用されます
dynamicPixelsPerUnitText など UI に動的にビットマップを作成するために使用する 1 ユニットあたりのピクセル量
fallbackScreenDPIスクリーン DPI が不明な場合は、DPI と仮定します
matchWidthOrHeight基準解像度や組み合わせによる幅や高さにマッチするように Canvas のスケールを設定します
physicalUnit位置やサイズを明確にするための物理的なユニット。
referencePixelsPerUnitスプライトがこの 'Pixels Per Unit' 設定を有していれば、スプライトの 1 ピクセルは UI 内での 1 ユニットをカバーします。
referenceResolutionUI レイアウトの設計された解像度
scaleFactorこのファクタで Canvas 内のすべての UI 要素をスケーリングします
screenMatchMode現在の解像度のアスペクト比が基準解像度にフィットしない場合は、モードは Canvas 空間をスケールするのに使用されます
uiScaleModeCanvas 内の UI 要素をどのようにスケーリングするかを決めます。

Protected 関数

HandleCanvas スケーリングの計算を処理するメソッド
HandleConstantPhysicalSize一定の物理的なサイズのために Canvas スケーリングを処理します
HandleConstantPixelSize一定のピクセルサイズのために Canvas スケーリングを処理します
HandleScaleWithScreenSizeスクリーンサイズのスケールに Canvas スケーリングを処理します
HandleWorldCanvasワールド Canvas のために Canvas スケーリングを処理します
OnDisable MonoBehaviour.OnDisable を参照してください。
SetReferencePixelsPerUnitCanvas 上の referencePixelsPerUnit を設定します
SetScaleFactorCanvas 上の倍率を設定します
UpdateCanvas スケーリングを更新する必要がある場合、フレームごとにチェックする処理を行います。

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectこのコンポーネントはゲームオブジェクトにアタッチされます。コンポーネントはいつもゲームオブジェクトにアタッチされています。
tagゲームオブジェクトのタグ
transformThe Transform attached to this GameObject.
runInEditModeAllow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).
useGUILayoutこれを無効にすると、GUI のレイアウトフェーズをスキップすることができます
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 と名付けたメソッドを呼び出します
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesBehaviour 上で実行されているコルーチンをすべて停止します
StopCoroutineこの Behaviour 上で実行されている methodName という名のコルーチン、または routine として保持されているコルーチンをすべて停止します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringReturns the name of the GameObject.
IsActive GameObject と Component がアクティブになっている場合は true を返します。
IsDestroyedネイティブ表示の振る舞いが破棄された場合は true を返します。

Protected 関数

Awake MonoBehaviour.Awake を参照してください
OnBeforeTransformParentChangedMonoBehaviour.OnBeforeTransformParentChanged を参照してください
OnCanvasGroupChangedMonoBehaviour.OnCanvasGroupChanged を参照してください
OnCanvasHierarchyChanged親の Canvas の状態が変更されたとき呼び出されます。
OnDestroy MonoBehaviour.OnDestroy を参照してください
OnDidApplyAnimationProperties LayoutGroup.OnDidApplyAnimationProperties を参照してください
OnEnable MonoBehaviour.OnEnable を参照してください
OnRectTransformDimensionsChangeThis callback is called if an associated RectTransform has its dimensions changed.
OnTransformParentChangedMonoBehaviour.OnRectTransformParentChanged を参照してください
OnValidate MonoBehaviour.OnValidate を参照してください
Reset MonoBehaviour.Reset を参照してください
Start MonoBehaviour.Start を参照してください

Static 関数

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

Operator

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

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateFrame-rate independent MonoBehaviour.FixedUpdate message for physics calculations.
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーがフォーカスを取得、または、失ったときに、すべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitSent to all game objects before the application quits.
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterこの collider/rigidbody は他の collider/rigidbody に触れたときに OnCollisionEnter は呼び出されます。
OnCollisionEnter2Dオブジェクトのコライダーが別のコライダーに衝突したときに呼び出されます(2D 物理挙動のみ)
OnCollisionExitこの collider/rigidbody が他の collider/rigidbody と触れ合うのをやめたときに OnCollisionExit は呼び出されます。
OnCollisionExit2Dオブジェクトのコライダーと別のオブジェクトコライダーが衝突から離れた瞬間に呼び出されます(2D 物理挙動のみ)
OnCollisionStay:ref::OnCollisionStay is called once per frame for every collider/rigidbody that is touching rigidbody/collider.
OnCollisionStay2Dオブジェクトのコライダーと別のオブジェクトのコライダーが衝突している間、毎フレーム呼び出され続けます(2D 物理挙動のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit はキャラクターコントローラーが移動中にコライダーに衝突した際に、呼び出されます。
OnDestroyDestroying the attached Behaviour will result in the game or scene receiving OnDestroy.
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelectedオブジェクトが選択されている場合は、ギズモを描画するために OnDrawGizmosSelected を実装します。
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトに対するジョイントが外れたとき呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチした Joint2D が壊れたときに呼び出されます。
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントやサーバー上で呼び出されます。
OnMouseDown OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionパーティクルがコライダーにヒットしたときに OnParticleCollision が呼び出されます
OnParticleTriggerOnParticleTrigger は、パーティクルシステムのパーティクルが Triggers モジュールの条件を満たすときに呼び出されます。
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender はカメラがシーンのレンダリングを完了した後に呼び出されます
OnPreCullOnPreCull はカメラがシーンのカリングを行う直前に呼び出されます。
OnPreRenderOnPreRender はカメラがシーンのレンダリングを開始する前に呼び出されます。
OnRenderImageOnRenderImage はすべてのレンダリングが RenderImage へと完了したときに呼び出されます。
OnRenderObjectOnRenderObject はカメラがシーンをレンダリングした後に呼び出されます。
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnter Collider が他のトリガーイベントに侵入したときに OnTriggerEnter が呼び出されます。
OnTriggerEnter2Dオブジェクトにアタッチしたトリガーの中に別のオブジェクトが入ったときに呼び出されます。(2D 物理挙動のみ)
OnTriggerExit Collider が other のトリガーに触れるのをやめたときに OnTriggerExit は呼び出されます。
OnTriggerExit2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダーが衝突から離れた瞬間に、呼び出されます。(2D 物理挙動のみ)
OnTriggerStayOnTriggerStay is called once per physics update for every Collider other that is touching the trigger.
OnTriggerStay2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダー衝突している間、毎フレーム呼び出され続けます。(2D 物理挙動のみ)
OnValidateこの関数はスクリプトがロードされた時やインスペクターの値が変更されたときに呼び出されます(この呼出はエディター上のみ)
OnWillRenderObjectOnWillRenderObject is called for each camera if the object is visible and not a UI element.
Resetデフォルト値にリセットします
StartStart is called on the frame when a script is enabled just before any of the Update methods are called the first time.