SpriteRenderer Component

画像を板として描画します。2Dの絵や背景に使います。

設定する手順

1. Materialのベースカラーテクスチャ、色、Transformを設定します。
2. SceneViewまたはGameViewで結果を確認します。
3. 編集中のSceneまたはPrefabを保存します。

項目の説明

項目	C#名	型	操作	定義時の初期値	意味
RenderingLayerMask	RenderingLayerMask	uint	読取・変更	1u	このRendererを表示するCameraのCullingMaskと照合するbit集合です。
マテリアル	Material	Material?	読取・変更	{}	描画に使うMaterial参照です。既定MaterialはEngine側から解決されます。
サイズ	Size	Vector2	読取・変更	Vector2::AnyInit(32.0f)	形状の幅・高さ・奥行きです。TransformのScaleも掛かります。
ピボット	Pivot	Vector2	読取・変更	Vector2::AnyInit(0.5f)	形状の原点または投影中心をずらします。
Layer	Layer	int	読取・変更	0	描画するLayer番号です。
Order	Order	int	読取・変更	0	同じLayer内の並び順です。
表示	Visible	bool	読取・変更	true	通常描画に表示するかを指定します。
BlendMode	BlendMode	BlendMode	読取・変更	BlendMode::Normal	背景への色の混ぜ方です。加算などの方式を選びます。
Queue	Queue	RenderPhase	読取・変更	RenderPhase::ScreenUI	同じ描画区分内の並び順です。

Inspectorの設定と使い方

「Editor / C#」は両方から変更できる設定、「Editorのみ」は公開C# APIのない編集操作です。「Editor表示のみ」は計算結果や統計などの確認欄です。「C#のみ」は、このInspectorに編集欄のない操作です。

設定・操作	編集場所	C#の入口	意味・使い方
表示レイヤーと描画順	Editor / C#	RenderingLayerMask / Layer / Order	RenderingLayerMaskはCameraのCullingMaskと照合する表示先のbitです。LayerとOrderは描画の並び順で、衝突タイプとは別です。
Material・個別パラメータ	Editor / C#	Material / MaterialInstance	Materialは共有Asset、MaterialInstanceはこのRendererの上書きです。色・Texture・発光などの公開Parameterを個別に変え、ほかの物体のMaterial設定を変えずに点滅や色違いを作れます。
ブレンドモード・キュー	Editor / C#	BlendMode / Queue	透明度をどう合成するかと、どの描画段階へ送るかを指定します。Alphaを下げるだけで透過描画になるとは限らないため、Materialの表面方式と合わせます。
表示・サイズ・ピボット	Editor / C#	Visible / Size / Pivot	Materialの画像を板として表示します。Sizeは板の大きさ、Pivotは配置と回転の基準です。Transformの位置・回転と、画像のUV設定を分けて扱います。
サイズをテクスチャに合わせる	Editorのみ	—	設定中のベースカラーTextureの実サイズをSizeへコピーする補助ボタンです。未設定・未ロードの画像では実行できない場合があります。C#ではSizeへ必要な大きさを指定します。

初期値はEngineのComponent定義時の値で、C++表記を含みます。C#へ貼り付ける実行例ではありません。既存Sceneの保存値や既定Assetがある場合はそちらが優先されます。数値の編集範囲はInspectorで制限される場合があります。

C#から使う

操作型はSpriteRendererです。 GameObjectから取得する基本操作はGameObjectの操作を参照してください。以下には基本プロパティだけでなく、公開関数・追加の設定API・継承した共通操作も掲載します。

設定用・関連するC#型

• MaterialInstance

選択値（Enum）

型・各値の詳説	使える値
BlendMode	Add / Multiply / Normal / Screen / Subtract
RenderPhase	EditorOverlay / Opaque / PostProcessUI / ScreenUI / Transparent

SpriteRenderer

