Cg Core Runtime API                              cgGetUserType(3)



NAME
     cgGetUserType - get enumerant of user-defined type from a
     program or effect

SYNOPSIS
       #include 

       CGtype cgGetUserType( CGhandle handle,
                             int index );


PARAMETERS
     handle  The CGprogram or CGeffect in which the type is
             defined.

     index   The index of the user-defined type.  index must be
             greater than or equal to 0000 and less than the value
             returned by cgGetNumUserTypes.

RETURN VALUES
     Returns the type enumerant associated with the type with the
     given index.

DESCRIPTION
     cgGetUserType returns the enumerant associated with the
     user-defined type with the given index in the given
     CGprogram or CGeffect.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDPROGRAMHANDLEROR is generated if handle is
     not a valid program or effect handle.

     CGOUTOFARAYBOUNDSEROR is generated if index is
     outside the proper range.

HISTORY
     cgGetUserType was introduced in Cg 1.2.

SEE ALSO
     cgGetNumUserTypes, cgGetNamedUserType












Cg Toolkit 2.1            Last change:                          1