今回のお題はグローバル変数です。
HLSLのグローバル変数はちょうどC#で言うプロパティのようなノリで使います。
つまり、BasicEffectのViewやProjectionプロパティみたいな感じです。
実際、BasicEffectのプロパティの多くがHLSLのグローバル変数をラップしたもののようです。
（※エフェクトのグローバル変数はこんなコードで確かめることが出来ます。
BasicEffect effect = new BasicEffect(graphics.GraphicsDevice);
foreach (EffectParameter parameter in effect.Parameters)
{
System.Console.WriteLine(parameter.Name);
}
結果はこうなりました：
Texture
DiffuseColor
EmissiveColor
SpecularColor
SpecularPower
DirLight0Direction
DirLight0DiffuseColor
DirLight0SpecularColor
DirLight1Direction
DirLight1DiffuseColor
DirLight1SpecularColor
DirLight2Direction
DirLight2DiffuseColor
DirLight2SpecularColor
EyePosition
FogColor
FogVector
World
WorldInverseTranspose
WorldViewProj
ShaderIndex
これはBasicEffectのエフェクトで使われているグローバル変数ですが、
ほとんどBasicEffectのプロパティと対応します。（全部ではありませんけどね））
概念としてはC#のプロパティやメンバ変数と同じと言うことです。
このグローバル変数を使うと、C#側からいろいろ操作できるので
エフェクトをより柔軟なものに出来るでしょう。
宣言の仕方はこうです：
スコープ データ型 変数名 : セマンティクス = 初期化する値;
このうち必須なのはデータ型と変数名だけです。
そのため、一番シンプルな例だとこうなります：
float4 DiffuseColor;
これだけでも外側から（C#のコードから）アクセスできます。
スコープを指定しなくてもデフォルトで外側からアクセスできるようになっているのです。
（これがC#とは違うところです。C#のメンバはpublicをつけないと外側からアクセスできませんからね）
C#側からアクセスするには、Microsoft.Xna.Framework.Graphics.EffectParameterクラスを使います。
public sealed class EffectParameter
このクラスはエフェクトのグローバル変数を表しており、
これ使って、グローバル変数をsetしたりgetしたりします。
※なお、msdnによると、getもsetも遅いのであんまり頻繁に使うのは避けたほうがいいそうです。ちょっぴりショックです・・・
読み込むにはEffectParameter.GetValue*****という名前のメソッドを使います。
色々あるのはC#からだとグローバル変数の型がわからないからでしょうね。
public bool GetValueBoolean ()
public bool[] GetValueBooleanArray ( int count ) //count は配列の要素数
public int GetValueInt32 ()
public int[] GetValueInt32Array ( int count ) //countは配列の要素数
public Matrix GetValueMatrix ()
public Matrix[] GetValueMatrixArray ( int count ) //countは配列の要素数
public Matrix GetValueMatrixTranspose () //転置行列（行と列が入れ替わったマトリックス）
public Matrix[] GetValueMatrixTransposeArray ( int count ) //countは（以下略
public Quaternion GetValueQuaternion ()
public Quaternion[] GetValueQuaternionArray ( int count )
public float GetValueSingle ()
public float[] GetValueSingleArray ( int count )
public string GetValueString ()
public Texture2D GetValueTexture2D ()
public Texture3D GetValueTexture3D ()
public TextureCube GetValueTextureCube ()
public Vector2 GetValueVector2 ()
public Vector2[] GetValueVector2Array ( int count )
public Vector3 GetValueVector3 ()
public Vector3[] GetValueVector3Array ( int count )
public Vector4 GetValueVector4 ()
public Vector4[] GetValueVector4Array ( int count )
書き込みにはほとんどの場合、EffectParameter.SetValueメソッドを使います。
GetValueの場合と違って、引数の型によってオーバーロードしてるので
名前が違うなんてことはありません。
public void SetValue ( bool value )
public void SetValue ( bool[] value )
public void SetValue ( int value )
public void SetValue ( int[] value )
public void SetValue ( Matrix value )
public void SetValue ( Matrix[] value )
public void SetValue ( Quaternion value )
public void SetValue ( Quaternion[] value )
public void SetValue ( float value )
public void SetValue ( float[] value )
public void SetValue ( string value )
public void SetValue ( Texture value )
public void SetValue ( Vector2 value )
public void SetValue ( Vector2[] value )
public void SetValue ( Vector3 value )
public void SetValue ( Vector3[] value )
public void SetValue ( Vector4 value )
public void SetValue ( Vector4[] value )
さきほど「ほとんどの場合」といいましたが、それは例外があるからで、
転置行列をセットする場合です。
普通のマトリックスをセットする場合と引数の型が同じなので
オーバーロードできなくなり、別の名前にしたのでしょう。
（まぁあんまり使いそうにないのでこの解説はスルーしてもよかったのですが）
public void SetValueTranspose ( Matrix value )
public void SetValueTranspose ( Matrix[] value )
さて、肝心のEffectParameterクラスのインスタンスを得る方法ですが、
それにはEffect.Parametersプロパティを使います。
public EffectParameterCollection Parameters { get; }
戻り値はHLSLで書いたエフェクトファイルのグローバル変数の一覧を表す、
Microsoft.Xna.Framework.Graphics.EffectParameterCollectionクラスの
インスタンスです。
こいつにEffectParameterのインスタンスが入っています。
public sealed class EffectParameterCollection : IEnumerable<EffectParameter>
目的のグローバル変数を表すEffectParameterを得るには、インデクサを使います。
public EffectParameter this [ string name ] { get; }
nameはもちろんグローバル変数の名前です。
MyGame.cs
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
class MyGame : Game
{
GraphicsDeviceManager graphics;
Effect effect;
VertexPositionColor[] vertices = {
new VertexPositionColor(new Vector3(0, 1, 0), Color.White),
new VertexPositionColor(new Vector3(1, 0, 0), Color.Blue),
new VertexPositionColor(new Vector3(-1, 0, 0), Color.Red)
};
public MyGame()
{
graphics = new GraphicsDeviceManager(this);
}
protected override void LoadContent()
{
effect = Content.Load<Effect>("Content/MyEffect");
}
protected override void Update(GameTime gameTime)
{
double angle = gameTime.TotalGameTime.TotalSeconds;
effect.Parameters["offset"].SetValue(
new Vector3(
(float)System.Math.Cos(angle),
(float)System.Math.Sin(angle),
0)
);
}
protected override void Draw(GameTime gameTime)
{
GraphicsDevice.Clear(Color.CornflowerBlue);
foreach (var pass in effect.CurrentTechnique.Passes)
{
pass.Apply();
GraphicsDevice.DrawUserPrimitives<VertexPositionColor>
(
PrimitiveType.TriangleList,
vertices,
0,
vertices.Length / 3
);
}
}
}
MyEffect.fx
float3 offset;
struct VertexPositionColor
{
float4 Position : POSITION;
float4 Color : COLOR;
};
VertexPositionColor MyVertexShader(VertexPositionColor input)
{
input.Position.xyz += offset;
return input;
}
float4 MyPixelShader(float4 color : COLOR) : COLOR
{
return color;
}
technique MyTechnique
{
pass MyPass
{
VertexShader = compile vs_2_0 MyVertexShader();
PixelShader = compile ps_2_0 MyPixelShader();
}
}
このサンプルでは三角形をぐるぐる回しています。
回転の中心はウィンドウの中心です。
エフェクトファイルで三角形のオフセットを表すグローバル変数を宣言して、
それをC#側から連続して変更していき、回転させているのです。
スコープ
HLSLのグローバル変数の前には記憶域クラス修飾子であるスコープをつけることが出来ます。
C#で言うpublicとかprivateのことです。
ただし、HLSLではC言語風の名前になっていて少し戸惑うかもしれません。
static
C#でいうprivateです。
これを付けられたグローバル変数はエフェクトの外から「見えなく」なります。
アプリケーションからEffectParameterを使ってgetしたりsetしたり出来ません。
C#でstaticと言えば全てのインスタンスでその変数が共有されることを意味しますが、
HLSLでこれに対応するのは"shared"です。
（※とはいえまったく関係ないということはなく、
これを関数などのローカルスコープ内の変数につけた場合、
C#のstaticと似た意味を持つようになります。
つまり、全ての呼び出しでその変数が共有されます。
float incrementA()
{
static float a;
a++;
return a;
}
float4 MyPixelShader() : COLOR
{
incrementA(); //この時点でaは1。この行をコメントアウトすると色は灰色になります。
return incrementA() / 2; //この時aは2。結局白を返します。
}
まぁピクセルシェーダ間で共有することは出来ないようですが。
）
extern
C#でいうpublicです。
これを付けられたグローバル変数はエフェクトの外からgetしたりsetしたり出来ます。
これはスコープのデフォルトで、何もスコープが付けられていないグローバル変数はexternになります。
shared
C#でいうstaticです。
これを付けられたグローバル変数はエフェクト間で共有されます。
[1回]