NAME

cgGetEnum - get the enumerant assigned with the given string name

SYNOPSIS

  #include <Cg/cg.h>

  CGenum cgGetEnum(const char *enum_string);

PARAMETERS

enum_string

A string containing the enum name. The name is case-sensitive.

DESCRIPTION

cgGetEnum returns the enumerant assigned to a enum name.

The following is an example of how cgGetEnum might be used.

  CGenum VaryingEnum = cgGetEnum("CG_VARYING");

RETURN VALUES

Returns the enumerant of enum_string. If no such enumerant exists CG_UNKNOWN is returned.

ERRORS

CG_INVALID_PARAMETER_ERROR is generated if enum_string is NULL.

SEE ALSO

cgGetEnumString