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

activeTexture

このカメラが描画しているレンダーテクスチャーです。

何も設定してない場合はnullが返ってきます。

読み取り専用です。

○ 使い方
カメラが使用しているレンダーテクスチャーを取得したい時に使用します。

//カメラに設定されているレンダーテクスチャーを取得する
Camera came = GetComponent<Camera>();
RenderTexture tex = came.activeTexture;

actualRenderingPath

このカメラの現在使用しているレンダリングパスです。

読み取り専用です。

enum型です。

○ 使い方
このカメラが使用しているレンダリングパスを知りたい場合に使用します。

例えば、ユーザーが低スペック端末等でプレイする時、レンダリングパスがサポートされていない場合があります。それを検知する時に使用します。

Camera came = GetComponent<Camera>();
if(came.actualRenderingPath != RenderingPath.DeferredShading)
{
　　Debug.Log("想定していたレンダリング方法になっていない");
}

allowDynamicResolution

動的にこのカメラの解像度を変更する事を許可します。

○ 使い方
主に処理が重くなった時などに、一時的に解像度を下げる場合に使用します。

これにチェックが入っていると動的な解像度の変更が可能になるだけで、処理自体は自分で行う必要があります。

Camera came = GetComponent<Camera>();
came.allowDynamicResolution = true;

allowHDR

より広い明るさの幅を表現できる機能を使用する事を許可します。

○ 使い方
ハイダイナミックレンジレンダリングのオンオフを切り替えたい場合に使用します。

Camera came = GetComponent<Camera>();
came.allowHDR = true;

allowMSAA

カメラが映した結果が荒くなってジャギジャギになってしまった場合、それを滑らかに緩和する機能を使用する事を許可します。

○ 使い方
アンチエイリアスのオンオフを切り替えたい場合に使用します。

trueだとProject SettingsのQualityタブのAnti Aliasingで選択された項目が適用されます。

Camera came = GetComponent<Camera>();
came.allowMSAA = true;

areVRStereoViewMatricesWithinSingleCullTolerance

ステレオビューマトリックスがシングルパスカリングに適しているかどうかを返します。

読み取り専用です。

○ 使い方
ステレオビューマトリックスを手動で設定したい時、シングルパスレンダリングが可能かどうか事前にチェックするのに使います。

Camera came = GetComponent<Camera>();
if(came.areVRStereoViewMatricesWithinSingleCullTolerance)
{
　　Debug.Log("このカメラはシングルパスレンダリングができます");
}

aspect

このカメラのアスペクト比です。

幅を高さで割った値です。

○ 使い方
現在のカメラのアスペクト比を知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("このカメラのアスペクト比は" + came.aspect + "です");

backgroundColor

CameraClearFlagsがSolidColorに設定されている場合、もしくはSkyboxに設定されているけどSkyboxがnullだった場合、背景に塗られる色です。

○ 使い方
背景色を変えたい場合などに使用します。

Camera came = GetComponent<Camera>();
came.backgroundColor = Color.black;

cameraToWorldMatrix

Cameraから見た位置をワールド座標に変換するために使用する行列を返します。

読み取り専用です。

○ 使い方
カメラから見た相対的な位置がわかっているもののワールド座標が知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Matrix4x4 m = came.cameraToWorldMatrix;
Vector3 p = m.MultiplyPoint(new Vector3(0, 0, -1f * came.nearClipPlane));
Debug.Log("このカメラは" + p.ToString() + "の位置から描画し始めます。");

cameraType

このカメラの種類を指定します。

enum型です。

○ 使い方
このカメラがどのようなカメラなのか知りたい場合に使用します。

if (Camera.current.cameraType == CameraType.SceneView)
{
　　Debug.Log("このカメラはシーンビュー用です");
}

clearFlags

カメラが何も映していない場所をどのように処理するのかを決定します。

詳しくはインスペクターの項目で解説しています。

enum型です。

○ 使い方
カメラのクリアフラグを途中で切り替えたい場合などに使用します。

//このカメラを深度カメラに変更します
Camera came = GetComponent<Camera>();
came.clearFlags = CameraClearFlags.Depth;

clearStencilAfterLightingPass

カメラがDeferred Light Pathの後にステンシルバッファをクリーンにする必要があるかどうかを設定します。

○ 使い方
ステンシルバッファを強制的に消したい場合などに使用します。

Camera came = GetComponent<Camera>();
came.clearStencilAfterLightingPass = true;

commandBufferCount

このカメラに設定されているコマンドバッファ数を取得します。

