Templates

Shader templating is available in XKSL. Unlike many templating systems, pdxsl requires strong typed templates. The available types are:

  • value types from HLSL (float, int, float2, float3, float4)
  • 2D textures
  • sampler states
  • semantics (used to replace semantics on variables)
  • link types (used to replace link annotations)An instantiated shader behaves the same way as any other shader. The value, texture and sampler template parameters are accessible like any other variable. However, it's impossible to modify their value; attempting to do so results in a compilation error. If a template variable is incorrectly used (eg using a sampler as a semantic), it should result in a compilation error. However, the behavior is officially unknown.

Code: Templating

  1. shader TemplateShader<float speed, Texture2D myTexture, SamplerState mySampler, Semantic mySemantic, LinkType myLink>
  2. {
  3.     [Color]
  4.     [Link("myLink")]
  5.     float4 myColor;
  7.     stream float2 texcoord : mySemantic;
  9.     float4 GetValue()
  10.     {
  11.         return speed * myColor * myTexture.Sample(mySampler, streams.texcoord);
  12.     }
  13. };
  15. // To instantiate the shader, use:
  16. TemplateShader<1.0f, Texturing.Texture0, Texturing.Sampler0, TEXCOORD0, MyColorLink>

See also