NAME

cgGetFirstParameter - get the first parameter in a program

SYNOPSIS

  #include <Cg/cg.h>

  CGparameter cgGetFirstParameter( CGprogram program,
                                   CGenum name_space );

PARAMETERS

program

The program from which to retrieve the first parameter.

name_space

Specifies the namespace of the parameter to iterate through. Currently CG_PROGRAM and CG_GLOBAL are supported.

RETURN VALUES

cgGetFirstParameter returns a the first CGparameter object in program. NULL is returned if program is invalid or if program does not have any parameters.

DESCRIPTION

cgGetFirstParameter returns the first top-level parameter in a program. cgGetFirstParameter is used for recursing through all parameters in a program. See cgGetNextParameter for more information on parameter traversal.

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 name_space is not CG_PROGRAM or CG_GLOBAL.

HISTORY

cgGetFirstParameter was introduced in Cg 1.1.

SEE ALSO

cgNextParameter