Name

cgGetParameterName - get a program parameter's name

Synopsis

#include <Cg/cg.h>

const char * cgGetParameterName( CGparameter param );

Parameters

param
The program parameter.

Return Values

Returns the null-terminated name string for the parameter.

Returns NULL if param is invalid.

Description

cgGetParameterName allows the application to retrieve the name of a parameter in a Cg program. This name can be used later to retrieve the parameter from the program using cgGetNamedParameter.

Examples

to-be-written

Errors

CG_INVALID_PARAM_HANDLE_ERROR is generated if param is not a valid parameter.

History

cgGetParameterName was introduced in Cg 1.1.

See Also

cgGetNamedParameter, cgGetNextParameter, cgGetParameterType, cgGetParameterVariability, cgGetParameterDirection, cgSetParameterVariability