Cg Core Runtime API                     cgGetParameterBaseType(3)



NAME
     cgGetParameterBaseType - get a program parameter's base type

SYNOPSIS
       #include 

       CGtype cgGetParameterBaseType( CGparameter param );


PARAMETERS
     param   The parameter.

RETURN VALUES
     Returns the base type enumerant of param.

     Returns CGUNKNOWNTYPE if an error occurs.

DESCRIPTION
     cgGetParameterBaseType allows the application to retrieve
     the base type of a parameter.

     If param is of a numeric type (scalar, vector, or matrix),
     the scalar enumerant corresponding to param's type will be
     returned.  For example, if param is of type CGFLOAT4x3,
     cgGetParameterBaseType will return CGFLOAT.

     If param is an array, the base type of the array elements
     will be returned.

     If param is a structure, its type-specific enumerant will be
     returned, as per cgGetParameterNamedType.

     Otherwise, param's type enumerant will be returned.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDPARAMHANDLEROR is generated if param is not a
     valid parameter.

HISTORY
     cgGetParameterBaseType was introduced in Cg 1.4.

SEE ALSO
     cgGetParameterType, cgGetParameterNamedType, cgGetType,
     cgGetTypeString, cgGetParameterClass








Cg Toolkit 2.1            Last change:                          1