Name
cgc - cg compiler driver
Synopsis
cgc [options] file ...
Description
cgc is the standalone Cg compiler which translates Cg or GLSL programs
into OpenGL or DirectX shader assembly code, or OpenGL or DirectX shading
language code.
Options
Basic Options
- -entry name
-
Sets the entry function for the shader to compile. Defaults to
main.
- -o file
-
Sets the output file to be written. Default outputs to
stdout.
- -l file
-
Sets the listing file, where error and warning messages are written.
Defaults to
stderr.
- -profile name
-
Selects the target profile, specifying the shader language to be generated.
- -profileopts opt1,opt2,...
- -po opt1,opt2,...
-
Sets one or more profile specific options.
- -noentry
-
Sets check only mode, where no shader is compiled, but all the code in
the input file is checked for syntactic correctness.
Language Options
- -oglsl
-
Sets the source language to GLSL.
- -ogles
-
Sets the source language to OpenGL/ES GLSL.
- -strict
- -nostrict
-
Enable or disable strict typechecking, where most questionable constructs
will be flagged as warnings.
- -glslWerror
-
Like
-strict but in addition, unportable GLSL constructs will be flagged
as errors.
- -nowarn
-
Disable all warnings.
- -nowarn=N,N,...
-
Disable one or more specific numbered warnings.
- -fx
- -nofx
-
Enables or disables FX parsing mode, where FX keywords are recognized.
Defaults to on in Cg mode and off in GLSL mode.
- -nostdlib
-
Disable the standard library.
- -no_uniform_blocks
-
Don't allow defining constant buffers with the uniform keyword. Support BUFFER semantics on structs instead.
Code Generation Options
- -fastmath
- -nofastmath
-
Enable or disable optimizations that may chage/lose precision in low order bits, such as assocative transforms like
(a + b) + c instead of a + (b + c). Default is -fastmath.
- -fastprecision
- -nofastprecision
-
Enable or disable optimzations doing operations at lower precision than is specified when the result is later converted to a lower precision or the operands were originally in lower precision. Default is
-nofastprecision.
- -bestprecision
-
Always do things in the best possible precision; only use lower precision operations if there is no possibility of difference. Implies
-nofastmath and -nofastprecision.
- -unroll all|none|count=N
-
Control loop unrolling.
-unroll all will force unrolling of all
loops that can be unrolled, while -unroll none will prevent unrolling
except if code cannot otherwise be generated in the current profiles
(so it will have no effect in profiles that don't support looping).
unroll count=N will unroll loops if the estimate of the resulting
code is less than N instructions. The estimate does not take into
account further optimizations that may be done after unrolling, so it
might be quite inaccurate.
- -inline all|none|count=N
-
Control function inlining. Setting
-inline none will additionally
disable inlining of functions with an explicit inline keyword, which
are otherwise always inlined. Setting -inline count=0 will effectively
disable inlining of all functions that do not have an explicit inline keyword.
- -ifcvt all|none|count=N
-
control if conversion (replacement of small if/else blocks with
conditional assignments).
- -ON
-
Sets the optimization level of the compiler, from 0 (lowest) to 3 (highest).
Higher values may produce better code and will cause compile time to increase.
Default is
-O1.
- -looplimit N
-
Assume loops that the compiler cannot determine an upper bound on the
number of iterations may loop as many as N iterations. This may
require generating extra code for such loops in some profiles.
- -d3d
-
Generate code compatable with the Direct3D specification.
- -MaxInstInBasicBlock N
-
break basic blocks after N instructions. This has an effect on local
optimizations that don't cross basic block boundaries and may avoid bad
compile time blowups in the presence of huge basic blocks due to algorithms
that are non-linear in the basic block size.
- -maxunrollcount N
-
Deprecated. Don't unroll loops with more than N iterations. Use the -unroll option instead, which provides better fine-grained control.
Preprocessor Options
- -DMACRO[=VALUE]
-
Sets a preprocessor macro. If VALUE is not specified it defaults to
1.
- -Idirectory
-
Adds a directory to the end of the search path for
#include files. The
default search path is empty.
- -E
-
Don't compile, just prepocess the input.
- -P
-
With
-E, supresses the generation of #line directives in the output.
- -C
-
With
-E, preserves comments in the output.
- -MG
-
Ignore
#include files that can't be found, rather than issuing an error.
- -M
- -MM
- -MD
- -MMD
- -MP
- -MF file
- -MT target
- -MQ target
-
Generate dependency information about
#included files. These options
are intended to be compatible with the options to gcc.
Miscellaneous Options
- -quiet
- -q
-
Supress all 'noise' output (copyright notices, indications of which
files are being compiled, etc). With -o and -l, should result in no
output being produced.
- -nocode
-
Supress final code generation. Will actually run all the way through the
compiler (so any errors present should be diagnosed), but don't produce
any actual output code.
- -v
- --version
-
Print compiler version information to listing.
- -h
-
Print short option help summary to stdout and exit.
- -help
-
Print longer option help summary to stdout, including all supported
profiles and profile options, and exit.
- -type type_definition
-
Set an override type binding for a variable.
- -typefile file
-
Read override type bindings for variables from a file.
- -dumpinputbind file
-
Dump type bindings for all variables to a file. This file may be passed
back to the compiler with
-typefile.
Debugging Options
- -debug
-
Enable the
debug builtin function to abort operation of a shader and
immedaitely output a value.
- -debuglast
-
Like
-debug, except the shader does not abort; instead it continues and
outputs the value of the last debug function called.
- -debugdefault=value
-
Like
-debug, except if no debug call is reached, the output will be
set to the specified value instead of what the shader normally computes.
- -deprecated
-
Issue errors instead of warnings for any deprecated features used.
Profiles
A profile specifies the output language of the cg compiler (either a
shader assembly dialect, or a shading language). Each profile has its own
set of profile options that can be set for it, though many related
profiles have similar or identical options. Profiles can be grouped by
program type, API, or GPU generation.
- DirectX profiles
-
ds_5_0,
gs_4_0,
gs_5_0,
hlslf,
hlslv,
hs_5_0,
ps_1_1,
ps_1_2,
ps_1_3,
ps_2_0,
ps_2_x,
ps_3_0,
ps_4_0,
ps_5_0,
vs_1_1,
vs_2_0,
vs_2_x,
vs_3_0,
vs_4_0,
vs_5_0
- OpenGL profiles
-
arbfp1,
arbvp1,
fp20,
fp30,
fp30unlimited,
fp40,
fp40unlimited,
glslf,
glslg,
glslv,
gp4fp,
gp4gp,
gp4vp,
gp5fp,
gp5gp,
gp5tcp,
gp5tep,
gp5vp,
vp20,
vp30,
vp40
- Fragment profiles
-
arbfp1,
fp20,
fp30,
fp30unlimited,
fp40,
fp40unlimited,
glslf,
gp4fp,
gp5fp,
hlslf,
ps_1_1,
ps_1_2,
ps_1_3,
ps_2_0,
ps_2_x,
ps_3_0,
ps_4_0,
ps_5_0
- Geometry profiles
-
glslg,
gp4gp,
gp5gp,
gs_4_0,
gs_5_0
- Vertex profiles
-
arbvp1,
glslv,
gp4vp,
gp5vp,
hlslv,
vp20,
vp30,
vp40,
vs_1_1,
vs_2_0,
vs_2_x,
vs_3_0,
vs_4_0,
vs_5_0
- GeForce 3/4 Series profiles
-
fp20, vp20
- GeForce 5 Series profiles
-
fp30, vp30
- GeForce 6/7 Series profiles
-
fp40, vp40
- GeForce 8/9/100/200/300 Series, OpenGL 3.x Quadro profiles
-
gp4fp, gp4gp, gp4vp
- GeForce 400 Series, OpenGL 4.x Quadro profiles
-
gp5fp, gp5gp, gp5tcp, gp5tep, gp5vp
Profile Options
Here is a complete list of all profiles and their corresponding profile options
- arbfp1
-
Targets the ARB_fragment_program OpenGL extension
-
-po ARB_draw_buffers-
Use the ARB_draw_buffers option for multiple renderbuffer targets (MRT). This is the default
-po ATI_draw_buffers-
Use the ATI_draw_buffers option for multiple renderbuffer targets (MRT).
-po MaxDrawBuffers=N-
Set the maximum number of renderbuffer targets. Default is 1
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 32
-po MaxTexIndirections=N-
Sets the maximum number of texture indirections allowed in the output program. Default is 1024
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 1024
-po NumMathInstructionSlots=N-
Sets the maximum number of non-texture instructions in the output program. Default is 1024
-po NumTemps=N-
Sets the maximum number of TEMP registers in the output program. Default is 32
-po NumTexInstructionSlots=N-
Sets the maximum number of texture instructions in the output program. Default is 1024
- arbvp1
-
Targets the ARB_vertex_program OpenGL extension
-
-po MaxAddressRegs=N-
Sets the maximum number of ADDRESS registers in the output program. Default is 1
-po MaxInstructions=N-
Sets the maximum number of instructions in the output program. Default is 1024
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 96
-po NumTemps=N-
Sets the maximum number of TEMP registers in the output program. Default is 32
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- fp20
-
Targets the NV_register_combiners2 and NV_texture_shader OpenGL extensions
- fp30
-
Targets the NV_fragment_program OpenGL extension
-
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 256
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 32
fp30unlimited-
Same as fp30 with various hardware limits on registers and instructions lifted
-
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 4194304
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 512
- fp40
-
Targets the NV_fragment_program2 OpenGL extension
-
-po appleKilWAR-
Work around various bugs with KIL instructions in the OSX-tiger implementation of NV_fragment_program2
-po ARB_draw_buffers-
Use the ARB_draw_buffers option for multiple renderbuffer targets (MRT). This is the default
-po ATI_draw_buffers-
Use the ATI_draw_buffers option for multiple renderbuffer targets (MRT).
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is infinite
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is infinite
-po NumTemps=N-
Sets the maximum number of TEMP registers in the output program. Default is infinite
-po OutColorPrec=N-
If N is 3 or 4, force output to fp16 precision. If N is 2, force output to fp32 precision.
fp40unlimited-
Same as fp40 with various hardware limits on registers and instructions lifted
-
-po appleKilWAR-
Work around various bugs with KIL instructions in the OSX-tiger implementation of NV_fragment_program2
-po ARB_draw_buffers-
Use the ARB_draw_buffers option for multiple renderbuffer targets (MRT). This is the default
-po ATI_draw_buffers-
Use the ATI_draw_buffers option for multiple renderbuffer targets (MRT).
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 1024
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 4194304
-po NumTemps=N-
Sets the maximum number of TEMP registers in the output program. Default is 512
-po OutColorPrec=N-
If N is 3 or 4, force output to fp16 precision. If N is 2, force output to fp32 precision.
generic-
Produces a dump of the program in a non-executable format
- glslf, glslg and glslv
-
Targets the OpenGL Shading language (GLSL) v1.10.
glslf targets fragment programs while glslv targets vertex programs
-
- version=val
-
GLSL version to target. Supported versions are 100, 110, 120, 130, 140, 150, 330, 400 and 410.
- userTexCoord
-
Use user-defined varying instead of gl_TexCoord.
- ATI_draw_buffers
-
Use ATI_draw_buffers extension for MRT.
- EXT_gpu_shader4
-
Use EXT_gpu_shader4 extension where useful.
- gp4fp
-
Targets the NV_gpu_program4 and NV_fragment_program4 OpenGL extensions.
-
-po fastimul-
Assume integer multiply inputs have at most 24 significant bits.
-po NV_shader_buffer_load-
Use the NV_shader_buffer_load OpenGL extension.
-po NV_parameter_buffer_object2-
Use the NV_parameter_buffer_object2 OpenGL extension.
-po PaBO2-
Use the NV_parameter_buffer_object2 OpenGL extension.
-po ARB_draw_buffers-
Use the ARB_draw_buffers option for multiple renderbuffer targets (MRT). This is the default
-po ATI_draw_buffers-
Use the ATI_draw_buffers option for multiple renderbuffer targets (MRT).
-po pixel_center_integer-
Use integer pixel centers.
-po origin_upper_left-
Use upper left pixel origin.
- gp4gp
-
Targets the NV_gpu_program4 and NV_geometry_program4 OpenGL extensions.
-
-po POINT-po LINE-po LINE_ADJ-po TRIANGLE-po TRIANGLE_ADJ-
Set the input primitive type for the geometry program
-po POINT_OUT-po LINE_OUT-po TRIANGLE_OUT-
Set the output primitive type for the geometry program
-po Vertices=N-
Set the number of vertices output by the geometry program
- gp4vp
-
Targets the NV_gpu_program4 and NV_vertex_program4 OpenGL extensions.
-
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- gp5fp
-
Targets the NV_gpu_program5 OpenGL extension.
-
-po fastimul-
Assume integer multiply inputs have at most 24 significant bits.
-po NV_shader_buffer_load-
Use the NV_shader_buffer_load OpenGL extension.
-po NV_parameter_buffer_object2-
Use the NV_parameter_buffer_object2 OpenGL extension.
-po PaBO2-
Use the NV_parameter_buffer_object2 OpenGL extension.
-po ARB_draw_buffers-
Use the ARB_draw_buffers option for multiple renderbuffer targets (MRT). This is the default
-po ATI_draw_buffers-
Use the ATI_draw_buffers option for multiple renderbuffer targets (MRT).
-po pixel_center_integer-
Use the ARB_fragment_coord_conventions OpenGL extension to specify integer pixel centers.
-po origin_upper_left-
Use the ARB_fragment_coord_conventions OpenGL extension to specify upper left pixel origin.
-po NV_early_fragment_tests-
Perform depth and stencil tests prior to fragment program invocation.
- gp5gp
-
Targets the NV_gpu_program5 OpenGL extension.
-
-po POINT-po LINE-po LINE_ADJ-po TRIANGLE-po TRIANGLE_ADJ-
Set the input primitive type for the geometry program
-po POINT_OUT-po LINE_OUT-po TRIANGLE_OUT-
Set the output primitive type for the geometry program
-po Vertices=N-
Set the number of vertices output by the geometry program
- gp5tcp
-
Targets the NV_tessellation_program and NV_gpu_program5 OpenGL extensions.
- gp5tep
-
Targets the NV_tessellation_program and NV_gpu_program5 OpenGL extensions.
- gp5vp
-
Targets the NV_gpu_program5 OpenGL extension.
-
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- hlslf hlslv
-
Targets Microsoft High-Level Shading Language (HLSL).
hlslf targets pixel programs while hlslv targets vertex programs
- ps_1_1 ps_1_2 ps_1_3
-
Targets DirectX pixel programs
-
-po MaxPixelShaderValue=N-
Maximum absolute value representable in a pixel shader. Default is 1.
- ps_2_0 ps_2_x
-
Targets DirectX pixel programs
-
-po MaxDrawBuffers=N-
Set the maximum number of renderbuffer targets. Default is 1
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 96 or 512
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 12 or 32
- ps_3_0
-
Targets DirectX pixel programs
-
-po MaxDrawBuffers=N-
Set the maximum number of renderbuffer targets. Default is 1
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 224
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 32768
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 32
-po OutColorPrec=N-
If N is 3 or 4, force output to fp16 precision. If N is 2, force output to fp32 precision.
- vp20
-
Targets the NV_vertex_program OpenGL extension
-
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 96
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- vp30
-
Targets the NV_vertex_program2 OpenGL extension
-
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 256
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- vp40
-
Targets the NV_vertex_program3 OpenGL extension
-
-po MaxAddressRegs=N-
Sets the maximum number of ADDRESS registers in the output program. Default is 2
-po MaxInstructions=N-
Sets the maximum number of instructions in the output program. Default is 2048
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 544
-po NumTemps=N-
Sets the maximum number of TEMP registers in the output program. Default is 32
-po PosInv-
Generate position invariant code (same as fixed-function) for POSITION output
- vs_1_1
-
Targets DirectX vertex programs
-
-po dcls-
Output dx9-style dcls statements
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 96
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 128
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 12
- vs_2_0 vs_2_x
-
Targets DirectX vertex programs
-
-po dcls-
Output dx9-style dcls statements
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 256
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 256
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 12
- vs_3_0
-
Targets DirectX vertex programs
-
-po dcls-
Output dx9-style dcls statements
-po MaxLocalParams=N-
Set the maximum number of uniform parameter slots available. Default is 256
-po NumInstructionSlots=N-
Sets the maximum number of instructions in the output program. Default is 32768
-po NumTemps=N-
Sets the maximum number of temporaries in the output program. Default is 32
Environment
See Also
Cg_language, arbfp1, arbvp1, fp20, fp30, fp40, glslf, glslv, gp4fp, gp4gp, gp4vp, hlslf, hlslv, vp20, vp30, vp40
|
