1 2 3 4 5<!DOCTYPE html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" /> 10 <title>ImageMagick - MagickCore, C API: Annotate an Image</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert bitmap images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickcore, c, api:, annotate, an, image, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Convert, Edit, or Compose Bitmap Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="annotate.html" rel="canonical" /> 33 <link href="../../images/wand.png" rel="icon" /> 34 <link href="../../images/wand.ico" rel="shortcut icon" /> 35 <link href="../assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark"> 39 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../images/wand.ico"/></a> 40 <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation"> 41 <span class="navbar-toggler-icon"></span> 42 </button> 43 44 <div class="navbar-collapse collapse" id="navbarsMagick" style=""> 45 <ul class="navbar-nav mr-auto"> 46 <li class="nav-item "> 47 <a class="nav-link" href="../../">Home <span class="sr-only">(current)</span></a> 48 </li> 49 <li class="nav-item "> 50 <a class="nav-link" href="../../www/download.html">Download</a> 51 </li> 52 <li class="nav-item "> 53 <a class="nav-link" href="../../www/command-line-tools.html">Tools</a> 54 </li> 55 <li class="nav-item "> 56 <a class="nav-link" href="../../www/command-line-processing.html">Command-line</a> 57 </li> 58 <li class="nav-item "> 59 <a class="nav-link" href="../../www/resources.html">Resources</a> 60 </li> 61 <li class="nav-item "> 62 <a class="nav-link" href="../../www/develop.html">Develop</a> 63 </li> 64 <li class="nav-item"> 65 <a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a> 66 </li> 67 </ul> 68 <form class="form-inline my-2 my-lg-0" action="../https://imagemagick.org/script/search.php"> 69 <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search"> 70 <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button> 71 </form> 72 </div> 73 </nav> 74 <div class="container"> 75 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle" 76 style="display:block" 77 data-ad-client="ca-pub-3129977114552745" 78 data-ad-slot="6345125851" 79 data-full-width-responsive="true" 80 data-ad-format="horizontal"></ins> 81 <script> 82 (adsbygoogle = window.adsbygoogle || []).push({}); 83 </script> 84 85 </div> 86 87 <main class="container"> 88 <div class="magick-template"> 89<div class="magick-header"> 90<p class="text-center"><a href="annotate.html#AnnotateImage">AnnotateImage</a> • <a href="annotate.html#FormatMagickCaption">FormatMagickCaption</a> • <a href="annotate.html#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> • <a href="annotate.html#GetTypeMetrics">GetTypeMetrics</a></p> 91 92<h2><a href="../../api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2> 93 94<p>AnnotateImage() annotates an image with text.</p> 95 96<p>The format of the AnnotateImage method is:</p> 97 98<pre class="text"> 99MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info, 100 ExceptionInfo *exception) 101</pre> 102 103<p>A description of each parameter follows:</p> 104 105<dd> 106</dd> 107 108<dd> </dd> 109<dl class="dl-horizontal"> 110<dt>image</dt> 111<dd>the image. </dd> 112 113<dd> </dd> 114<dt>draw_info</dt> 115<dd>the draw info. </dd> 116 117<dd> </dd> 118<dt>exception</dt> 119<dd>return any errors or warnings in this structure. </dd> 120 121<dd> </dd> 122</dl> 123<h2><a href="../../api/MagickCore/annotate_8c.html" id="FormatMagickCaption">FormatMagickCaption</a></h2> 124 125<p>FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.</p> 126 127<p>The format of the FormatMagickCaption method is:</p> 128 129<pre class="text"> 130ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info, 131 const MagickBooleanType split,TypeMetric *metrics,char **caption, 132 ExceptionInfo *exception) 133</pre> 134 135<p>A description of each parameter follows.</p> 136 137<dt>image</dt> 138<p>The image.</p> 139 140<dt>draw_info</dt> 141<p>the draw info.</p> 142 143<dt>split</dt> 144<p>when no convenient line breaks-- insert newline.</p> 145 146<dt>metrics</dt> 147<p>Return the font metrics in this structure.</p> 148 149<dt>caption</dt> 150<p>the caption.</p> 151 152<dt>exception</dt> 153<p>return any errors or warnings in this structure.</p> 154 155<h2><a href="../../api/MagickCore/annotate_8c.html" id="GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></h2> 156 157<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p> 158 159<pre class="text"> 160 character width 161 character height 162 ascender 163 descender 164 text width 165 text height 166 maximum horizontal advance 167 bounds: x1 168 bounds: y1 169 bounds: x2 170 bounds: y2 171 origin: x 172 origin: y 173 underline position 174 underline thickness 175</pre> 176 177<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p> 178 179<p>The format of the GetMultilineTypeMetrics method is:</p> 180 181<pre class="text"> 182MagickBooleanType GetMultilineTypeMetrics(Image *image, 183 const DrawInfo *draw_info,TypeMetric *metrics,ExceptionInfo *exception) 184</pre> 185 186<p>A description of each parameter follows:</p> 187 188<dd> 189</dd> 190 191<dd> </dd> 192<dl class="dl-horizontal"> 193<dt>image</dt> 194<dd>the image. </dd> 195 196<dd> </dd> 197<dt>draw_info</dt> 198<dd>the draw info. </dd> 199 200<dd> </dd> 201<dt>metrics</dt> 202<dd>Return the font metrics in this structure. </dd> 203 204<dd> </dd> 205<dt>exception</dt> 206<dd>return any errors or warnings in this structure. </dd> 207 208<dd> </dd> 209</dl> 210<h2><a href="../../api/MagickCore/annotate_8c.html" id="GetTypeMetrics">GetTypeMetrics</a></h2> 211 212<p>GetTypeMetrics() returns the following information for the specified font and text:</p> 213 214<pre class="text"> 215 character width 216 character height 217 ascender 218 descender 219 text width 220 text height 221 maximum horizontal advance 222 bounds: x1 223 bounds: y1 224 bounds: x2 225 bounds: y2 226 origin: x 227 origin: y 228 underline position 229 underline thickness 230</pre> 231 232<p>The format of the GetTypeMetrics method is:</p> 233 234<pre class="text"> 235MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info, 236 TypeMetric *metrics,ExceptionInfo *exception) 237</pre> 238 239<p>A description of each parameter follows:</p> 240 241<dd> 242</dd> 243 244<dd> </dd> 245<dl class="dl-horizontal"> 246<dt>image</dt> 247<dd>the image. </dd> 248 249<dd> </dd> 250<dt>draw_info</dt> 251<dd>the draw info. </dd> 252 253<dd> </dd> 254<dt>metrics</dt> 255<dd>Return the font metrics in this structure. </dd> 256 257<dd> </dd> 258<dt>exception</dt> 259<dd>return any errors or warnings in this structure. </dd> 260 261<dd> </dd> 262</dl> 263</div> 264 </div> 265 </main><!-- /.container --> 266 <footer class="magick-footer"> 267 <p><a href="../../www/security-policy.html">Security</a> • 268 <a href="../../www/architecture.html">Architecture</a> 269 270 <a href="annotate.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../images/wand.ico"/></a> 271 272 <a href="../../www/links.html">Related</a> • 273 <a href="../../www/sitemap.html">Sitemap</a> 274 <br/> 275 <a href="../../www/support.html">Donate</a> • 276 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 277 <a href="../../www/contact.html">Contact Us</a> 278 <br/> 279 <small>© 1999-2020 ImageMagick Studio LLC</small></p> 280 </footer> 281 282 <!-- Javascript assets --> 283 <script src="../assets/magick.js" crossorigin="anonymous"></script> 284 <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.4.1/jquery.min.js"><\/script>')</script> 285</body> 286</html> 287<!-- Magick Cache 30th December 2019 13:18 -->
