VKD3D-COMPILER(1)

📦
version 2.0 · 4 versions
, in ubuntu stonking

💖 VKD3D-COMPILER 💖

okay bestie, welcome to the vkd3d-compiler manual page — it's the shader compiler for vkd3d, and yes it comes from the User Commands corner of your friendly neighbourhood man setup. grab a boba, we're doing this 🌸

✨ NAME ✨

vkd3d-compiler — shader compiler for vkd3d 🦋

✨ SYNOPSIS ✨

vkd3d-compiler [options...] [file]

✨ OPTIONS ✨

  • -h, --help — shows you all this info and then dips. exit stage left, periodt 💅
  • --alias-double-as-float — when you're compiling HLSL sources with shader model 1-3 target profiles, this treats 'double' as 'float'. yes, literally. it's giving "we don't do doubles here" 😭
  • -b <type> — pick the target type, bestie. run --print-target-types to see the valid ones and the default ones for a given source type 👑
  • --buffer-uav=<type> — tells it which buffer type to use for buffer UAV bindings. valid values are 'buffer-texture' (that's the default) and 'storage-buffer'. choose wisely 🎀
  • --child-effect — compiles the effect as a child effect. heads up: this one is only meaningful for fx_2_0 and fx_4_0/fx_4_1 profiles. no cap
  • -e, --entry=<name> — use <name> as the entry point. the default is "main" — main character energy, obviously 💜
  • -E — preprocess the source code instead of compiling it. just vibes, no assembly 🌈
  • --formatting=<flags> — sets the formatting options for text output. <flags> is a comma separated list of formatting flags, and you can optionally prefix it with '+' or '-'. valid flags are 'colour', 'indent', 'offsets', 'header', 'raw-ids', and 'signatures'. the 'indent' and 'header' flags are enabled by default ✨
  • --fragment-coordinate-origin=<origin> — sets the origin of fragment coordinates for SPIR-V targets. valid values are 'upper-left' (the default) and 'lower-left'. and listen — the only value supported by Vulkan environments is 'upper-left'. so... yeah 🙈
  • --fx-include-empty-buffers — writes empty constant buffers descriptions. this one is only meaningful for fx_4_0 and fx_4_1 profiles. empty but make it fashion 💅
  • --matrix-storage-order=<order> — sets the default matrix storage order. valid values are 'column' (default) and 'row' 🔥
  • -o, --output=<file> — writes the output to <file>. if <file> is '-', or if you didn't specify an output file at all, the output goes to standard output 🫶
  • --print-source-types — displays the supported source types and exits. show and tell 📋
  • --print-target-types — displays the supported target types for the specified source type and exits ✨
  • -p, --profile=<name> — sets the target shader profile for HLSL shaders. this is THE fit check 👑
  • --semantic-compat-map — maps shader model 1-3 semantic names to shader model 4+ system values when compiling HLSL sources. glow-up for your semantics, fr fr 🦋
  • --strip-debug — strips the debug information from the output. nothing personal, just minimising 💀
  • -V, --version — displays version information and exits 🎀
  • -x <type> — sets the type of the source. run --print-source-types to list the valid source types. the default source type is automatically detected from the input shader — it just knows 🔮
  • -- — stop option processing. any argument after this is interpreted as a filename. that's the hard boundary, bestie 🚧
also super important: if the input file is '-' or isn't specified at all, the input will be read from standard input. stdin stays winning 💖

🌟 a lil sign-off 🌟

this is vkd3d-compiler, version 2.0+ds-3, dated August 2026 — and it's still VKD3D-COMPILER(1) at the end of the day. slay, compile, and hydrate 💧👑💖

📦 where this page comes from