Cg Core Runtime API                                cgGetString(3)



NAME
     cgGetString - gets a special string

SYNOPSIS
       #include 

       const char * cgGetString( CGenum enum );


PARAMETERS
     enum    An enumerant describing the string to be returned.

RETURN VALUES
     Returns the string associtated with enum.

     Returns NUL in the event of an error.

DESCRIPTION
     cgGetString returns an informative string depending on the
     enum.  Currently there is only one valid enumerant that may
     be passed in.

     CGVERSION
         Returns the version string of the Cg runtime and
         compiler.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDENUMERANTEROR is generated if enum is not
     CGVERSION.

HISTORY
     cgGetString was introduced in Cg 1.2.

SEE ALSO
     Cg

















Cg Toolkit 2.1            Last change:                          1