draw.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <title>ImageMagick – MagickCore, C API: Draw on an Image</title>
  7. <meta name="application-name" content="ImageMagick" />
  8. <meta name="description" content="" />
  9. <meta name="application-url" content="https://imagemagick.org" />
  10. <meta name="generator" content="PHP" />
  11. <meta name="keywords" content="magickcore, c, api:, draw, on, an, image, image processing software" />
  12. <meta name="rating" content="GENERAL" />
  13. <meta name="robots" content="INDEX, FOLLOW" />
  14. <meta name="generator" content="ImageMagick Studio LLC" />
  15. <meta name="author" content="ImageMagick Studio LLC" />
  16. <meta name="revisit-after" content="2 DAYS" />
  17. <meta name="resource-type" content="document" />
  18. <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
  19. <meta name="distribution" content="Global" />
  20. <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  21. <meta property='og:url' content='../../' />
  22. <meta property='og:title' content='ImageMagick' />
  23. <meta property='og:image' content='../../../images/logo.png' />
  24. <meta property='og:type' content='website' />
  25. <meta property='og:site_name' content='ImageMagick' />
  26. <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
  27. <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  28. <link href="draw.html" rel="canonical" />
  29. <link href="../../../images/wand.png" rel="icon" />
  30. <link href="../../../images/wand.ico" rel="shortcut icon" />
  31. <link href="../../assets/magick.css" rel="stylesheet" />
  32. </head>
  33. <body>
  34. <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35. <div class="container-fluid">
  36. <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
  37. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
  38. <span class="navbar-toggler-icon"></span>
  39. </button>
  40. <div class="collapse navbar-collapse" id="magick-navbars">
  41. <ul class="navbar-nav me-auto mb-2 mb-md-0">
  42. <li class="nav-item">
  43. <a class="nav-link " href="../../www/download.html">Download</a>
  44. </li>
  45. <li class="nav-item">
  46. <a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link " href="../../www/develop.html">Develop</a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
  56. </li>
  57. <li class="nav-item">
  58. <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
  59. </li>
  60. </ul>
  61. <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
  62. <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
  63. <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
  64. </form>
  65. </div>
  66. </div>
  67. </nav>
  68. <div class="container">
  69. <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
  70. <ins class="adsbygoogle"
  71. style="display:block"
  72. data-ad-client="ca-pub-3129977114552745"
  73. data-ad-slot="6345125851"
  74. data-full-width-responsive="true"
  75. data-ad-format="horizontal"></ins>
  76. <script>
  77. (adsbygoogle = window.adsbygoogle || []).push({});
  78. </script>
  79. </div>
  80. <main class="container">
  81. <div class="magick-template">
  82. <br/>
  83. <div class="btn-group">
  84. <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
  85. Select API Method
  86. </button>
  87. <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
  88. <li><a href="draw.html#AcquireDrawInfo">AcquireDrawInfo</a></li>
  89. <li><a href="draw.html#CloneDrawInfo">CloneDrawInfo</a></li>
  90. <li><a href="draw.html#DestroyDrawInfo">DestroyDrawInfo</a></li>
  91. <li><a href="draw.html#DrawAffineImage">DrawAffineImage</a></li>
  92. <li><a href="draw.html#DrawClipPath">DrawClipPath</a></li>
  93. <li><a href="draw.html#DrawClippingMask">DrawClippingMask</a></li>
  94. <li><a href="draw.html#DrawCompositeMask">DrawCompositeMask</a></li>
  95. <li><a href="draw.html#DrawGradientImage">DrawGradientImage</a></li>
  96. <li><a href="draw.html#DrawImage">DrawImage</a></li>
  97. <li><a href="draw.html#DrawPatternPath">DrawPatternPath</a></li>
  98. <li><a href="draw.html#DrawPrimitive">DrawPrimitive</a></li>
  99. </ul>
  100. </div>
  101. <br/>
  102. <br/>
  103. <div class="magick-header">
  104. <h2><a href="../../api/MagickCore/draw_8c.html" id="AcquireDrawInfo">AcquireDrawInfo</a></h2>
  105. <p>AcquireDrawInfo() returns a DrawInfo structure properly initialized.</p>
  106. <p>The format of the AcquireDrawInfo method is:</p>
  107. <pre class="bg-light text-dark mx-4"><samp>DrawInfo *AcquireDrawInfo(void)
  108. </samp></pre>
  109. <h2><a href="../../api/MagickCore/draw_8c.html" id="CloneDrawInfo">CloneDrawInfo</a></h2>
  110. <p>CloneDrawInfo() makes a copy of the given draw_info structure. If NULL is specified, a new DrawInfo structure is created initialized to default values.</p>
  111. <p>The format of the CloneDrawInfo method is:</p>
  112. <pre class="bg-light text-dark mx-4"><samp>DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
  113. const DrawInfo *draw_info)
  114. </samp></pre>
  115. <p>A description of each parameter follows:</p>
  116. <dd>
  117. </dd>
  118. <dd> </dd>
  119. <dl class="dl-horizontal">
  120. <dt>image_info</dt>
  121. <dd>the image info. </dd>
  122. <dd> </dd>
  123. <dt>draw_info</dt>
  124. <dd>the draw info. </dd>
  125. <dd> </dd>
  126. </dl>
  127. <h2><a href="../../api/MagickCore/draw_8c.html" id="DestroyDrawInfo">DestroyDrawInfo</a></h2>
  128. <p>DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.</p>
  129. <p>The format of the DestroyDrawInfo method is:</p>
  130. <pre class="bg-light text-dark mx-4"><samp>DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
  131. </samp></pre>
  132. <p>A description of each parameter follows:</p>
  133. <dd>
  134. </dd>
  135. <dd> </dd>
  136. <dl class="dl-horizontal">
  137. <dt>draw_info</dt>
  138. <dd>the draw info. </dd>
  139. <dd> </dd>
  140. </dl>
  141. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawAffineImage">DrawAffineImage</a></h2>
  142. <p>DrawAffineImage() composites the source over the destination image as dictated by the affine transform.</p>
  143. <p>The format of the DrawAffineImage method is:</p>
  144. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawAffineImage(Image *image,const Image *source,
  145. const AffineMatrix *affine,ExceptionInfo *exception)
  146. </samp></pre>
  147. <p>A description of each parameter follows:</p>
  148. <dd>
  149. </dd>
  150. <dd> </dd>
  151. <dl class="dl-horizontal">
  152. <dt>image</dt>
  153. <dd>the image. </dd>
  154. <dd> </dd>
  155. <dt>source</dt>
  156. <dd>the source image. </dd>
  157. <dd> </dd>
  158. <dt>affine</dt>
  159. <dd>the affine transform. </dd>
  160. <dd> </dd>
  161. <dt>exception</dt>
  162. <dd>return any errors or warnings in this structure. </dd>
  163. <dd> </dd>
  164. </dl>
  165. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawClipPath">DrawClipPath</a></h2>
  166. <p>DrawClipPath() draws the clip path on the image mask.</p>
  167. <p>The format of the DrawClipPath method is:</p>
  168. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
  169. const char *id,ExceptionInfo *exception)
  170. </samp></pre>
  171. <p>A description of each parameter follows:</p>
  172. <dd>
  173. </dd>
  174. <dd> </dd>
  175. <dl class="dl-horizontal">
  176. <dt>image</dt>
  177. <dd>the image. </dd>
  178. <dd> </dd>
  179. <dt>draw_info</dt>
  180. <dd>the draw info. </dd>
  181. <dd> </dd>
  182. <dt>id</dt>
  183. <dd>the clip path id. </dd>
  184. <dd> </dd>
  185. <dt>exception</dt>
  186. <dd>return any errors or warnings in this structure. </dd>
  187. <dd> </dd>
  188. </dl>
  189. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawClippingMask">DrawClippingMask</a></h2>
  190. <p>DrawClippingMask() draws the clip path and returns it as an image clipping mask.</p>
  191. <p>The format of the DrawClippingMask method is:</p>
  192. <pre class="bg-light text-dark mx-4"><samp>Image *DrawClippingMask(Image *image,const DrawInfo *draw_info,
  193. const char *id,const char *clip_path,ExceptionInfo *exception)
  194. </samp></pre>
  195. <p>A description of each parameter follows:</p>
  196. <dd>
  197. </dd>
  198. <dd> </dd>
  199. <dl class="dl-horizontal">
  200. <dt>image</dt>
  201. <dd>the image. </dd>
  202. <dd> </dd>
  203. <dt>draw_info</dt>
  204. <dd>the draw info. </dd>
  205. <dd> </dd>
  206. <dt>id</dt>
  207. <dd>the clip path id. </dd>
  208. <dd> </dd>
  209. <dt>clip_path</dt>
  210. <dd>the clip path. </dd>
  211. <dd> </dd>
  212. <dt>exception</dt>
  213. <dd>return any errors or warnings in this structure. </dd>
  214. <dd> </dd>
  215. </dl>
  216. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawCompositeMask">DrawCompositeMask</a></h2>
  217. <p>DrawCompositeMask() draws the mask path and returns it as an image mask.</p>
  218. <p>The format of the DrawCompositeMask method is:</p>
  219. <pre class="bg-light text-dark mx-4"><samp>Image *DrawCompositeMask(Image *image,const DrawInfo *draw_info,
  220. const char *id,const char *mask_path,ExceptionInfo *exception)
  221. </samp></pre>
  222. <p>A description of each parameter follows:</p>
  223. <dd>
  224. </dd>
  225. <dd> </dd>
  226. <dl class="dl-horizontal">
  227. <dt>image</dt>
  228. <dd>the image. </dd>
  229. <dd> </dd>
  230. <dt>draw_info</dt>
  231. <dd>the draw info. </dd>
  232. <dd> </dd>
  233. <dt>id</dt>
  234. <dd>the mask path id. </dd>
  235. <dd> </dd>
  236. <dt>mask_path</dt>
  237. <dd>the mask path. </dd>
  238. <dd> </dd>
  239. <dt>exception</dt>
  240. <dd>return any errors or warnings in this structure. </dd>
  241. <dd> </dd>
  242. </dl>
  243. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawGradientImage">DrawGradientImage</a></h2>
  244. <p>DrawGradientImage() draws a linear gradient on the image.</p>
  245. <p>The format of the DrawGradientImage method is:</p>
  246. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawGradientImage(Image *image,
  247. const DrawInfo *draw_info,ExceptionInfo *exception)
  248. </samp></pre>
  249. <p>A description of each parameter follows:</p>
  250. <dd>
  251. </dd>
  252. <dd> </dd>
  253. <dl class="dl-horizontal">
  254. <dt>image</dt>
  255. <dd>the image. </dd>
  256. <dd> </dd>
  257. <dt>draw_info</dt>
  258. <dd>the draw info. </dd>
  259. <dd> </dd>
  260. <dt>exception</dt>
  261. <dd>return any errors or warnings in this structure. </dd>
  262. <dd> </dd>
  263. </dl>
  264. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawImage">DrawImage</a></h2>
  265. <p>DrawImage() draws a graphic primitive on your image. The primitive may be represented as a string or filename. Precede the filename with an "at" sign (@) and the contents of the file are drawn on the image. You can affect how text is drawn by setting one or more members of the draw info structure.</p>
  266. <p>The format of the DrawImage method is:</p>
  267. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info,
  268. ExceptionInfo *exception)
  269. </samp></pre>
  270. <p>A description of each parameter follows:</p>
  271. <dd>
  272. </dd>
  273. <dd> </dd>
  274. <dl class="dl-horizontal">
  275. <dt>image</dt>
  276. <dd>the image. </dd>
  277. <dd> </dd>
  278. <dt>draw_info</dt>
  279. <dd>the draw info. </dd>
  280. <dd> </dd>
  281. <dt>exception</dt>
  282. <dd>return any errors or warnings in this structure. </dd>
  283. <dd> </dd>
  284. </dl>
  285. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawPatternPath">DrawPatternPath</a></h2>
  286. <p>DrawPatternPath() draws a pattern.</p>
  287. <p>The format of the DrawPatternPath method is:</p>
  288. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
  289. const char *name,Image **pattern,ExceptionInfo *exception)
  290. </samp></pre>
  291. <p>A description of each parameter follows:</p>
  292. <dd>
  293. </dd>
  294. <dd> </dd>
  295. <dl class="dl-horizontal">
  296. <dt>image</dt>
  297. <dd>the image. </dd>
  298. <dd> </dd>
  299. <dt>draw_info</dt>
  300. <dd>the draw info. </dd>
  301. <dd> </dd>
  302. <dt>name</dt>
  303. <dd>the pattern name. </dd>
  304. <dd> </dd>
  305. <dt>image</dt>
  306. <dd>the image. </dd>
  307. <dd> </dd>
  308. <dt>exception</dt>
  309. <dd>return any errors or warnings in this structure. </dd>
  310. <dd> </dd>
  311. </dl>
  312. <h2><a href="../../api/MagickCore/draw_8c.html" id="DrawPrimitive">DrawPrimitive</a></h2>
  313. <p>DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.</p>
  314. <p>The format of the DrawPrimitive method is:</p>
  315. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
  316. PrimitiveInfo *primitive_info,ExceptionInfo *exception)
  317. </samp></pre>
  318. <p>A description of each parameter follows:</p>
  319. <dd>
  320. </dd>
  321. <dd> </dd>
  322. <dl class="dl-horizontal">
  323. <dt>image</dt>
  324. <dd>the image. </dd>
  325. <dd> </dd>
  326. <dt>draw_info</dt>
  327. <dd>the draw info. </dd>
  328. <dd> </dd>
  329. <dt>primitive_info</dt>
  330. <dd>Specifies a pointer to a PrimitiveInfo structure. </dd>
  331. <dd> </dd>
  332. <dt>exception</dt>
  333. <dd>return any errors or warnings in this structure. </dd>
  334. <dd> </dd>
  335. </dl>
  336. <h2><a href="../../api/MagickCore/draw_8c.html" id="GetAffineMatrix">GetAffineMatrix</a></h2>
  337. <p>GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.</p>
  338. <p>The format of the GetAffineMatrix method is:</p>
  339. <pre class="bg-light text-dark mx-4"><samp>void GetAffineMatrix(AffineMatrix *affine_matrix)
  340. </samp></pre>
  341. <p>A description of each parameter follows:</p>
  342. <dd>
  343. </dd>
  344. <dd> </dd>
  345. <dl class="dl-horizontal">
  346. <dt>affine_matrix</dt>
  347. <dd>the affine matrix. </dd>
  348. <dd> </dd>
  349. </dl>
  350. </div>
  351. </div>
  352. </main><!-- /.container -->
  353. <footer class="magick-footer">
  354. <div class="container-fluid">
  355. <a href="../../www/security-policy.html">Security</a> •
  356. <a href="../../www/news.html">News</a>
  357. <a href="draw.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
  358. <a href="../../www/links.html">Related</a> •
  359. <a href="../../www/sitemap.html">Sitemap</a>
  360. <br/>
  361. <a href="../../www/support.html">Sponsor</a> •
  362. <a href="../../www/cite.html">Cite</a> •
  363. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  364. <a href="../../www/contact.html">Contact Us</a>
  365. <br/>
  366. <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
  367. <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
  368. <br/>
  369. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  370. </div>
  371. </footer>
  372. <!-- Javascript assets -->
  373. <script src="../../assets/magick.js" ></script>
  374. </body>
  375. </html>