ShaderLab ：Properties

シェーダーにより、Unity のマテリアルインスペクター上で、アーティストがセットできるパラメーターの一覧を定義できます。プロパティーはシェーダーファイルの Properties ブロックで定義します。

シンタックス

プロパティー

Properties { Property [Property ...] }

Properties ブロックを定義します。波括弧 {} の中で以下のように複数のプロパティーを定義します。

数字とスライダー

name ("display name", Range (min, max)) = number
name ("display name", Float) = number
name ("display name", Int) = number

これらを使い、数 (数量) プロパティーのデフォルト値を決定します。 Range は、スライダーの最小と最大の範囲を決定します。

カラーとベクトル

name ("display name", Color) = (number,number,number,number)
name ("display name", Vector) = (number,number,number,number)

これらを使い、指定した RGBA 成分のデフォルト値をもつカラープロパティーや、デフォルト値をもつ 4D ベクトルプロパティーを定義します。カラープロパティーにはカラーピッカーがついており、色空間にしたがい、必要に応じて調整されます ( シェーダープログラムのプロパティーを参照 )。ベクトルのプロパティーは、4つの数値欄として表示されます。

テクスチャ

name ("display name", 2D) = "defaulttexture" {}
name ("display name", Cube) = "defaulttexture" {}
name ("display name", 3D) = "defaulttexture" {}

これらはそれぞれ、2D テクスチャ、キューブマップ、3D (体積) プロパティーを決定します。

詳細

シェーダー内の各プロパティーは name で参照されます (Unity では、シェーダーのプロパティー名をアンダースコアで始めるのが一般的)。プロパティーはマテリアルインスペクター上で display name で表示されます。各プロパティーのデフォルト値は等号 (=) のあとに記述します。

Range と Float プロパティーでは “13.37” のように 1 つの数字です。
Color と Vector プロパティーでは “(1, 0.5, 0.2, 1)” のように括弧 () で括る 4 つの数字です。
2D テクスチャでは、デフォルト値は空の文字列か、以下のビルトインのデフォルトテクスチャのうちの 1 つです：“白” (RGBA:1,1,1,1)、“黒” (RGBA:0,0,0,0)、“グレー” (RGBA:0.5,0.5,0.5,0.5)、“バンプ” (RGBA:0.5,0.5,1,0.5)、“赤” (RGBA:1,0,0,0)。
2D テクスチャ以外 (立方体、3D、2D 行列) では、デフォルト値は空の文字列です。マテリアルに割り当てられたキューブマップ/3D/配列のテクスチャがないとき、“グレー” (RGBA:0.5,0.5,0.5,0.5) が使用されます。

後に、シェーダーの固定関数では、括弧で囲ったプロパティーネーム [name] でプロパティーの値にアクセスします。例えば、それを利用してマテリアルプロパティーでブレンドモードを行うことができます。 2つの整数プロパティーを宣言して (例えば “SrcBlend“ と ”DstBlend”)、後で、それらを使用して Blend [_SrcBlend] [_DstBlend] のように Blend コマンドを行います。

プロパティー ブロックのシェーダーパラメーターは、マテリアルデータとしてシリアライズされています。実際は、シェーダープログラムには、ランタイムにコードからマテリアルに設定できるパラメーター (マトリクス、ベクトル、float型など) がもっとあります。しかし、それらがプロパティーブロックにないと、その値は保存されません。これは主に、完全にスクリプトコード制御される値 (Material.SetFloat と類似関数を使用) に有用です。

プロパティーの属性と Drawer

プロパティーの前に、括弧で囲ったオプションの属性を指定することができます。 Unity に認識される属性か、または、ユーザー自身の MaterialPropertyDrawer クラスで属性を示し、マテリアルインスペクターでレンダリングを制御します。 Unity で認識できる属性は以下のとおりです。

[HideInInspector] - マテリアルインスペクターでプロパティー値を表示しません。
[NoScaleOffset] - 属性のテクスチャプロパティーに関して、マテリアルインスペクターの texture tiling/offset 欄を表示しません。
[Normal] - テクスチャプロパティーが法線マップであることを示しています。
[HDR] - テクスチャプロパティーが High Dramatic Range (HDR) テクスチャであることを示しています。
[Gamma] - Float/Vector プロパティーが UI で sRGB 値で指定されており (色とまったく同じ)、使用するカラースペースに応じて変換が必要な可能性があることを示しています。詳しくは、Cg/HLSL でシェーダープロパティーを参照するを参照してください。
[PerRendererData] - テクスチャプロパティーは、MaterialPropertyBlock の形式の各レンダラーごとのデータであることを示しています。マテリアルインスペクターでは、このプロパティー用にテクスチャ部分の UI が変わります。

例

// water シェーダーのプロパティー
Properties
{
    _WaveScale ("Wave scale", Range (0.02,0.15)) = 0.07 // スライダー
    _ReflDistort ("Reflection distort", Range (0,1.5)) = 0.5
    _RefrDistort ("Refraction distort", Range (0,1.5)) = 0.4
    _RefrColor ("Refraction color", Color) = (.34, .85, .92, 1) // カラー
    _ReflectionTex ("Environment Reflection", 2D) = "" {} // テクスチャ
    _RefractionTex ("Environment Refraction", 2D) = "" {}
    _Fresnel ("Fresnel (A) ", 2D) = "" {}
    _BumpMap ("Bumpmap (RGB) ", 2D) = "" {}
}

テクスチャプロパティーのオプション ( Unity 5 では削除されました)

Unity 5 になる前は、テクスチャプロパティーで {} 内に TexGen CubeReflect のようなオプションを設定することができました。これらは、固定関数テクスチャ座標生成を制御していましたが、5.0 では取り除かれました。 TexGen が必用な場合は、代わりに、頂点シェーダーを書いてください。シェーダーに固定関数 TexGen を実装するの例を参照してください。

マニュアル