NAME

cgGetEnumString - get the name string associated with an enumerant

SYNOPSIS

  #include <Cg/cg.h>

  const char * cgGetEnumString( CGenum enum );

PARAMETERS

enum

The enumerant.

RETURN VALUES

Returns the enum string of the enumerant enum. NULL is returned in the event of an error.

DESCRIPTION

cgGetEnumString returns the name string associated with an enumerant. It's primarily useful for printing out debugging information.

EXAMPLES

The following example will print "CG_UNIFORM" to the stdout.

  const char *EnumString = cgGetEnumString(CG_UNIFORM);
  printf("%s\n", EnumString);

ERRORS

cgGetEnumString does not generate any errors.

HISTORY

cgGetEnumString was introduced in Cg 1.2.

SEE ALSO

cgGetEnum