読み取り専用です。

○ 使い方
コマンドバッファ数を知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("コマンドバッファが" + came.commandBufferCount + "個設定されています。");

cullingMask

このカメラが描画するレイヤーを指定します。

○ 使い方
ビットフラグ形式になっているため注意が必要です。

//このカメラをDefault layerのゲームオブジェクトだけ描画するようにします
Camera came = GetComponent<Camera>();
cam.cullingMask = 1 << 0;

cullingMatrix

カリングクエリに使うためのカメラのカスタムマトリクスを設定します。

○ 使い方
複数のカメラをまったく同じようにカリングする時などに使用します。

Camera came = GetComponent<Camera>();
Camera.main.cullingMatrix = came.projectionMatrix * came.worldToCameraMatrix;

depth

このカメラのレンダリング順を指定します。

○ 使い方
この値が小さい順番にレンダリングされていきます。

//このカメラをメインカメラより後にレンダリングします。
Camera came = GetComponent<Camera>();
came.depth = Camera.main.depth + 1;

depthTextureMode

このカメラがどのように深度テクスチャを生成するのかを選択します。

enum型です。

○ 使い方
深度テクスチャを生成したい場合に使用します。

Camera came = GetComponent<Camera>();
came.depthTextureMode = DepthTextureMode.Depth;

eventMask

このカメラがイベントを発生させるレイヤーを制限します。

イベントと言っても全てのイベントではなく、OnMouseEnterなどのマウス系のイベントです。

○ 使い方
ビットフラグ形式になっているため注意が必要です。

//このカメラが映しているオブジェクトの中でレイヤーがUIのものだけマウスイベントを受け取る
Camera came = GetComponent<Camera>();
came.cullingMask = 1 << LayerMask.NameToLayer("UI");

farClipPlane

このカメラが映せる最大距離を表します。

○ 使い方
カメラの映せる距離を調整したい場合に使用します。

Camera came = GetComponent<Camera>();
came.farClipPlane = 100.0f;

fieldOfView

このカメラの画角です。

詳しくはインスペクターの項目で解説しています。

○ 使い方
カメラの画角を調整したい場合に使用します。

Camera came = GetComponent<Camera>();
came.fieldOfView = 60.0f;

forceIntoRenderTexture

レンダリングをレンダーテクスチャに強制します。

○ 使い方
CommandBufferを使用してレンダリング中のイメージを使用したい場合に使用します。

Camera came = GetComponent<Camera>();
came.forceIntoRenderTexture = true;

layerCullDistances

このカメラが映せる距離をレイヤー毎に表します。

○ 使い方
レイヤー別にレンダリング距離を分けたい時に便利です。例えば、大きな建物などは遠くでも見えるけど、小石などの小さなものは近くじゃないと見えないようにしたりする事で負荷軽減ができるので便利です。

Camera came = GetComponent<Camera>();
int layerNum = LayerMask.NameToLayer("Water");
came.layerCullDistances[layerNum] = 50.0f;

layerCullSpherical

このカメラが遠方まで映せる距離を平面ではなく球面にします。

layerCullDistancesが設定されている必要があります。

○ 使い方
視界範囲を球状にします。

デフォルトの状態では視界が最も遠い位置は平面で表されるので、例えば視点をグルグル動かせる系のゲームだと、止まっている状態で視点をグルグル回すとオブジェクトが映ったり映らなかったりします。

視界範囲を球状にすることによってクルクル視点を回してもオブジェクトがちらつきません。

Camera came = GetComponent<Camera>();
came.layerCullSpherical = true;
int layerNum = LayerMask.NameToLayer("Water");
came.layerCullDistances[layerNum] = 50.0f;

nearClipPlane

このカメラが映せる最小距離を表します。

○ 使い方
カメラの映せる距離を調整したい場合に使用します。

Camera came = GetComponent<Camera>();
came.nearClipPlane = 10.0f;

nonJitteredProjectionMatrix

オフセットが適用されていない投影行列です。

○ 使い方
モーションベクターなどを使用する際に使用します。

Camera came = GetComponent<Camera>();
came.nonJitteredProjectionMatrix =came.projectionMatrix;

opaqueSortMode

不透明なオブジェクトをどういう順番でレンダリングしていくかです。

enum型です。

○ 使い方
レンダリング順を変えたい時に使用します。

Camera came = GetComponent<Camera>();
came.opaqueSortMode =Rendering.OpaqueSortMode.NoDistance;

orthographic

平行投影かそうでないかです。

falseだとperspectiveになります。

