Skip to content

Commit e2ccacd

Browse files
author
Cristy
committed
latest documentation
1 parent 2a2a6c3 commit e2ccacd

File tree

126 files changed

+4778
-4362
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+4778
-4362
lines changed

‎index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,4 +276,4 @@ <h4><a class="anchor" id="community"></a>Community</h4>
276276
<script src="www/assets/magick.js" ></script>
277277
</body>
278278
</html>
279-
<!-- Magick Cache 26th November 2022 00:09 -->
279+
<!-- Magick Cache 1st December 2022 01:14 -->

‎www/advanced-linux-installation.html

+1
Original file line numberDiff line numberDiff line change
@@ -656,3 +656,4 @@ <h4>PerlMagick</h4>
656656
<script src="assets/magick.js" ></script>
657657
</body>
658658
</html>
659+
<!-- Magick Cache 1st December 2022 03:54 -->

‎www/advanced-unix-installation.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ <h5>PerlMagick</h5>
643643
<a href="support.html">Sponsor</a> •
644644
<a href="cite.html">Cite</a> •
645645
<a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
646-
<a href="../www/../www/../www/../www/https://imagemagick.org/script/contact.php">Contact Us</a>
646+
<a href="../www/../www/../www/../www/../www/https://imagemagick.org/script/contact.php">Contact Us</a>
647647
<br/>
648648
<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> •
649649
<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 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a>

‎www/advanced-windows-installation.html

+1
Original file line numberDiff line numberDiff line change
@@ -157,3 +157,4 @@ <h2>Build ImageMagick</h2>
157157
<script src="assets/magick.js" ></script>
158158
</body>
159159
</html>
160+
<!-- Magick Cache 1st December 2022 03:54 -->

‎www/animate.html

+1
Original file line numberDiff line numberDiff line change
@@ -574,3 +574,4 @@ <h2><a class="anchor" id="options"></a>Option Summary</h2>
574574
<script src="assets/magick.js" ></script>
575575
</body>
576576
</html>
577+
<!-- Magick Cache 1st December 2022 03:54 -->

‎www/api/Image++.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@
2424
<meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
2525
<meta property='og:url' content='../../' />
2626
<meta property='og:title' content='ImageMagick' />
27-
<meta property='og:image' content='../../../../../../../../../../../images/logo.png' />
27+
<meta property='og:image' content='../../../../../../../../../../../../images/logo.png' />
2828
<meta property='og:type' content='website' />
2929
<meta property='og:site_name' content='ImageMagick' />
3030
<meta property='og:description' content="Create, Edit, Compose, or Convert Bitmap Images" />
3131
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
3232
<link href="../../api/Image++.html" rel="canonical" />
33-
<link href="../../../../../../../../../../images/wand.png" rel="icon" />
34-
<link href="../../../../../../../../../../images/wand.ico" rel="shortcut icon" />
33+
<link href="../../../../../../../../../../../images/wand.png" rel="icon" />
34+
<link href="../../../../../../../../../../../images/wand.ico" rel="shortcut icon" />
3535
<link href="../assets/magick.css" rel="stylesheet" />
3636
</head>
3737
<body>
3838
<nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
39-
<a class="navbar-brand" href="../index.html"><img class="d-block" id="wand" alt="ImageMagick" width="32" height="32" src="../../../../../../../../../../images/wand.ico"/></a>
39+
<a class="navbar-brand" href="../index.html"><img class="d-block" id="wand" alt="ImageMagick" width="32" height="32" src="../../../../../../../../../../../images/wand.ico"/></a>
4040
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation">
4141
<span class="navbar-toggler-icon"></span>
4242
</button>
@@ -3221,7 +3221,7 @@ <h2> <a name="Raw Image Pixel Access"></a> Low-Level Image Pixel Access</h2>
32213221
<p><a href="../security-policy.html">Security</a> •
32223222
<a href="../architecture.html">Architecture</a>
32233223

3224-
<a href="Image++.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../../../../../../../../images/wand.ico"/></a>
3224+
<a href="Image++.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../../../../../../../../../images/wand.ico"/></a>
32253225

