Cg Core Runtime API                        cgGetFirstParameter(3)



NAME
     cgGetFirstParameter - get the first parameter in a program

SYNOPSIS
       #include 

       CGparameter cgGetFirstParameter( CGprogram program,
                                        CGenum namespace );


PARAMETERS
     program     The program from which to retrieve the first
                 parameter.

     namespace  Specifies the parameter namespace through which
                 to iterate.  Currently CGPROGRAM and CGLOBAL
                 are supported.

RETURN VALUES
     Returns the first CGparameter object in program.

     Returns zero if program is invalid or if program does not
     have any parameters.

     Also returns zero if program is a combined program.  To
     access the parameters of a combined program, use
     cgGetProgramDomainProgram to get each domain program and
     then call cgGetFirstParameter on each domain program.

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
       CGparameter param = cgGetFirstParameter( program, CGLOBAL );
       while ( param )
       {
         /* Do stuff with leaf */
         param = cgGetNextParameter( param );
       }


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

     CGINVALIDENUMERANTEROR is generated if namespace is not
     CGPROGRAM or CGLOBAL.





Cg Toolkit 2.1            Last change:                          1






Cg Core Runtime API                        cgGetFirstParameter(3)



HISTORY
     cgGetFirstParameter was introduced in Cg 1.1.

SEE ALSO
     cgGetNextParameter, cgGetProgramDomainProgram,
     cgGetFirstDependentParameter, cgGetFirstEffectParameter,
     cgGetFirstParameterAnnotation
















































Cg Toolkit 2.1            Last change:                          2