attribute.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  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: Set Text Attributes</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:, set, text, attributes, 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="attribute.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="attribute.html#GetImageConvexHull">GetImageConvexHull</a></li>
  89. <li><a href="attribute.html#GetImageDepth">GetImageDepth</a></li>
  90. <li><a href="attribute.html#GetImageMinimumBoundingBox">GetImageMinimumBoundingBox</a></li>
  91. <li><a href="attribute.html#GetImageQuantumDepth">GetImageQuantumDepth</a></li>
  92. <li><a href="attribute.html#GetImageType">GetImageType</a></li>
  93. <li><a href="attribute.html#IdentifyImageGray">IdentifyImageGray</a></li>
  94. <li><a href="attribute.html#IdentifyImageMonochrome">IdentifyImageMonochrome</a></li>
  95. <li><a href="attribute.html#IdentifyImageType">IdentifyImageType</a></li>
  96. <li><a href="attribute.html#IsImageGray">IsImageGray</a></li>
  97. <li><a href="attribute.html#IsImageMonochrome">IsImageMonochrome</a></li>
  98. <li><a href="attribute.html#IsImageOpaque">IsImageOpaque</a></li>
  99. <li><a href="attribute.html#SetImageDepth">SetImageDepth</a></li>
  100. </ul>
  101. </div>
  102. <br/>
  103. <br/>
  104. <div class="magick-header">
  105. <h2><a href="../../api/MagickCore/attribute_8c.html" id="GetImageConvexHull">GetImageConvexHull</a></h2>
  106. <p>GetImageConvexHull() returns the convex hull points of an image canvas.</p>
  107. <p>The format of the GetImageConvexHull method is:</p>
  108. <pre class="bg-light text-dark mx-4"><samp>PointInfo *GetImageConvexHull(const Image *image,
  109. size_t number_vertices,ExceptionInfo *exception)
  110. </samp></pre>
  111. <p>A description of each parameter follows:</p>
  112. <dd>
  113. </dd>
  114. <dd> </dd>
  115. <dl class="dl-horizontal">
  116. <dt>image</dt>
  117. <dd>the image. </dd>
  118. <dd> </dd>
  119. <dt>number_vertices</dt>
  120. <dd>the number of vertices in the convex hull. </dd>
  121. <dd> </dd>
  122. <dt>exception</dt>
  123. <dd>return any errors or warnings in this structure. </dd>
  124. <dd> </dd>
  125. </dl>
  126. <h2><a href="../../api/MagickCore/attribute_8c.html" id="GetImageDepth">GetImageDepth</a></h2>
  127. <p>GetImageDepth() returns the depth of a particular image channel.</p>
  128. <p>The format of the GetImageDepth method is:</p>
  129. <pre class="bg-light text-dark mx-4"><samp>size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
  130. </samp></pre>
  131. <p>A description of each parameter follows:</p>
  132. <dd>
  133. </dd>
  134. <dd> </dd>
  135. <dl class="dl-horizontal">
  136. <dt>image</dt>
  137. <dd>the image. </dd>
  138. <dd> </dd>
  139. <dt>exception</dt>
  140. <dd>return any errors or warnings in this structure. </dd>
  141. <dd> </dd>
  142. </dl>
  143. <h2><a href="../../api/MagickCore/attribute_8c.html" id="GetImageMinimumBoundingBox">GetImageMinimumBoundingBox</a></h2>
  144. <p>GetImageMinimumBoundingBox() returns the points that form the minimum bounding box around the image foreground objects with the "Rotating Calipers" algorithm. The method also returns these properties:</p>
  145. <pre class="bg-light text-dark mx-4"><samp> minimum-bounding-box:height, and minimum-bounding-box:angle.
  146. </samp></pre>
  147. <p>The format of the GetImageMinimumBoundingBox method is:</p>
  148. <pre class="bg-light text-dark mx-4"><samp>PointInfo *GetImageMinimumBoundingBox(Image *image,
  149. size_t number_vertices,ExceptionInfo *exception)
  150. </samp></pre>
  151. <p>A description of each parameter follows:</p>
  152. <dd>
  153. </dd>
  154. <dd> </dd>
  155. <dl class="dl-horizontal">
  156. <dt>image</dt>
  157. <dd>the image. </dd>
  158. <dd> </dd>
  159. <dt>number_vertices</dt>
  160. <dd>the number of vertices in the bounding box. </dd>
  161. <dd> </dd>
  162. <dt>exception</dt>
  163. <dd>return any errors or warnings in this structure. </dd>
  164. <dd> </dd>
  165. </dl>
  166. <h2><a href="../../api/MagickCore/attribute_8c.html" id="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
  167. <p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p>
  168. <p>The format of the GetImageQuantumDepth method is:</p>
  169. <pre class="bg-light text-dark mx-4"><samp>size_t GetImageQuantumDepth(const Image *image,
  170. const MagickBooleanType constrain)
  171. </samp></pre>
  172. <p>A description of each parameter follows:</p>
  173. <dd>
  174. </dd>
  175. <dd> </dd>
  176. <dl class="dl-horizontal">
  177. <dt>image</dt>
  178. <dd>the image. </dd>
  179. <dd> </dd>
  180. <dt>constrain</dt>
  181. <dd>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH. </dd>
  182. <dd> </dd>
  183. </dl>
  184. <h2><a href="../../api/MagickCore/attribute_8c.html" id="GetImageType">GetImageType</a></h2>
  185. <p>GetImageType() returns the type of image:</p>
  186. <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p>
  187. <p>The format of the GetImageType method is:</p>
  188. <pre class="bg-light text-dark mx-4"><samp>ImageType GetImageType(const Image *image)
  189. </samp></pre>
  190. <p>A description of each parameter follows:</p>
  191. <dd>
  192. </dd>
  193. <dd> </dd>
  194. <dl class="dl-horizontal">
  195. <dt>image</dt>
  196. <dd>the image. </dd>
  197. <dd> </dd>
  198. </dl>
  199. <h2><a href="../../api/MagickCore/attribute_8c.html" id="IdentifyImageGray">IdentifyImageGray</a></h2>
  200. <p>IdentifyImageGray() returns grayscale if all the pixels in the image have the same red, green, and blue intensities, and bi-level is the intensity is either 0 or QuantumRange. Otherwise undefined is returned.</p>
  201. <p>The format of the IdentifyImageGray method is:</p>
  202. <pre class="bg-light text-dark mx-4"><samp>ImageType IdentifyImageGray(const Image *image,ExceptionInfo *exception)
  203. </samp></pre>
  204. <p>A description of each parameter follows:</p>
  205. <dd>
  206. </dd>
  207. <dd> </dd>
  208. <dl class="dl-horizontal">
  209. <dt>image</dt>
  210. <dd>the image. </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/attribute_8c.html" id="IdentifyImageMonochrome">IdentifyImageMonochrome</a></h2>
  217. <p>IdentifyImageMonochrome() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities and the intensity is either 0 or QuantumRange.</p>
  218. <p>The format of the IdentifyImageMonochrome method is:</p>
  219. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IdentifyImageMonochrome(const Image *image,
  220. 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>exception</dt>
  231. <dd>return any errors or warnings in this structure. </dd>
  232. <dd> </dd>
  233. </dl>
  234. <h2><a href="../../api/MagickCore/attribute_8c.html" id="IdentifyImageType">IdentifyImageType</a></h2>
  235. <p>IdentifyImageType() returns the potential type of image:</p>
  236. <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p>
  237. <p>To ensure the image type matches its potential, use SetImageType():</p>
  238. <pre class="bg-light text-dark mx-4"><samp> (void) SetImageType(image,IdentifyImageType(image,exception),exception);
  239. </samp></pre>
  240. <p>The format of the IdentifyImageType method is:</p>
  241. <pre class="bg-light text-dark mx-4"><samp>ImageType IdentifyImageType(const Image *image,ExceptionInfo *exception)
  242. </samp></pre>
  243. <p>A description of each parameter follows:</p>
  244. <dd>
  245. </dd>
  246. <dd> </dd>
  247. <dl class="dl-horizontal">
  248. <dt>image</dt>
  249. <dd>the image. </dd>
  250. <dd> </dd>
  251. <dt>exception</dt>
  252. <dd>return any errors or warnings in this structure. </dd>
  253. <dd> </dd>
  254. </dl>
  255. <h2><a href="../../api/MagickCore/attribute_8c.html" id="IsImageGray">IsImageGray</a></h2>
  256. <p>IsImageGray() returns MagickTrue if the type of the image is grayscale or bi-level.</p>
  257. <p>The format of the IsImageGray method is:</p>
  258. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsImageGray(const Image *image)
  259. </samp></pre>
  260. <p>A description of each parameter follows:</p>
  261. <dd>
  262. </dd>
  263. <dd> </dd>
  264. <dl class="dl-horizontal">
  265. <dt>image</dt>
  266. <dd>the image. </dd>
  267. <dd> </dd>
  268. </dl>
  269. <h2><a href="../../api/MagickCore/attribute_8c.html" id="IsImageMonochrome">IsImageMonochrome</a></h2>
  270. <p>IsImageMonochrome() returns MagickTrue if type of the image is bi-level.</p>
  271. <p>The format of the IsImageMonochrome method is:</p>
  272. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsImageMonochrome(const Image *image)
  273. </samp></pre>
  274. <p>A description of each parameter follows:</p>
  275. <dd>
  276. </dd>
  277. <dd> </dd>
  278. <dl class="dl-horizontal">
  279. <dt>image</dt>
  280. <dd>the image. </dd>
  281. <dd> </dd>
  282. </dl>
  283. <h2><a href="../../api/MagickCore/attribute_8c.html" id="IsImageOpaque">IsImageOpaque</a></h2>
  284. <p>IsImageOpaque() returns MagickTrue if none of the pixels in the image have an alpha value other than OpaqueAlpha (QuantumRange).</p>
  285. <p>Will return true immediately is alpha channel is not available.</p>
  286. <p>The format of the IsImageOpaque method is:</p>
  287. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsImageOpaque(const Image *image,
  288. ExceptionInfo *exception)
  289. </samp></pre>
  290. <p>A description of each parameter follows:</p>
  291. <dd>
  292. </dd>
  293. <dd> </dd>
  294. <dl class="dl-horizontal">
  295. <dt>image</dt>
  296. <dd>the image. </dd>
  297. <dd> </dd>
  298. <dt>exception</dt>
  299. <dd>return any errors or warnings in this structure. </dd>
  300. <dd> </dd>
  301. </dl>
  302. <h2><a href="../../api/MagickCore/attribute_8c.html" id="SetImageDepth">SetImageDepth</a></h2>
  303. <p>SetImageDepth() sets the depth of the image.</p>
  304. <p>The format of the SetImageDepth method is:</p>
  305. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageDepth(Image *image,const size_t depth,
  306. ExceptionInfo *exception)
  307. </samp></pre>
  308. <p>A description of each parameter follows:</p>
  309. <dd>
  310. </dd>
  311. <dd> </dd>
  312. <dl class="dl-horizontal">
  313. <dt>image</dt>
  314. <dd>the image. </dd>
  315. <dd> </dd>
  316. <dt>channel</dt>
  317. <dd>the channel. </dd>
  318. <dd> </dd>
  319. <dt>depth</dt>
  320. <dd>the image depth. </dd>
  321. <dd> </dd>
  322. <dt>exception</dt>
  323. <dd>return any errors or warnings in this structure. </dd>
  324. <dd> </dd>
  325. </dl>
  326. <h2><a href="../../api/MagickCore/attribute_8c.html" id="SetImageType">SetImageType</a></h2>
  327. <p>SetImageType() sets the type of image. Choose from these types:</p>
  328. <p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p>
  329. <p>The format of the SetImageType method is:</p>
  330. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageType(Image *image,const ImageType type,
  331. ExceptionInfo *exception)
  332. </samp></pre>
  333. <p>A description of each parameter follows:</p>
  334. <dd>
  335. </dd>
  336. <dd> </dd>
  337. <dl class="dl-horizontal">
  338. <dt>image</dt>
  339. <dd>the image. </dd>
  340. <dd> </dd>
  341. <dt>type</dt>
  342. <dd>Image type. </dd>
  343. <dd> </dd>
  344. <dt>exception</dt>
  345. <dd>return any errors or warnings in this structure. </dd>
  346. <dd> </dd>
  347. </dl>
  348. </div>
  349. </div>
  350. </main><!-- /.container -->
  351. <footer class="magick-footer">
  352. <div class="container-fluid">
  353. <a href="../../www/security-policy.html">Security</a> •
  354. <a href="../../www/news.html">News</a>
  355. <a href="attribute.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
  356. <a href="../../www/links.html">Related</a> •
  357. <a href="../../www/sitemap.html">Sitemap</a>
  358. <br/>
  359. <a href="../../www/support.html">Sponsor</a> •
  360. <a href="../../www/cite.html">Cite</a> •
  361. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  362. <a href="../../www/contact.html">Contact Us</a>
  363. <br/>
  364. <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> •
  365. <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>
  366. <br/>
  367. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  368. </div>
  369. </footer>
  370. <!-- Javascript assets -->
  371. <script src="../../assets/magick.js" ></script>
  372. </body>
  373. </html>