cgSetBoolAnnotation

Langue: en

Version: 47097 (openSuse - 09/10/07)

Section: 3 (Bibliothèques de fonctions)

NAME

cgSetBoolAnnotation - set the value of a bool annotation

SYNOPSIS


  #include <Cg/cg.h>






  CGbool cgSetBoolAnnotation( CGannotation ann,

                              CGbool value );





PARAMETERS


ann
The annotation that will be set.
value
The value to which ann will be set.

RETURN VALUES

Returns CG_TRUE if it succeeds in setting the annotation.

Returns CG_FALSE otherwise.

DESCRIPTION

cgSetBoolAnnotation sets the value of an annotation of bool type.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann is not a valid annotation.

CG_INVALID_PARAMETER_TYPE_ERROR is generated if ann is not an annotation of bool type.

CG_ARRAY_SIZE_MISMATCH_ERROR is generated if ann is not a scalar.

HISTORY

cgSetBoolAnnotation was introduced in Cg 1.5.

SEE ALSO

cgGetBoolAnnotationValues, cgSetIntAnnotation, cgSetFloatAnnotation, cgSetStringAnnotation