NAME

cgGetNamedUserType - get enumerant associated with type name

SYNOPSIS

  #include <Cg/cg.h>

  CGtype cgGetNamedUserType( CGhandle handle,
                             const char * name );

PARAMETERS

handle

The CGprogram or CGeffect in which the type is defined.

name

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

RETURN VALUES

Returns the type enumerant associated with name. If no such type exists CG_UNKNOWN_TYPE will be returned.

DESCRIPTION

cgGetNamedUserType returns the enumerant associated with the named type defined in the constuct associated with handle. handle may be a CGprogram or CGeffect.

For a given type name, the enumerant returned by this entry point is guaranteed to be identical if called wither either an CGeffect handle, or a CGprogram that is defined within that effect.

If two programs in the same context define a type using identical names and definitions, the associated enumerants are also guaranteed to be identical.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_PARAMETER_ERROR is generated if the supplied handle is not a valid CGprogram or CGeffect.

HISTORY

cgGetNamedUserType was introduced in Cg 1.2.

SEE ALSO

cgGetUserType, cgGetType