UnityのCanvas Scaler【使い方とスクリプト】

defaultSpriteDPI

UI Scale ModeがConstant Physical Sizeの場合、Sprite画像1インチあたりのピクセル数を設定します。

○ 使い方
UIを物理的な大きさで表した場合、解像度が粗くなったりするのでピクセル数を設定してジャギーが現れないようにする等に使用されます。基準が物理的な大きさな為、物体の大きさに合わせたいUIに使用される事が多いです。

// １インチ辺りのピクセル数を指定します
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.defaultSpriteDPI = 1.1f;

dynamicPixelsPerUnit

UIが動的にビットマップを作成するために使用する1ユニットあたりのピクセル量を設定します。キャンバスがWorld Spaceの時のみ使用されます。1ユニットはtransformで１動かした時の移動幅と同じです。

○ 使い方
ワールド空間でのUIの解像度を変更したい場合などに使用します。ピクセル数を設定してジャギーが現れないようにする等に使用されます。

// １ユニット辺りのピクセル数を指定します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.dynamicPixelsPerUnit = 1.1f;

fallbackScreenDPI

UI Scale ModeがConstant Physical Sizeの場合、画面が1インチ中にどれだけドットを表示できるかわからない時、仮定として1インチ中にどれだけドットを表示できるか決めておく値です。

○ 使い方
ディスプレイによって解像度が違う為、１インチ中に表示できるドット数はユーザーによってマチマチです。その為、仮定で決めた数値の解像度にします。ここで決める値はだいたい下限の値にします。もっともショボい画面で画像がどの程度粗くなるのかをテストするのに最適です。

//１インチ中に表示できるドット数を仮定します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.fallbackScreenDPI = 1.1f;

matchWidthOrHeight

UI Scale ModeがScale With Screen Sizeの場合、Reference Resolutionの値と画面の解像度を計算してUIをスケーリングします。

縦もしくは横の解像度に合わせてスケーリングされます。この数字が低いほど横幅に合わせます。この数字が１に近いほど高さに合わせます。１以上は１として扱われます。

○ 使い方
これをスクリプトから変更する時は例えばスマホを縦から横に変えた時などです。縦画面なのか横画面なのかでUIの合わせるポイントを変更します。エディタ拡張でゲームに合わせたCanvasをワンボタンで作成する機能を作る時などに使用してもいいと思います。

// キャンバスのスケーリングを合わせ方を変更します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.matchWidthOrHeight = 0.1f;

physicalUnit

１ユニットをどういった単位にするのか指定します。

enum型です。

○ 使い方
動的に基準となる単位を変更してしまう事はほぼないかと思います。よっぽど明確に何かに合わせようという目的がない限り使う事はないでしょう。使うのであればAwakeで最初から変更することになると思います。使い道は例えばUIを物理演算で使用する場合などがあります。

//１ユニットの単位をセンチメートルにします。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.physicalUnit = CanvasScaler.Unit.Centimeters;

referencePixelsPerUnit

PixelsPerUnitはピクセルに対するゲーム上での大きさです。これはそのデフォルトの値です。

UnitはUnity上の距離です。PixelsPerUnitが100で、テキストの大きさが100×100ピクセルの場合、Unity上での大きさは１×1のものと同じ大きさになります。Scaleの値を考慮に入れて計算されます。

どーもシーン上に配置した時などでは反映されないようです。UGUIのインスペクターにあるSet Native SizeというボタンをクリックするとこのreferencePixelsPerUnitの値が反映されます。

動的に生成されたテクスチャなどはこのreferencePixelsPerUnitの影響を受けます。

○ 使い方
スプライトそのものもPixelsPerUnitを持っている為、コレとややこしい関係にありますが、スプライトのPixelsPerUnitに更にこのCanvasScalerのPixelsPerUnitを掛け合わせているようです。正直スクリプトからこの値を動的に変えることはほぼないと思います。エディタ拡張で専用のキャンバスをワンボタンで作成できるようにする場合などでしょうか。

//このキャンバスの１ピクセル辺りの大きさのデフォルト値を決定します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.referencePixelsPerUnit = 1.1f;

referenceResolution

UIを設置する際に画面に表示する解像度です。この解像度もUIのスケーリングに影響します。

○ 使い方
主にディスプレイのサイズに合わせる為に使用します。AwakeでScreen.width, Screen.heightをぶち込むのが一般的かと思います。コレらはエディタ上だとアクティブなウィンドウを取ってしまうので再生中にゲームビュー以外を操作する人はゲーム開始時にキャッシュしておきましょう。

//キャンバスの解像度をディスプレイのサイズに合わせます。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.referenceResolution = new Vector2(Screen.width,Screen.height);

scaleFactor

スクリーンにフィットさせながら中のUI全体を拡大縮小します。レンダーモードがScreen Spaceのときのみ適用されます。

○ 使い方
キャンバス全体を拡大縮小したい場合に使います。キャンバスをグループ毎に分けていればそのグループに対する演出などで使用できます。

//このキャンバス配下の全てのUIを1.1倍します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.scaleFactor = 1.1f;

screenMatchMode

UI Scale ModeがScale With Screen Sizeの場合のスケーリングの制御方法です。

enum型です。

○ 使い方
正直スクリプトからこの値を動的に変えることはほぼないと思います。エディタ拡張で専用のキャンバスをワンボタンで作成できるようにする場合などでしょうか。

// キャンバスのスケーリング方法を変更します。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.screenMatchMode = CanvasScaler.ScreenMatchMode.Expand;

uiScaleMode

Canvas 内の UI 要素をどのようにスケーリングするかを決めます。

enum型です。

○ 使い方
正直スクリプトからこの値を動的に変えることはほぼないと思います。エディタ拡張で専用のキャンバスをワンボタンで作成できるようにする場合などでしょうか。

//キャンバスのスケーリング方法を変えます。
CanvasScaler cs = GetComponent<CanvasScaler>();
cs.uiScaleMode = CanvasScaler.ScaleMode.ConstantPhysicalSize;