32263226
<a href="../links.html">Related</a> •
32273227
<a href="../sitemap.html">Sitemap</a>

‎www/api/animate.html

+10-2
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,17 @@
9090

9191
<main class="container">
9292
<div class="magick-template">
93+
<br/>
94+
<div class="btn-group">
95+
<button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
96+
Select API Method
97+
</button>
98+
<ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
99+
</ul>
100+
</div>
101+
<br/>
102+
<br/>
93103
<div class="magick-header">
94-
<p class="text-center"><a href="animate.html#Unknown method">Unknown method</a></p>
95-
96104
</div>
97105
</div>
98106
</main><!-- /.container -->

‎www/api/annotate.html

+25-20
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,28 @@
9090

9191
<main class="container">
9292
<div class="magick-template">
93+
<br/>
94+
<div class="btn-group">
95+
<button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
96+
Select API Method
97+
</button>
98+
<ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
99+
<li><a href="annotate.html#AnnotateImage">AnnotateImage</a></li>
100+
<li><a href="annotate.html#FormatMagickCaption">FormatMagickCaption</a></li>
101+
<li><a href="annotate.html#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a></li>
102+
</ul>
103+
</div>
104+
<br/>
105+
<br/>
93106
<div class="magick-header">
94-
<p class="text-center"><a href="annotate.html#AnnotateImage">AnnotateImage</a> &#8226; <a href="annotate.html#FormatMagickCaption">FormatMagickCaption</a> &#8226; <a href="annotate.html#GetMultilineTypeMetrics">GetMultilineTypeMetrics</a> &#8226; <a href="annotate.html#GetTypeMetrics">GetTypeMetrics</a></p>
95-
96107
<h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id="AnnotateImage">AnnotateImage</a></h2>
97108

98109
<p>AnnotateImage() annotates an image with text.</p>
99110

100111
<p>The format of the AnnotateImage method is:</p>
101112

102-
<pre class="text">
103-
MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
104-
</pre>
113+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
114+
</samp></pre>
105115

106116
<p>A description of each parameter follows:</p>
107117

@@ -125,10 +135,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id=
125135

126136
<p>The format of the FormatMagickCaption method is:</p>
127137

128-
<pre class="text">
129-
ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
138+
<pre class="bg-light text-dark mx-4"><samp>ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
130139
const MagickBooleanType split,TypeMetric *metrics,char **caption)
131-
</pre>
140+
</samp></pre>
132141

133142
<p>A description of each parameter follows.</p>
134143

@@ -151,8 +160,7 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id=
151160

152161
<p>GetMultilineTypeMetrics() returns the following information for the specified font and text:</p>
153162

154-
<pre class="text">
155-
character width
163+
<pre class="bg-light text-dark mx-4"><samp> character width
156164
character height
157165
ascender
158166
descender
@@ -167,16 +175,15 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id=
167175
origin: y
168176
underline position
169177
underline thickness
170-
</pre>
178+
</samp></pre>
171179

172180
<p>This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
173181

174182
<p>The format of the GetMultilineTypeMetrics method is:</p>
175183

176-
<pre class="text">
177-
MagickBooleanType GetMultilineTypeMetrics(Image *image,
184+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetMultilineTypeMetrics(Image *image,
178185
const DrawInfo *draw_info,TypeMetric *metrics)
179-
</pre>
186+
</samp></pre>
180187

181188
<p>A description of each parameter follows:</p>
182189

@@ -202,8 +209,7 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id=
202209

203210
<p>GetTypeMetrics() returns the following information for the specified font and text:</p>
204211

205-
<pre class="text">
206-
character width
212+
<pre class="bg-light text-dark mx-4"><samp> character width
207213
character height
208214
ascender
209215
descender
@@ -218,14 +224,13 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/annotate_8c.html" id=
218224
origin: y
219225
underline position
220226
underline thickness
221-
</pre>
227+
</samp></pre>
222228

223229
<p>The format of the GetTypeMetrics method is:</p>
224230

225-
<pre class="text">
226-
MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
231+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
227232
TypeMetric *metrics)
228-
</pre>
233+
</samp></pre>
229234

