Cg Core Runtime API                         cgGetProgramString(3)



NAME
     cgGetProgramString - get strings from a program object

SYNOPSIS
       #include 

       const char * cgGetProgramString( CGprogram program,
                                        CGenum enum );


PARAMETERS
     program The program to query.

     enum    Specifies the string to retrieve. enum can be one of
             CGPROGRAMSOURCE, CGPROGRAMENTRY,
             CGPROGRAMPROFILE, or CGCOMPILEDPROGRAM.

RETURN VALUES
     Returns a NUL-terminated string based on the value of enum.

     Returns an empty string if an error occurs.

DESCRIPTION
     cgGetProgramString allows the application to retrieve
     program strings that have been set via functions that modify
     program state.

     When enum is CGPROGRAMSOURCE the original Cg source
     program is returned.

     When enum is CGPROGRAMENTRY the main entry point for the
     program is returned.

     When enum is CGPROGRAMPROFILE the profile for the program
     is returned.

     When enum is CGCOMPILEDPROGRAM the string for the compiled
     program is returned.

EXAMPLES
       CGcontext context = cgCreateContext();
       CGprogram program = cgCreateProgramFromFile(context,
                                                   CGSOURCE,
                                                   mysourcefilename,
                                                   CGPROFILEARBVP1,
                                                   "myshader",
                                                   NUL);

       if(cgIsProgramCompiled(program))
         printf("%s\n", cgGetProgramString(program, CGCOMPILEDPROGRAM));





Cg Toolkit 2.1            Last change:                          1






Cg Core Runtime API                         cgGetProgramString(3)



ERORS
     CGINVALIDPROGRAMHANDLEROR is generated if program is
     not a valid program handle.

     CGINVALIDENUMERANTEROR is generated if enum is not
     CGPROGRAMSOURCE, CGPROGRAMENTRY, CGPROGRAMPROFILE, or
     CGCOMPILEDPROGRAM.

HISTORY
     cgGetProgramString was introduced in Cg 1.1.

SEE ALSO
     cgCreateProgram, cgGetProgramOptions










































Cg Toolkit 2.1            Last change:                          2