宣言・詳説	種類・操作	役割
public BlendMode BlendMode	プロパティ（読取・変更）	背景への色の混ぜ方です。加算などの方式を選びます。
public static SpriteRenderer FromEntity(GameObject gameObject)	関数	既にComponentを持つGameObjectから操作用の参照を作ります。Componentを追加する操作ではありません。
public Color4 GetColor()	関数	現在のマテリアル color を取得する。
public int Layer	プロパティ（読取・変更）	描画するLayer番号です。
public Material? Material	プロパティ（読取・変更）	描画に使うMaterial参照です。既定MaterialはEngine側から解決されます。
public MaterialInstance MaterialInstance	プロパティ（読取専用）	このRendererだけに適用するMaterial Parameterです。共有Materialの変更とは区別します。
public int Order	プロパティ（読取・変更）	同じLayer内の並び順です。
public Vector2 Pivot	プロパティ（読取・変更）	形状の原点または投影中心をずらします。
public RenderPhase Queue	プロパティ（読取・変更）	同じ描画区分内の並び順です。
public uint RenderingLayerMask	プロパティ（読取・変更）	このRendererを表示するCameraのCullingMaskと照合するbit集合です。
public void SetColor(Color3 color)	関数	色Parameterを設定します。
public void SetColor(Color4 color)	関数	マテリアル color を上書きする。
public Vector2 Size	プロパティ（読取・変更）	形状の幅・高さ・奥行きです。TransformのScaleも掛かります。
public bool Visible	プロパティ（読取・変更）	通常描画に表示するかを指定します。
public static int componentTypeID	プロパティ（読取専用）	組み込みComponentの接続識別子です。通常のゲームコードではGetComponentで取得します。

継承する共通操作：Component

宣言・詳説	種類・操作	役割
public T AddComponent<T>() where T : Component	関数	ComponentまたはScriptを追加し、操作する参照を返します。
public T? GetComponent<T>() where T : class	関数	component access(owner GameObjectへの委譲)
public T? GetComponentInChildren<T>(bool includeInactive = false) where T : class	関数	子階層から指定型のComponentを探します。
public T? GetComponentInParent<T>(bool includeInactive = false) where T : class	関数	親階層から指定型のComponentを探します。
public T[] GetComponents<T>() where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public void GetComponents<T>(List<T> results) where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public T[] GetComponentsInChildren<T>(bool includeInactive = false) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(bool includeInactive, List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public T[] GetComponentsInParent<T>(bool includeInactive = false) where T : class	関数	親階層にある指定型のComponentを収集します。
public void GetComponentsInParent<T>(bool includeInactive, List<T> results) where T : class	関数	親階層にある指定型のComponentを収集します。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public bool HasComponent<T>() where T : class	関数	指定型のComponentを持つかを調べます。
public void RemoveComponent<T>() where T : Component	関数	指定型のComponentを取り除きます。
public bool TryGetComponent<T>(out T component) where T : class	関数	Componentを検索し、見つかったかをbool、結果をout引数で返します。
public GameObject gameObject	プロパティ（読取専用）	このComponentを所有するGameObjectです。
public Transform transform	プロパティ（読取専用）	所有GameObjectのTransformです。

継承する共通操作：Object

宣言・詳説	種類・操作	役割
public static void Destroy(Object? target)	関数	参照先の個体だけを安全地点で破棄する
public override bool Equals(object? obj)	関数	2つの値が等しいかを調べます。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public static GameObject Instantiate(Prefab original)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static bool operator ==(Object? lhs, Object? rhs)	関数	等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static implicit operator bool(Object? value)	関数	暗黙の型変換を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static bool operator !=(Object? lhs, Object? rhs)	関数	不等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。

使用時の注意

透明画像には適切なMaterialのSurfaceModeと描画順を設定します。

Play中の変更は実行用Worldへ反映します。Scene編集のUndoと実行中の値の変更は別です。保存方法は編集と実行時変更を参照してください。

関連項目

• 機能の使い方
• Component一覧
• C# API一覧