- NAME
- SYNOPSIS
- FUNCTION DESCRIPTIONS

- AnnotateImage
- CloneAnnotateInfo
- DestroyAnnotateInfo
- GetAnnotateInfo

# NAME

annotate - Methods to Annotate an Image

# SYNOPSIS

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

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

void DestroyAnnotateInfo( AnnotateInfo *annotate_info );

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

# FUNCTION DESCRIPTIONS

## 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.

The format of the AnnotateImage method is:

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

A description of each parameter follows:

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:

clone_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 an AnnotateInfo structure.

The format of the DestroyAnnotateInfo method is:

> void DestroyAnnotateInfo ( AnnotateInfo *annotate_info );

A description of each parameter follows:

annotate_info:
  Specifies a pointer to an AnnotateInfo structure.

## 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:
  Specifies a pointer to a AnnotateInfo structure.