Name

cgGetParameterClassEnum - get the enumerant associated with a parameter class name

Synopsis

#include <Cg/cg.h>

CGparameterclass cgGetParameterClassEnum( const char * pString );

Parameters

pString

A string containing the case-sensitive parameter class name.

Return Values

Returns the parameter class enumerant associated with pString.

Returns CG_PARAMETERCLASS_UNKNOWN if the given parameter class does not exist.

Description

cgGetParameterClassEnum returns the enumerant associated with a parameter class name.

Examples

CGparameterclass structParameterClass = cgGetParameterClassEnum("struct");

if(cgGetParameterClassEnum(myparam) == structParameterClass)
{
  /* Do struct stuff */
}

Errors

CG_INVALID_PARAMETER_ERROR is generated if pString is NULL.

History

cgGetParameterClassEnum was introduced in Cg 2.2.

See Also

cgGetParameterClassString, cgGetParameterClass, cgGetTypeClass