6annotate - Methods to Annotate an Image>/


NAME



'annotate - Methods to Annotate an Image






(

SYNOPSIS



evoid AnnotateImage( Image *image, const AnnotateInfo *annotate_info );



bAnnotateInfo * CloneAnnotateInfo( const ImageInfo *image_info, const AnnotateInfo*annotate_info );



Wvoid DestroyAnnotateInfo( AnnotateInfo *annotate_info );



pvoid GetAnnotateInfo( const ImageInfo *image_info, AnnotateInfo *annotate_info );






B

FUNCTION DESCRIPTIONS






2

AnnotateImage



AMethod AnnotateImage annotates an image with text. Optionally theHannotation can include the image filename, type, width, height, or scene.number by embedding special format characters.



*The format of the AnnotateImage method is:

¦
void AnnotateImage ( Image *image, const AnnotateInfo *annotate_info );


=A description of each parameter follows:


7

image:


)The address of a structure of type Image.

*

annotate_info:


(The address of a AnnotateInfo structure.






:

CloneAnnotateInfo



^Method CloneAnnotateInfo makes a duplicate of the given annotate info, or if annotate info is %NULL, a new one.



.The format of the CloneAnnotateInfo method is:

ì
AnnotateInfo *CloneAnnotateInfo ( const ImageInfo *image_info, const AnnotateInfo *annotate_info );


=A description of each parameter follows:


(

cloned_info:


`Method CloneAnnotateInfo returns a duplicate of the given annotate info, or if annotate info is $NULL a new one.

'

image_info:


a structure of type info.

*

annotate_info:


a structure of type info.






>

DestroyAnnotateInfo



@Method DestroyAnnotateInfo deallocates memory associated with anAnnotateInfo structure.



0The format of the DestroyAnnotateInfo method is:

y
void DestroyAnnotateInfo ( AnnotateInfo *annotate_info );


=A description of each parameter follows:


*

annotate_info:


1Specifies a pointer to an AnnotateInfo structure.






6

GetAnnotateInfo



>Method GetAnnotateInfo initializes the AnnotateInfo structure.



,The format of the GetAnnotateInfo method is:

µ
void GetAnnotateInfo ( const ImageInfo *image_info, AnnotateInfo *annotate_info );


=A description of each parameter follows:


'

image_info:


.Specifies a pointer to an ImageInfo structure.

*

annotate_info:


0Specifies a pointer to a AnnotateInfo structure.