230235
<p>A description of each parameter follows:</p>
231236

‎www/api/attribute.html

+43-38
Original file line numberDiff line numberDiff line change
@@ -90,20 +90,36 @@
9090

9191
<main class="container">
9292
<div class="magick-template">
93+
<br/>
94+
<div class="btn-group">
95+
<button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
96+
Select API Method
97+
</button>
98+
<ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
99+
<li><a href="attribute.html#GetImageChannelDepth">GetImageChannelDepth</a></li>
100+
<li><a href="attribute.html#GetImageQuantumDepth">GetImageQuantumDepth</a></li>
101+
<li><a href="attribute.html#GetImageType">GetImageType</a></li>
102+
<li><a href="attribute.html#IdentifyImageMonochrome">IdentifyImageMonochrome</a></li>
103+
<li><a href="attribute.html#IdentifyImageType">IdentifyImageType</a></li>
104+
<li><a href="attribute.html#IsGrayImage">IsGrayImage</a></li>
105+
<li><a href="attribute.html#IsMonochromeImage">IsMonochromeImage</a></li>
106+
<li><a href="attribute.html#IsOpaqueImage">IsOpaqueImage</a></li>
107+
<li><a href="attribute.html#SetImageChannelDepth">SetImageChannelDepth</a></li>
108+
</ul>
109+
</div>
110+
<br/>
111+
<br/>
93112
<div class="magick-header">
94-
<p class="text-center"><a href="attribute.html#GetImageChannelDepth">GetImageChannelDepth</a> &#8226; <a href="attribute.html#GetImageQuantumDepth">GetImageQuantumDepth</a> &#8226; <a href="attribute.html#GetImageType">GetImageType</a> &#8226; <a href="attribute.html#IdentifyImageMonochrome">IdentifyImageMonochrome</a> &#8226; <a href="attribute.html#IdentifyImageType">IdentifyImageType</a> &#8226; <a href="attribute.html#IsGrayImage">IsGrayImage</a> &#8226; <a href="attribute.html#IsMonochromeImage">IsMonochromeImage</a> &#8226; <a href="attribute.html#IsOpaqueImage">IsOpaqueImage</a> &#8226; <a href="attribute.html#SetImageChannelDepth">SetImageChannelDepth</a> &#8226; <a href="attribute.html#SetImageType">SetImageType</a></p>
95-
96113
<h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id="GetImageChannelDepth">GetImageChannelDepth</a></h2>
97114

98115
<p>GetImageChannelDepth() returns the depth of a particular image channel.</p>
99116

100117
<p>The format of the GetImageChannelDepth method is:</p>
101118

102-
<pre class="text">
103-
size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
119+
<pre class="bg-light text-dark mx-4"><samp>size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
104120
size_t GetImageChannelDepth(const Image *image,
105121
const ChannelType channel,ExceptionInfo *exception)
106-
</pre>
122+
</samp></pre>
107123

108124
<p>A description of each parameter follows:</p>
109125

@@ -131,10 +147,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
131147

132148
<p>The format of the GetImageQuantumDepth method is:</p>
133149

