dxc's Introduction

Compile DirectX Shaders from Go

dxc is both a library and an executable to compile DirectX shaders and effects. It uses the D3DCompiler_XX.dll DLLs that come with any Windows system.

To install the binary dxc.exe, run

go install github.com/gonutz/dxc/cmd/dxc@latest

See the online documentation for how to use the library.

Command Line Tool

The cmd/dxc folder contains a command line version of this tool.

dxc takes its input from stdin and outputs the shader code to stdout. Errors go to stderr.

Example:

dxc -WX -T vs_2_0 < vertex_shader.hlsl > vertex_shader_blob.bin

Usage of dxc:
  -E string
    	entrypoint name (default "main")
  -Gch
    	compile as a child effect for FX 4.x targets
  -Gdp
    	disable effect performance mode
  -Gec
    	enable backwards compatibility mode
  -Ges
    	enable strict mode
  -Gfa
    	avoid flow control constructs
  -Gfp
    	prefer flow control constructs
  -Gis
    	force IEEE strictness
  -Gpp
    	force partial precision
  -O int
    	optimization level 0..3 (default 1)
  -Od
    	disable optimizations, only use this for debug builds
  -Op
    	disable preshaders
  -T string
    	target profile, e.g. vs_2_0, ps_4_1, fx_5_0 etc.
  -Vd
    	disable validation
  -WX
    	treat warnings as errors
  -Zi
    	enable debug information in output
  -Zpc
    	pack matrices in column-major order
  -Zpr
    	pack matrices in row-major order
  -res_may_alias
    	assume that UAVs/SRVs may alias for cs_5_0+

Recommend Projects