詳しくはインスペクターの項目で解説しています。

○ 使い方
カメラの映し方を変更したい場合に使用します。

Camera came = GetComponent<Camera>();
came.orthographic =true;

orthographicSize

カメラがorthographicの時の画角の広さです。

この値はカメラの画角の縦幅の半分の値になっています。

詳しくはインスペクターの項目で解説しています。

○ 使い方
カメラが映す範囲を変更したい場合に使用します。

Camera came = GetComponent<Camera>();
came.orthographicSize =5.0f;

pixelHeight

カメラビューポートの高さをピクセル単位で返します。動的解像度スケーリングを考慮しません。

読み取り専用です。

○ 使い方
カメラが映す範囲の高さをピクセル単位で知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("このカメラは高さ" + came.pixelHeight +"ピクセルで描画しています");

pixelRect

画面上のピクセル座標でどこにカメラが描画されるかです。

○ 使い方
カメラが映す範囲をピクセル単位で指定したい場合に使用します。

Camera came = GetComponent<Camera>();
came.pixelRect = new Rect(0, 0, 400, 200);

pixelWidth

カメラビューポートの幅をピクセル単位で返します。動的解像度スケーリングを考慮しません。

読み取り専用です。

○ 使い方
カメラが映す範囲の幅をピクセル単位で知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("このカメラは幅" + came.pixelWidth +"ピクセルで描画しています");

previousViewProjectionMatrix

最後のフレームで使用されるビュー投影行列を取得します

読み取り専用です。

○ 使い方
ブラーなどの前回の描画情報を使って表現されるイメージエフェクトで使用されます。

Camera came = GetComponent<Camera>();
Material material = new Material(Shader.Find("Buler"));
material.SetMatrix("_PreviousViewProjectionMatrix", came.previousViewProjectionMatrix);

projectionMatrix

射影行列です。

この値を変更してしまうとカメラのaspectやfieldOfViewなどが更新されなくなります。

ResetProjectionMatrixを行うことで直す事ができます。

○ 使い方
カメラの座標をクリップ座標に変換するときなどに使用します。

//カメラの映り方を若干歪ませます
Camera came = GetComponent<Camera>();
Matrix4x4 p =came.projectionMatrix;
p.m01 += 1.0F;
Camera.main.projectionMatrix = p;

rect

カメラが画面のどの位置にどれくらいの割合で表示されるかです。

詳しくはインスペクターの項目で解説しています。

○ 使い方
カメラを画面にどう映るのかを制御したい時に使用します。

//このカメラを左上のミニマップにします
Camera came = GetComponent<Camera>();
came.rect = new Rect(0,0.8f,0.2f,0.2f);

renderingPath

このカメラのレンダリングパスです。

enum型です。

○ 使い方
このカメラが使用しているレンダリングパスを変更したい場合に使用します。

現在のレンダリングパスを知りたい場合はactualRenderingPathがあるのでそちらを使用しましょう。renderingPathで指定したものは機種によって使用されていない可能性があります。

Camera came = GetComponent<Camera>();
came.renderingPath =RenderingPath.Forward;

scaledPixelHeight

カメラビューポートの高さをピクセル単位で返します。動的解像度スケーリングを考慮します。

読み取り専用です。

○ 使い方
カメラが映す範囲の高さをピクセル単位で知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("このカメラは高さ" + came.scaledPixelHeight +"ピクセルで描画しています");

scaledPixelWidth

カメラビューポートの幅をピクセル単位で返します。動的解像度スケーリングを考慮します。

読み取り専用です。

○ 使い方
カメラが映す範囲の幅をピクセル単位で知りたい場合に使用します。

Camera came = GetComponent<Camera>();
Debug.Log("このカメラは幅" + came.scaledPixelWidth +"ピクセルで描画しています");

scene

nullではない場合、このカメラは指定されたシーンのコンテンツのみをレンダリングします。

EditorSceneManager.NewPreviewSceneによって作成されたシーンのみをサポートします。

○ 使い方
主にエディタ拡張などでカスタマイズする時に使用します。

Camera came = GetComponent<Camera>(); 
came.scene = EditorSceneManager.NewPreviewScene();

stereoActiveEye

立体視している場合、現在レンダリングしている目を返します。（VRディスプレイの左か右か）

読み取り専用です。

enum型です。

○ 使い方
OnRenderImageなどで現在レンダリング中のカメラの種別を判別する際に使用します。

Camera came;

private void Start()
{
　　　　came = GetComponent<Camera>();
}

