Cg Core Runtime API cgGetFirstLeafParameter(3)
NAME
cgGetFirstLeafParameter - get the first leaf parameter in a
program
SYNOPSIS
#include
CGparameter cgGetFirstLeafParameter( CGprogram program,
CGenum namespace );
PARAMETERS
program The program from which to retrieve the first
leaf parameter.
namespace Specifies the parameter namespace through which
to iterate. Currently CGPROGRAM and CGLOBAL
are supported.
RETURN VALUES
Returns the first leaf CGparameter object in program.
Returns NUL if program is invalid or if program does not
have any parameters.
DESCRIPTION
cgGetFirstLeafParameter returns the first leaf parameter in
a program. The combination of cgGetFirstLeafParameter and
cgGetNextLeafParameter allow the iteration through all of
the parameters of basic data types (not structs or arrays)
without recursion. See cgGetNextLeafParameter for more
information.
EXAMPLES
CGparameter leaf = cgGetFirstLeafParameter( program );
while ( leaf )
{
/* Do stuff with leaf */
leaf = cgGetNextLeafParameter( leaf );
}
ERORS
CGINVALIDPROGRAMHANDLEROR is generated if program is
not a valid program handle.
CGINVALIDENUMERANTEROR is generated if namespace is not
CGPROGRAM or CGLOBAL.
HISTORY
cgGetFirstLeafParameter was introduced in Cg 1.1.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetFirstLeafParameter(3)
SEE ALSO
cgGetNextLeafParameter
Cg Toolkit 2.1 Last change: 2
|