cgGetFirstDependentParameter

Langue: en

Version: 46944 (openSuse - 09/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

cgGetFirstDependentParameter - get the first dependent parameter from a parameter

SYNOPSIS


  #include <Cg/cg.h>







  CGparameter cgGetFirstDependentParameter( CGparameter param );

PARAMETERS


param
The parameter.

RETURN VALUES

Returns a handle to the first member parameter.

Returns NULL if param is not a struct or if some other error occurs.

DESCRIPTION

cgGetFirstDependentParameter returns the first member dependent parameter associated with a given parameter. The rest of the members may be retrieved from the first member by iterating with cgGetNextParameter.

Dependent parameters are parameters that have the same name as a given parameter but different resources. They only exist in profiles that have multiple resources associated with one parameter.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a valid parameter.

HISTORY

cgGetFirstDependentParameter was introduced in Cg 1.1.

SEE ALSO

the cgGetNextParameter manpage, the cgGetFirstParameter manpage