NAME

cgGetAnnotationType - get an annotation's type

SYNOPSIS

  #include <Cg/cg.h>

  CGtype cgGetAnnotationType( CGannotation ann );

PARAMETERS

ann

Specifies the annotation.

DESCRIPTION

cgGetAnnotationType allows the application to retrieve the type of a annotation in a Cg effect.

cgGetAnnotationType will return CG_STRUCT if the annotation is a struct and CG_ARRAY if the annotation is an array. Otherwise it will return the data type associated with the annotation.

RETURN VALUES

Returns the type enumerant of ann. If an error occurs, CG_UNKNOWN_TYPE will be returned.

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann does not refer to a valid annotation.

SEE ALSO

the "cgGetType" document, and the "cgGetTypeString" document