NAME

cgGetFirstStructParameter - get the first child parameter from a struct parameter

SYNOPSIS

  #include <Cg/cg.h>

  CGparameter cgGetFirstStructParameter(CGparameter param);

PARAMETERS

param

Specifies the struct parameter. This parameter must be of type CG_STRUCT (returned by cgGetParameterType()).

DESCRIPTION

cgGetFirstStructParameter returns the first member parameter of a struct parameter. The rest of the members may be retrieved from the first member by iterating with the cgGetNextParameter() function.

RETURN VALUES

cgGetFirstStructParameter returns a handle to the first member parameter.

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

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a struct or valid parameter.

SEE ALSO

cgGetNextParameter, and cgGetFirstParameter