<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>annotate - Annotate an image with text</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:bfriesen@freddy.simplesystems.org" /> </head> <body style="background-color: white"> <P><a name="__index__"></a></P> <!-- INDEX BEGIN --> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li> <ul> <li><a href="#annotateimage">AnnotateImage</a></li> <li><a href="#gettypemetrics">GetTypeMetrics</a></li> </ul> </ul> <!-- INDEX END --> <hr /> <P> </P> <h1><a name="name">NAME</a></h1> <P>annotate - Annotate an image with text</P> <P> </P> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <P>unsigned int <strong>AnnotateImage</strong>( Image *image, DrawInfo *draw_info );</P> <P>unsigned int <strong>GetTypeMetrics</strong>( Image *image, const DrawInfo *draw_info, TypeMetric *metrics );</P> <P> </P> <hr /> <h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1> <P> </P> <h2><a name="annotateimage">AnnotateImage</a></h2> <blockquote>AnnotateImage() annotates an image with text. Optionally you can include any of the following bits of information about the image by embedding the appropriate special characters: </blockquote><P>The format of the AnnotateImage method is:</P> <blockquote>unsigned int AnnotateImage ( <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#DrawInfo">DrawInfo</A> *draw_info ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_status_3a">status:</a></strong> <DD> <P>Method AnnotateImage returns True if the image is annotated otherwise False.</P> </dd> </li> <dt><strong><a name="item_o_image_3a">image:</a></strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_draw_info_3a">draw_info:</a></strong> <DD> <P>The draw info.</P> </dd> </li> </dl> <P> </P> <h2><a name="gettypemetrics">GetTypeMetrics</a></h2> <blockquote>GetTypeMetrics() returns the following information for the specified font and text: </blockquote><dl> <dt><strong><a name="item_o">o</a></strong> <DD> <P>character width o character height o ascent o descent o text width o text height o maximum horizontal advance o underline position o underline thickness</P> </dd> </li> </dl> <P>The format of the GetTypeMetrics method is:</P> <blockquote>unsigned int GetTypeMetrics ( <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#DrawInfo">DrawInfo</A> *draw_info, <A HREF="types.html#TypeMetric">TypeMetric</A> *metrics ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>draw_info:</strong> <DD> <P>The draw info.</P> </dd> </li> <dt><strong><a name="item_o_metrics_3a">metrics:</a></strong> <DD> <P>Return the font metrics in this structure.</P> </dd> </dl> </body> </html>