134-
<pre class="text">
135-
size_t GetImageQuantumDepth(const Image *image,
150+
<pre class="bg-light text-dark mx-4"><samp>size_t GetImageQuantumDepth(const Image *image,
136151
const MagickBooleanType constrain)
137-
</pre>
152+
</samp></pre>
138153

139154
<p>A description of each parameter follows:</p>
140155

@@ -160,15 +175,13 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
160175

161176
<p>To ensure the image type matches its potential, use SetImageType():</p>
162177

163-
<pre class="text">
164-
(void) SetImageType(image,GetImageType(image));
165-
</pre>
178+
<pre class="bg-light text-dark mx-4"><samp> (void) SetImageType(image,GetImageType(image));
179+
</samp></pre>
166180

167181
<p>The format of the GetImageType method is:</p>
168182

169-
<pre class="text">
170-
ImageType GetImageType(const Image *image,ExceptionInfo *exception)
171-
</pre>
183+
<pre class="bg-light text-dark mx-4"><samp>ImageType GetImageType(const Image *image,ExceptionInfo *exception)
184+
</samp></pre>
172185

173186
<p>A description of each parameter follows:</p>
174187

@@ -192,10 +205,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
192205

193206
<p>The format of the IdentifyImageMonochrome method is:</p>
194207

195-
<pre class="text">
196-
MagickBooleanType IdentifyImageMonochrome(const Image *image,
208+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IdentifyImageMonochrome(const Image *image,
197209
ExceptionInfo *exception)
198-
</pre>
210+
</samp></pre>
199211

200212
<p>A description of each parameter follows:</p>
201213

@@ -221,15 +233,13 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
221233

222234
<p>To ensure the image type matches its potential, use SetImageType():</p>
223235

224-
<pre class="text">
225-
(void) SetImageType(image,IdentifyImageType(image,exception),exception);
226-
</pre>
236+
<pre class="bg-light text-dark mx-4"><samp> (void) SetImageType(image,IdentifyImageType(image,exception),exception);
237+
</samp></pre>
227238

228239
<p>The format of the IdentifyImageType method is:</p>
229240

230-
<pre class="text">
231-
ImageType IdentifyImageType(const Image *image,ExceptionInfo *exception)
232-
</pre>
241+
<pre class="bg-light text-dark mx-4"><samp>ImageType IdentifyImageType(const Image *image,ExceptionInfo *exception)
242+
</samp></pre>
233243

234244
<p>A description of each parameter follows:</p>
235245

@@ -253,10 +263,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
253263

254264
<p>The format of the IsGrayImage method is:</p>
255265

256-
<pre class="text">
257-
MagickBooleanType IsGrayImage(const Image *image,
266+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsGrayImage(const Image *image,
258267
ExceptionInfo *exception)
259-
</pre>
268+
</samp></pre>
260269

261270
<p>A description of each parameter follows:</p>
262271

@@ -280,10 +289,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
280289

281290
<p>The format of the IsMonochromeImage method is:</p>
282291

283-
<pre class="text">
284-
MagickBooleanType IsMonochromeImage(const Image *image,
292+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsMonochromeImage(const Image *image,
285293
ExceptionInfo *exception)
286-
</pre>
294+
</samp></pre>
287295

288296
<p>A description of each parameter follows:</p>
289297

@@ -307,10 +315,9 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
307315

308316
<p>The format of the IsOpaqueImage method is:</p>
309317

310-
<pre class="text">
311-
MagickBooleanType IsOpaqueImage(const Image *image,
318+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsOpaqueImage(const Image *image,
312319
ExceptionInfo *exception)
313-
</pre>
320+
</samp></pre>
314321

315322
<p>A description of each parameter follows:</p>
316323

@@ -334,11 +341,10 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
334341

335342
<p>The format of the SetImageChannelDepth method is:</p>
336343

337-
<pre class="text">
338-
MagickBooleanType SetImageDepth(Image *image,const size_t depth)
344+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageDepth(Image *image,const size_t depth)
339345
MagickBooleanType SetImageChannelDepth(Image *image,
340346
const ChannelType channel,const size_t depth)
341-
</pre>
347+
</samp></pre>
342348

343349
<p>A description of each parameter follows:</p>
344350

@@ -368,9 +374,8 @@ <h2><a href="https://legacy.imagemagick.org/api/MagickCore/attribute_8c.html" id
368374

369375
<p>The format of the SetImageType method is:</p>
370376

371-
<pre class="text">
372-
MagickBooleanType SetImageType(Image *image,const ImageType type)
373-
</pre>
377+
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageType(Image *image,const ImageType type)
378+
</samp></pre>
374379

375380
<p>A description of each parameter follows:</p>
376381

0 commit comments

Comments
 (0)