6annotate - Methods to Annotate an Image9W




"NAME

.

annotate - Methods to Annotate an Image



2page index




&SYNOPSIS

g

unsigned int AnnotateImage( Image *image, const AnnotateInfo *annotate_info );

{

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

Q

void DestroyAnnotateInfo( AnnotateInfo *annotate_info );

j

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



2page index


$

FUNCTION *DESCRIPTIONS



2

AnnotateImage

Á

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

1

The format of the AnnotateImage method is:

±
unsigned int AnnotateImage ( Image *image, const AnnotateInfo *annotate_info );

AA description of each parameter follows:


@

image:

)The address of a structure of type Image.

P

annotate_info:

(The address of a AnnotateInfo structure.



:

CloneAnnotateInfo

a

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

5

The format of the CloneAnnotateInfo method is:

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

AA description of each parameter follows:


J

clone_info:

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

J

image_info:

a structure of type info.

*

annotate_info:

a structure of type info.



>

DestroyAnnotateInfo

_

Method DestroyAnnotateInfo deallocates memory associated with an AnnotateInfo structure.

7

The format of the DestroyAnnotateInfo method is:

|
void DestroyAnnotateInfo ( AnnotateInfo *annotate_info );

AA description of each parameter follows:


*

annotate_info:

1Specifies a pointer to an AnnotateInfo structure.



6

GetAnnotateInfo

E

Method GetAnnotateInfo initializes the AnnotateInfo structure.

3

The format of the GetAnnotateInfo method is:

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

AA description of each parameter follows:


'

image_info:

.Specifies a pointer to an ImageInfo structure.

*

annotate_info:

0Specifies a pointer to a AnnotateInfo structure.
9

page index