orkid: Skill for Claude Code

Orkid FXV2 Shader System Reference

When answering questions about shaders in orkid, consult these files.

Key Files

FXV2 File Format

// Configuration block
fxconfig fxcfg_default {
  glsl_version = "150";
  import "orkshader://mathtools.i2";
  import "orkshader://pbrtools.i2";
}

// Uniform block (maps to UBO)
uniform_block ublock_vtx (descriptor_set 0) {
  mat4 mvp;
  mat4 m;
  vec4 modcolor;
  float time;
}

// Sampler set
sampler_set samplers (descriptor_set 0) {
  sampler2D ColorMap;
  sampler2D NormalMap;
}

// Shader Storage Block (SSBO)
storage_interface sif_data (descriptor_set 0) {
  buffer layout(std430) my_data {
    vec4 items[$$$COUNT];
    vec4 params;
  };
}

// Vertex interface
vertex_interface iface_vtx : ublock_vtx {
  inputs {
    vec3 position : POSITION;
    vec3 normal : NORMAL;
    vec2 uv : TEXCOORD0;
  }
  outputs {
    vec4 out_color;
    vec2 out_uv;
  }
}

// Fragment interface
fragment_interface iface_frag : ublock_vtx : samplers {
  inputs {
    vec4 in_color;
    vec2 in_uv;
  }
  outputs {
    layout(location = 0) vec4 out_color;
  }
}

// Vertex shader
vertex_shader vs_main : iface_vtx {
  gl_Position = mvp * vec4(position, 1.0);
  out_color = modcolor;
  out_uv = uv;
}

// Fragment shader
fragment_shader ps_main : iface_frag {
  vec4 texel = texture(ColorMap, in_uv);
  out_color = texel * in_color;
}

// State block
state_block sb_default : default {
  DepthTest = LESS;
  DepthMask = true;
  CullTest = PASS_FRONT;
  BlendMode = ALPHA;
}

// Technique (combines shaders + state)
technique tek_forward {
  fxconfig = fxcfg_default;
  pass p0 {
    vertex_shader = vs_main;
    fragment_shader = ps_main;
    state_block = sb_default;
  }
}

// Compact form
technique tek_compact {
  fxconfig = fxcfg_default;
  vf_pass = { vs_main, ps_main, sb_default }
}