NAME
    cgCompileProgram - compile a program object

SYNOPSIS
      #include <Cg/cg.h>

      void cgCompileProgram( CGprogram prog );

PARAMETERS
    prog    Specifies the program object to compile or inspect.

DESCRIPTION
    cgCompileProgram compiles the specified Cg program for its target
    profile. A program must be compiled before it can be loaded (by the
    API-specific part of the runtime). It must also be compiled before its
    parameters can be inspected.

    Certain actions invalidate a compiled program and the current value of
    all of its parameters. If one of these actions is performed, the program
    must be recompiled before it can be used. A program is invalidated if
    the program source is modified, if the compile arguments are modified,
    or if the entry point is changed.

    If one of the parameter bindings for a program is changed, that action
    invalidates the compiled program, but does not invalidate the current
    value of the program's parameters.

RETURN VALUES
    cgCompileProgram does not return any values.

EXAMPLES
      if(!cgIsProgramCompiled(prog))
       cgCompileProgram(prog);

ASSOCIATED GETS
    cgGetProgramString with pname CG_COMPILED_PROGRAM.

ERRORS
    CG_PROGRAM_HANDLE_ERROR is generated if prog is an invalid program
    handle.

    CG_COMPILE_ERROR is generated if the compile fails.

SEE ALSO
    the cgIsProgramCompiled manpage, the cgCreateProgram manpage, the
    cgGetNextParameter manpage, the cgIsParameter manpage, and the
    cgGetProgramString manpage