protected virtual void OnRenderImage(RenderTexture source, RenderTexture destination)     {
　　　　if (came.stereoActiveEye == Camera.MonoOrStereoscopicEye.Left)
　　　　{
　　　　　　　Debug.Log("このカメラは左目用です");
　　　　}
}

stereoConvergence

立体視している場合、目が収束する点までの距離を返します。（VRディスプレイの左右が収束する距離）

○ 使い方
立体視を行う為の距離を変更したい場合などに使用します。

Camera came = GetComponent<Camera>(); 
came.stereoConvergence = 5.0f;

stereoEnabled

このカメラが立体視をしているかどうか。（VRディスプレイで見るような形）

読み取り専用です。

○ 使い方
立体視モードになっているかどうか知りたい時に使用します。

Camera came = GetComponent<Camera>(); 
if(came.stereoEnabled)
{
　　Debug.Log("このカメラは立体視しています");
}

stereoSeparation

このカメラが立体視をしている場合の左右の距離。（VRディスプレイで見るような形）

VR機器によってはこの値が固定となります。

○ 使い方
左右の目の距離が知りたい場合に使用します。

Camera came = GetComponent<Camera>(); 
if(came.stereoEnabled)
{
　　Debug.Log("このカメラの左右の距離は" + came.stereoSeparation + "です");
}

stereoTargetEye

このカメラがVRディスプレイの左右どちらにレンダリングするのか

enum型です。

○ 使い方
カメラがレンダリングしたいディスプレイを変更したい場合に使用します。

Camera came = GetComponent<Camera>(); 
came.stereoTargetEye = StereoTargetEyeMask.Both;

targetDisplay

このカメラが表示するディスプレイの番号です。

○ 使い方
どのディスプレイに表示したいのか変更したい場合などに使用します。

Camera came = GetComponent<Camera>(); 
came.targetDisplay = 1;

targetTexture

このカメラのレンダリング先であるレンダーテクスチャです。

nullの場合、ディスプレイをレンダリング先にします。

○ 使い方
主にカメラに設定されているレンダーテクスチャからデータを受け取りたい時などに使用します。

Camera came = GetComponent<Camera>(); 
if(came.targetTexture != null)
{
　　//レンダーテクスチャに映った深度バッファを取り出します
　　RenderBuffer rb = came.targetTexture.depthBuffer;
}

transparencySortAxis

透明なオブジェクトをレンダリングする順番を決める時に基準とするベクトルです。

○ 使い方
主に半透明なオブジェクトのレンダリングの仕方を変えたい場合に使用します。

//透明なオブジェクトを斜め奥から順に描画するようにします。
Camera came = GetComponent<Camera>(); 
came.transparencySortAxis = Vector3.one;

transparencySortMode

透明なオブジェクトどのような順番でレンダリングするのかです。

enum型です。

○ 使い方
主に半透明なオブジェクトのレンダリングの仕方を変えたい場合に使用します。

//透明なオブジェクトを斜め奥から順に描画するようにします。
Camera came = GetComponent<Camera>(); 
came.transparencySortMode = TransparencySortMode.Orthographic;

useJitteredProjectionMatrixForTransparentRendering

透明なオブジェクトをレンダリングする時にオフセットを利用するか否かです。

○ 使い方
ジッタ投影レンダリングをしたい場合に使用します。

Camera came = GetComponent<Camera>();
came.useJitteredProjectionMatrixForTransparentRendering =true;

useOcclusionCulling

このカメラがオクルージョンカリングをするかどうかです。

○ 使い方
このフラグをtrueにするだけでは意味はなく、シーンにベイクしておく必要があります。

Camera came = GetComponent<Camera>();
came.useOcclusionCulling =true;

velocity

このカメラの速度です。

読み取り専用です。

○ 使い方
読み取り専用なので、検知する目的にしか使えません。

Camera came = GetComponent<Camera>();
if(came.velocity.magnitude > 5.0f)
{
　　　Debug.Log("カメラが早すぎて酔う〜");
}

worldToCameraMatrix

ワールド座標からCameraから見た位置に変換するために使用する行列を返します。

○ 使い方
カメラの視点を変えたい時などに使用します。

//ちょっと右からの視点に変えます
Camera came = GetComponent<Camera>();
Vector3 cameOffset = new Vector3(-5, 0, 0);
Matrix4x4 m = Matrix4x4.TRS(cameOffset, Quaternion.identity, new Vector3(1, 1, -1));    came.worldToCameraMatrix = m * transform.worldToLocalMatrix;