NAME
cgGetProgramString - get strings from a program object
SYNOPSIS
#include <Cg/cg.h> const char * cgGetProgramString( CGprogram program, CGenum enum );PARAMETERS
- program
The program to query.
- enum
Specifies the string to retrieve. enum can be one of CG_PROGRAM_SOURCE, CG_PROGRAM_ENTRY, CG_PROGRAM_PROFILE, or CG_COMPILED_PROGRAM.
RETURN VALUES
to-be-written
DESCRIPTION
cgGetProgramString allows the application to retrieve program strings that have been set via functions that modify program state.
When enum is CG_PROGRAM_SOURCE the original Cg source program is returned.
When enum is CG_PROGRAM_ENTRY the main entry point for the program is returned.
When enum is CG_PROGRAM_PROFILE the profile for the program is returned.
When enum is CG_COMPILED_PROGRAM, the string for the compiled program is returned.
EXAMPLES
to-be-written
ERRORS
CG_INVALID_PROGRAM_HANDLE_ERROR is generated if program does not refer to a valid program.
CG_INVALID_ENUMERANT_ERROR is generated if enum is an invalid enumerant.
HISTORY
cgGetProgramString was introduced in Cg 1.1.
SEE ALSO