cgCreateEffectAnnotation
Keywords: cgCreateEffectAnnotation, NVIDIA, NVIDIA Cg Toolkit, Cg Toolkit, Shader, Shader Programming, GPU Shader Programming, GPU Program

> ## Name

> cgCreateEffectAnnotation - create an effect annotation

> ## Synopsis

>     #include <Cg/cg.h>

>     CGannotation cgCreateEffectAnnotation( CGeffect effect,
>                                            const char * name,
>                                            CGtype type );

> ## Parameters

> effect
>   The effect to which the new annotation will be added.
> name
>   The name of the new annotation.
> type
>   The type of the new annotation.

> ## Return Values

> Returns the new CGannotation handle on success.

> Returns NULL if an error occurs.

> ## Description

> cgCreateEffectAnnotation adds a new annotation to the effect.

> ## Examples

>     /* create a float annotation named "Apple" for CGeffect effect */
>     CGannotation ann = cgCreateEffectAnnotation( effect, "Apple", CG_FLOAT );

> ## Errors

> CG_INVALID_EFFECT_HANDLE_ERROR is generated if effect is not a valid effect.

> CG_DUPLICATE_NAME_ERROR is generated if name is already used by an annotation for this effect.

> CG_INVALID_ENUMERANT_ERROR is generated if type is not CG_INT, CG_FLOAT, CG_BOOL, or CG_STRING.

> ## History

> cgCreateEffectAnnotation was introduced in Cg 1.5.

> ## See Also

> cgGetNamedEffectAnnotation, cgGetFirstEffectAnnotation, cgGetNextAnnotation