Shader authoring/Compiling Shaders: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(uncat)
No edit summary
Line 1: Line 1:
{{shadertut}}
{{shadertut}}


To compile .[[FXC]] files, list them in a text file (one per line), then run <code>src\materialsystem\stdshaders\buildsdkshaders.bat</code> on the text file. It will go process your .FXC code and compile all the combinations into your mod's directory. The syntax of the <code>buildsdkshaders.bat</code> command line is:  
To compile .[[FXC]] files, list them in a text file (one per line), then run <code>src\materialsystem\stdshaders\buildshaders.bat</code> on the text file. It will go process your .FXC code and compile all the combinations into your mod's directory. The syntax of the <code>buildshaders.bat</code> command line is:  


  buildsdkshaders.bat [text filename] -game [mod directory] -source [source directory]
  buildshaders.bat [text filename] -game [mod directory] -source [source directory]


Example:
Example:


  buildsdkshaders.bat MyShaders -game "C:\Steam\SteamApps\SourceMods\MyMod" -source "C:\MyMod\Src"
  buildshaders.bat MyShaders -game "C:\Steam\SteamApps\SourceMods\MyMod" -source "C:\MyMod\Src"


{{note|The text file that lists the .FXC files should be in the same directory as your shader DLL source code, because your shader DLL source code will need to refer to files that are generated by <code>buildsdkshaders.bat</code>.
{{note|The text file that lists the .FXC files should be in the same directory as your shader DLL source code, because your shader DLL source code will need to refer to files that are generated by <code>buildshaders.bat</code>.


Before building your shader DLL, you need to run <code>buildsdkshaders.bat</code>, so it can generate include files that your shader DLL will need.}}
Before building your shader DLL, you need to run <code>buildshaders.bat</code>, so it can generate include files that your shader DLL will need.}}


Refer to <code>stdshaders_dx8.txt</code> and <code>stdshaders_dx9.txt</code> as examples of how to set up your shaders text file. All the source code for the shader DLL should be in the same directory as the .FXC, .[[VSH]], and .[[PSH]] files. After <code>buildsdkshaders.bat</code> runs, you can look in the <code>fxctmp9</code> sub-directory to see the include files generated by the shader compiler.
Refer to <code>stdshaders_dx8.txt</code> and <code>stdshaders_dx9.txt</code> as examples of how to set up your shaders text file. All the source code for the shader DLL should be in the same directory as the .FXC, .[[VSH]], and .[[PSH]] files. After <code>buildshaders.bat</code> runs, you can look in the <code>fxctmp9</code> sub-directory to see the include files generated by the shader compiler.


{{note|Shader names should adhere to the same convention as the sample ones distributed in the SDK (e.g. <code>*_ps20.fxc</code> for pixel shaders conforming to the 2.0 spec, <code>*_vs11.fxc</code> for vertex shaders conforming to the 1.1 spec.)}}
{{note|Shader names should adhere to the same convention as the sample ones distributed in the SDK (e.g. <code>*_ps20.fxc</code> for pixel shaders conforming to the 2.0 spec, <code>*_vs11.fxc</code> for vertex shaders conforming to the 1.1 spec.)}}

Revision as of 17:14, 23 May 2011

To compile .FXC files, list them in a text file (one per line), then run src\materialsystem\stdshaders\buildshaders.bat on the text file. It will go process your .FXC code and compile all the combinations into your mod's directory. The syntax of the buildshaders.bat command line is:

buildshaders.bat [text filename] -game [mod directory] -source [source directory]

Example:

buildshaders.bat MyShaders -game "C:\Steam\SteamApps\SourceMods\MyMod" -source "C:\MyMod\Src"
Note.pngNote:The text file that lists the .FXC files should be in the same directory as your shader DLL source code, because your shader DLL source code will need to refer to files that are generated by buildshaders.bat. Before building your shader DLL, you need to run buildshaders.bat, so it can generate include files that your shader DLL will need.

Refer to stdshaders_dx8.txt and stdshaders_dx9.txt as examples of how to set up your shaders text file. All the source code for the shader DLL should be in the same directory as the .FXC, .VSH, and .PSH files. After buildshaders.bat runs, you can look in the fxctmp9 sub-directory to see the include files generated by the shader compiler.

Note.pngNote:Shader names should adhere to the same convention as the sample ones distributed in the SDK (e.g. *_ps20.fxc for pixel shaders conforming to the 2.0 spec, *_vs11.fxc for vertex shaders conforming to the 1.1 spec.)