/
constants.html
1231 lines (793 loc) · 31.1 KB
/
constants.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" />
<title>RMagick: Constants</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2006 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js">
</script>
<style type="text/css">
/*<![CDATA[*/
/* Styles local to this page. */
dl, p {
margin-left: 100px;
margin-right:100px;
}
dt {
font-family: monospace;
}
/*
* Deliberately similar styling to the .sig h3
*/
h3.const {
background-color: #c0c0c0;
color: #000;
padding-left: 5px;
margin-top: 2em;
}
/*
* Modify .simple_table for the MaxRGB/QuantumDepth table.
* The major differences are the centered text and the auto width.
*/
#maxrgb {
border-collapse: collapse;
border: thin solid black;
background-color: #f8f8f8;
margin-top: 1em;
margin-right: auto;
margin-bottom: 1em;
margin-left: auto;
text-align: center;
width: auto;
}
#maxrgb caption {
font-weight: bold;
}
/*]]>*/
</style>
</head>
<body>
<h6 id="header">RMagick User's Guide and Reference</h6>
<div class="nav">
« <a href="info.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"rvgtut.html">Next</a> »
</div>
<h1>Constants</h1>
<div id="toc">
<h2>Table of Contents</h2>
<h3>Constants</h3>
<div class="toccol">
<ul>
<li><a href="#Miscellaneous_constants">Miscellaneous
constants</a></li>
<li><a href="#AlignType">AlignType</a></li>
<li><a href="#ChannelType">ChannelType</a></li>
<li><a href="#ClassType">ClassType</a></li>
<li><a href="#ColorspaceType">ColorspaceType</a></li>
<li><a href="#ComplianceType">ComplianceType</a></li>
<li><a href="#CompositeOperator">CompositeOperator</a></li>
<li><a href="#CompressionType">CompressionType</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#DecorationType">DecorationType</a></li>
<li><a href="#DisposeType">DisposeType</a></li>
<li><a href="#EndianType">EndianType</a></li>
<li><a href="#FilterTypes">FilterTypes</a></li>
<li><a href="#GravityType">GravityType</a></li>
<li><a href="#ImageType">ImageType</a></li>
<li><a href="#InterlaceType">InterlaceType</a></li>
<li><a href="#MetricType">MetricType</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#NoiseType">NoiseType</a></li>
<li><a href="#Opacity">Opacity</a></li>
<li><a href="#PaintMethod">PaintMethod</a></li>
<li><a href="#RenderingIntent">RenderingIntent</a></li>
<li><a href="#ResolutionType">ResolutionType</a></li>
<li><a href="#StretchType">StretchType</a></li>
<li><a href="#StyleType">StyleType</a></li>
<li><a href="#WeightType">WeightType</a></li>
</ul>
</div>
</div>
<h2 class="methods">Constants</h2>
<h3 class="const" style="margin-top:0" id=
"Miscellaneous_constants">Miscellaneous constants</h3>
<dl>
<dt>Long_version</dt>
<dd>An extended form of the <code>Version</code> constant with
the format shown here:<br />
<code>This is RMagick 1.4.0 ($Date: 2006/01/03 17:17:12 $)
Copyright (C) 2005 by Timothy P. Hunter<br />
Built with ImageMagick 6.0.0 02/25/04 Q8
http://www.imagemagick.org<br />
Built for ruby 1.8.1 (2003-12-25) [i686-linux]<br />
Web page: http://rmagick.rubyforge.org<br />
Email: rmagick@rubyforge.org</code></dd>
<dt>MagickVersion</dt>
<dd>The ×Magick version string. This has the form:<br />
<code>@(#)ImageMagick X.Y.Z MM/DD/YY Q:16
http://www.imagemagick.org</code><br />
or<br />
<code>GraphicsMagick 1.0 05/05/03 Q8
http://www.GraphicsMagick.org/</code></dd>
<dt>MaxRGB</dt>
<dd>The maximum value of a <em>Quantum</em>. A quantum is one
of the red, green, blue, or opacity elements of a pixel in the
RGB colorspace, or cyan, yellow, magenta, or black elements in
the CYMK colorspace.</dd>
<dt>QuantumDepth</dt>
<dd>
The number of bits in a quantum. The relationship between
QuantumDepth and MaxRGB is summarized in this table.
<table summary="number of bits in a quantum" id="maxrgb">
<caption>
How MaxRGB and QuantumDepth are related
</caption>
<tr>
<th>QuantumDepth</th>
<th>MaxRGB</th>
</tr>
<tr>
<td>8</td>
<td>255</td>
</tr>
<tr>
<td>16</td>
<td>65535</td>
</tr>
<tr>
<td>32</td>
<td>4294967295</td>
</tr>
</table>
</dd>
<dt>Version</dt>
<dd>The RMagick version string. This has the form:<br />
<code>RMagick major.minor.teeny</code></dd>
</dl>
<h3 class="const" id="AlignType">AlignType</h3>
<p>Specify text alignment. See <a href=
"draw.html#Draw.align_eq">align=</a>, <a href=
"draw.html#Draw.text_align">text_align</a>.</p>
<dl>
<dt>UndefinedAlign</dt>
<dt>LeftAlign</dt>
<dt>CenterAlign</dt>
<dt>RightAlign</dt>
</dl>
<h3 class="const" id="ChannelType">ChannelType</h3>
<p>Specify an image channel. See <a href=
"image1.html#channel">channel</a>.</p>
<dl>
<dt>UndefinedChannel</dt>
<dt>RedChannel</dt>
<dt>GreenChannel</dt>
<dt>BlueChannel</dt>
<dt>CyanChannel</dt>
<dt>MagentaChannel</dt>
<dt>YellowChannel</dt>
<dt>BlackChannel</dt>
<dt>OpacityChannel</dt>
<dt>AllChannels</dt>
<dt>GrayChannel</dt>
</dl>
<h3 class="const" id="ClassType">ClassType</h3>
<p>Specify the image storage class. See <a href=
"imageattrs.html#class_type">class_type</a>.</p>
<dl>
<dt>UndefinedClass</dt>
<dd>No storage class has been specified.</dd>
<dt>DirectClass</dt>
<dd class="imquote">Image is composed of pixels which represent
literal color values.</dd>
<dt>PseudoClass</dt>
<dd class="imquote">Image is composed of pixels which specify
an index in a color palette.</dd>
</dl>
<h3 class="const" id="ColorspaceType">ColorspaceType</h3>
<p class="imquote">Specify the colorspace that quantization
(color reduction and mapping) is done under or to specify the
colorspace when encoding an output image. Colorspaces are ways of
describing colors to fit the requirements of a particular
application (e.g. Television, offset printing, color
monitors). Color reduction, by default, takes place in the
RGBColorspace. Empirical evidence suggests that distances in
color spaces such as YUVColorspace or YIQColorspace correspond to
perceptual color differences more closely than do distances in
RGB space. These color spaces may give better results when color
reducing an image.</p>
<p><span class="imquote">When encoding an output image, the
colorspaces RGBColorspace, CMYKColorspace, and GRAYColorspace may
be specified. The CMYKColorspace option is only applicable when
writing TIFF, JPEG, and Adobe Photoshop bitmap (PSD)
files.</span> See <a href=
"imageattrs.html#colorspace">colorspace</a>.</p>
<dl>
<dt>UndefinedColorspace</dt>
<dd>No colorspace has been specified.</dd>
<dt>RGBColorspace</dt>
<dd class="imquote">Red-Green-Blue colorspace</dd>
<dt>GRAYColorspace</dt>
<dd> </dd>
<dt>TransparentColorspace</dt>
<dd class="imquote">The Transparent color space behaves
uniquely in that it preserves the matte channel of the image if
it exists.</dd>
<dt>OHTAColorspace</dt>
<dd> </dd>
<dt>XYZColorspace</dt>
<dd> </dd>
<dt>YCbCrColorspace</dt>
<dd> </dd>
<dt>YIQColorspace</dt>
<dd> </dd>
<dt>YPbPrColorspace</dt>
<dd> </dd>
<dt>YUVColorspace</dt>
<dd class="imquote">Y-signal, U-signal, and V-signal
colorspace. YUV is most widely used to encode color for use in
television transmission.</dd>
<dt>CMYKColorspace</dt>
<dd class="imquote">Cyan-Magenta-Yellow-Black colorspace. CYMK
is a subtractive color system used by printers and
photographers for the rendering of colors with ink or emulsion,
normally on a white surface.</dd>
<dt>SRGBColorspace</dt>
<dd>In ×Magick, this constant is named sRGBColorspace,
but since Ruby constants must start with an uppercase letter, I
had to change it.</dd>
<dt>HSLColorspace</dt>
<dd>Available in ImageMagick 5.5.7.</dd>
<dt>HWBColorspace</dt>
<dd>Available in ImageMagick 5.5.7.</dd>
</dl>
<h3 class="const" id="ComplianceType">ComplianceType</h3>
<p>Specify the color standard from which color names are chosen.
See <a href="struct.html#Pixel">to_color</a>.</p>
<dl>
<dt>SVGCompliance</dt>
<dd>Adhere to SVG color standard.</dd>
<dt>X11Compliance</dt>
<dd>Adhere to X11 color standard.</dd>
<dt>XPMCompliance</dt>
<dd>Adhere to XPM color standard.</dd>
<dt>AllCompliance</dt>
<dd>The union of the 3 color standards.</dd>
</dl>
<h3 class="const" id="CompositeOperator">CompositeOperator</h3>
<p><span class="imquote">Select the image composition algorithm
used to compose a <code>composite image</code> with a
<code>image</code>. By default, each of the <code>composite
image</code> pixels are replaced by the corresponding
<code>image</code> tile pixel. Specify
<code>CompositeOperator</code> to select a different
algorithm.</span> See <a href=
"image1.html#composite">composite</a>.</p>
<dl>
<dt>UndefinedCompositeOp</dt>
<dd>No composite operator has been specified.</dd>
<dt>OverCompositeOp</dt>
<dd><span class="imquote">The result is the union of the the
two image shapes with <code>composite image</code> obscuring
<code>image</code> in the region of overlap.</span> The matte
channel of the composite image is respected, so that if the
composite pixel is part or all transparent, the corresponding
image pixel will show through.</dd>
<dt>InCompositeOp</dt>
<dd class="imquote">The result is simply <code>composite
image</code> cut by the shape of <code>image</code>. None of
the image data of <code>image</code> is included in the
result.</dd>
<dt>OutCompositeOp</dt>
<dd class="imquote">The resulting image is <code>composite
image</code> with the shape of <code>image</code> cut out.</dd>
<dt>AtopCompositeOp</dt>
<dd class="imquote">The result is the same shape as
<code>image</code>, with <code>composite image</code> obscuring
<code>image</code> where the image shapes overlap. Note that
this differs from OverCompositeOp because the portion of
<code>composite image</code> outside of <code>image</code>'s
shape does not appear in the result.</dd>
<dt>XorCompositeOp</dt>
<dd class="imquote">The result is the image data from both
<code>composite image</code> and <code>image</code> that is
outside the overlap region. The overlap region will be
blank.</dd>
<dt>PlusCompositeOp</dt>
<dd class="imquote">The result is just the sum of
the image data. Output values are cropped to 255 (no
overflow). This operation is independent of the matte
channels.</dd>
<dt>MinusCompositeOp</dt>
<dd class="imquote">The result of composite image - image, with
overflow cropped to zero. The matte chanel is ignored (set to
255, full coverage).</dd>
<dt>AddCompositeOp</dt>
<dd class="imquote">The result of <code>composite image</code>
+ <code>image</code>, with overflow wrapping around (mod
256).</dd>
<dt>SubtractCompositeOp</dt>
<dd class="imquote">The result of <code>composite image</code>
- <code>image</code>, with underflow wrapping around (mod 256).
The add and subtract operators can be used to perform
reversable transformations.</dd>
<dt>DifferenceCompositeOp</dt>
<dd class="imquote">The result of abs(<code>composite
image</code> - <code>image</code>). This is useful for
comparing two very similar images.</dd>
<dt>MultiplyCompositeOp</dt>
<dd class="imquote">Multiplies the color of each target image
pixel by the color of the corresponding composite image pixel.
The result color is always darker.</dd>
<dt>BumpmapCompositeOp</dt>
<dd class="imquote">The result <code>image</code> shaded by
<code>composite image</code>.</dd>
<dt>ReplaceCompositeOp</dt>
<dd class="imquote">The resulting image is image replaced with
composite image. Here the matte information is ignored.
Available in ImageMagick 6.0.0.</dd>
<dt>CopyCompositeOp</dt>
<dd>Replace the target image with the composite image.</dd>
<dt>CopyRedCompositeOp</dt>
<dd>Copy the red channel from the composite image to the target
image.</dd>
<dt>CopyGreenCompositeOp</dt>
<dd>Copy the green channel from the composite image to the
target image.</dd>
<dt>CopyBlueCompositeOp</dt>
<dd>Copy the blue channel from the composite image to the
target image.</dd>
<dt>CopyOpacityCompositeOp</dt>
<dd>If the composite image's <a href=
"imageattrs.html#matte">matte</a> attribute is
<code>true</code>, copy the opacity channel from the composite
image to the target image. Otherwise, set the target image
pixel's opacity to the intensity of the corresponding pixel in
the composite image.</dd>
<dt>ClearCompositeOp</dt>
<dd>Make the target image transparent. The composite image is
ignored.</dd>
<dt>DissolveCompositeOp</dt>
<dd> </dd>
<dt>DisplaceCompositeOp</dt>
<dd>Displace target image pixels as defined by a displacement
map. The amount of displacement can be controlled via the
<a href="imageattrs.html#geometry">geometry</a> attribute of
the composite image. The default is "20x20".</dd>
<dt>ModulateCompositeOp</dt>
<dd> </dd>
<dt>ThresholdCompositeOp</dt>
<dd> </dd>
<dt>NoCompositeOp</dt>
<dd> </dd>
<dt>DarkenCompositeOp</dt>
<dd>Replace target image pixels with darker pixels from the
composite image.</dd>
<dt>LightenCompositeOp</dt>
<dd>Replace target image pixels with lighter pixels from the
composite image.</dd>
<dt>HueCompositeOp</dt>
<dd>Each pixel in the result image is the combination of the
hue of the target image and the saturation and brightness of
the composite image.</dd>
<dt>SaturateCompositeOp</dt>
<dd>Each pixel in the result image is the combination of the
saturation of the target image and the hue and brightness of
the composite image.</dd>
<dt>ColorizeCompositeOp</dt>
<dd>Each pixel in the result image is the combination of the
brightness of the target image and the saturation and hue of
the composite image. This is the <em>opposite</em> of
LuminizeCompositeOp.</dd>
<dt>LuminizeCompositeOp</dt>
<dd>Each pixel in the result image is the combination of the
brightness of the composite image and the saturation and hue of
the target image. This is the <em>opposite</em> of
ColorizeCompositeOp.</dd>
<dt>ScreenCompositeOp</dt>
<dd>Multiplies the inverse of each image's color
information.</dd>
<dt>OverlayCompositeOp</dt>
<dd> </dd>
<dt>CopyCyanCompositeOp</dt>
<dd>Copy the cyan channel from the composite image to the
target image. Available in ImageMagick 5.5.7.</dd>
<dt>CopyMagentaCompositeOp</dt>
<dd>Copy the magenta channel from the composite image to the
target image. Available in ImageMagick 5.5.7.</dd>
<dt>CopyYellowCompositeOp</dt>
<dd>Copy the yellow channel from the composite image to the
target image. Available in ImageMagick 5.5.7.</dd>
<dt>CopyBlackCompositeOp</dt>
<dd>Copy the black channel from the composite image to the
target image. Available in ImageMagick 5.5.7.</dd>
<dt>DstAtopCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>DstCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>DstInCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>DstOutCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>DstOverCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SrcAtopCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SrcCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SrcInCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SrcOutCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SrcOverCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>ColorDodgeCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>ExclusionCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>HardLightCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
<dt>SoftLightCompositeOp</dt>
<dd>Available in ImageMagick 6.0.0</dd>
</dl>
<h3 class="const" id="CompressionType">CompressionType</h3>
<p><span class="imquote">Express the desired compression type
when encoding an image. Be aware that most image types only
support a sub-set of the available compression types. If the
compression type specified is incompatable with the image,
×Magick selects a compression type compatable with the
image type.</span> See <a href=
"imageattrs.html#compression">compression</a>.</p>
<dl>
<dt>UndefinedCompression</dt>
<dd>No compression type has been specified.</dd>
<dt>NoCompression</dt>
<dd>The default for most formats.</dd>
<dt>BZipCompression</dt>
<dd class="imquote">BZip (Burrows-Wheeler block-sorting text
compression algorithm and Huffman coding) as used by
bzip2 utilities</dd>
<dt>FaxCompression</dt>
<dd class="imquote">CCITT Group 3 FAX compression</dd>
<dt>Group4Compression</dt>
<dd class="imquote">CCITT Group 4 FAX compression (used only
for TIFF)</dd>
<dt>JPEGCompression</dt>
<dd>JPEG compression. See <a href=
"http://www.faqs.org/faqs/jpeg-faq/part1/">The JPEG image
compression FAQ</a>.</dd>
<dt>JPEG2000Compression</dt>
<dd>JPEG2000 compression for compressed PDF images. (Introduced
in ImageMagick 6.2.2.)</dd>
<dt>LosslessJPEGCompression</dt>
<dd>This compression format is almost never used.</dd>
<dt>LZWCompression</dt>
<dd class="imquote">Lempel-Ziv-Welch (LZW) compression</dd>
<dt>RLECompression</dt>
<dd>See the Wikipedia page for <a href=
"http://en.wikipedia.org/wiki/Run_length_encoding">Run-length
encoding</a>.</dd>
<dt>ZipCompression</dt>
<dd class="imquote">Lempel-Ziv compression (LZ77) as used in
PKZIP and GNU gzip.</dd>
</dl>
<h3 class="const" id="DecorationType">DecorationType</h3>
<p>Use with the <a href="draw.html#decorate">decorate=</a> method
in the Draw class to specify the text decoration for the <a href=
"draw.html#annotate">annotate</a> method.</p>
<dl>
<dt>NoDecoration</dt>
<dd>Don't decorate the text.</dd>
<dt>UnderlineDecoration</dt>
<dd>Underline the text.</dd>
<dt>OverlineDecoration</dt>
<dd>Overline the text.</dd>
<dt>LineThroughDecoration</dt>
<dd>Draw a horizontal line through the middle of the text.</dd>
</dl>
<h3 class="const" id="DisposeType">DisposeType</h3>
<p>The value of the <a href="imageattrs.html#dispose">dispose</a>
attribute.</p>
<dl>
<dt>UndefinedDispose</dt>
<dd>No disposal specified.</dd>
<dt>NoneDispose</dt>
<dd>Do not dispose between frames.</dd>
<dt>BackgroundDispose</dt>
<dd>Overwrite the image area with the background color.</dd>
<dt>PreviousDispose</dt>
<dd>Overwrite the image area with what was there prior to
rendering the image.</dd>
</dl>
<h3 class="const" id="EndianType">EndianType</h3>
<p>The value of the <a href="imageattrs.html#endian">endian</a>
attribute.</p>
<dl>
<dt>UndefinedEndian</dt>
<dt>LSBEndian</dt>
<dt>MSBEndian</dt>
</dl>
<h3 class="const" id="FilterTypes">FilterTypes</h3>
<p><span class="imquote">Used to adjust the filter algorithm used
when resizing images. Different filters experience varying
degrees of success with various images and can take sigificantly
different amounts of processing time. ×Magick uses the
LanczosFilter by default since this filter has been shown to
provide the best results for most images in a reasonable amount
of time. Other filter types (e.g. TriangleFilter) may execute
much faster but may show artifacts when the image is re-sized or
around diagonal lines. The only way to be sure is to test the
filter with sample images.</span> See <a href=
"image3.html#resize">resize</a>.</p>
<dl>
<dt>UndefinedFilter</dt>
<dt>PointFilter</dt>
<dt>BoxFilter</dt>
<dt>TriangleFilter</dt>
<dt>HermiteFilter</dt>
<dt>HanningFilter</dt>
<dt>HammingFilter</dt>
<dt>BlackmanFilter</dt>
<dt>GaussianFilter</dt>
<dt>QuadraticFilter</dt>
<dt>CubicFilter</dt>
<dt>CatromFilter</dt>
<dt>MitchellFilter</dt>
<dt>LanczosFilter</dt>
<dt>BesselFilter</dt>
<dt>SincFilter</dt>
</dl>
<h3 class="const" id="GravityType">GravityType</h3>
<p><span class="imquote">Specify positioning of an object (e.g.
text, image) within a bounding region (e.g. an image). Gravity
provides a convenient way to locate objects irrespective of the
size of the bounding region, in other words, you don't need to
provide absolute coordinates in order to position an object. A
common default for gravity is <em>NorthWestGravity</em>.</span>
See <a href="draw.html#annotate">annotate</a> and <a href=
"image1.html#composite">composite</a>.</p>
<dl>
<dt>ForgetGravity</dt>
<dd class="imquote">Don't use gravity.</dd>
<dt>NorthWestGravity</dt>
<dd class="imquote">Position object at top-left of region</dd>
<dt>NorthGravity</dt>
<dd class="imquote">Postiion object at top-center of
region</dd>
<dt>NorthEastGravity</dt>
<dd class="imquote">Position object at top-right of region</dd>
<dt>WestGravity</dt>
<dd class="imquote">Position object at left-center of
region</dd>
<dt>CenterGravity</dt>
<dd class="imquote">Position object at center of region</dd>
<dt>EastGravity</dt>
<dd class="imquote">Position object at right-center of
region</dd>
<dt>SouthWestGravity</dt>
<dd class="imquote">Position object at left-bottom of
region</dd>
<dt>SouthGravity</dt>
<dd class="imquote">Position object at bottom-center of
region</dd>
<dt>SouthEastGravity</dt>
<dd class="imquote">Position object at bottom-right of
region</dd>
</dl>
<h3 class="const" id="ImageType">ImageType</h3>
<p>Indicate <span class="imquote">the type classification of the
image.</span> See <a href=
"imageattrs.html#image_type">image_type</a> and <a href=
"info.html#image_type_eq">image_type=</a>.</p>
<dl>
<dt>UndefinedType</dt>
<dd>No type has been specified.</dd>
<dt>BilevelType</dt>
<dd class="imquote">Monochrome image</dd>
<dt>GrayscaleType</dt>
<dd class="imquote">Grayscale image</dd>
<dt>PaletteType</dt>
<dd class="imquote">Indexed color (palette) image</dd>
<dt>PaletteMatteType</dt>
<dd class="imquote">Indexed color (palette) image with
opacity</dd>
<dt>TrueColorType</dt>
<dd class="imquote">Truecolor image</dd>
<dt>TrueColorMatteTypeType</dt>
<dd class="imquote">Truecolor image with opacity</dd>
<dt>ColorSeparationType</dt>
<dd class="imquote">Cyan/Yellow/Magenta/Black (CYMK) image</dd>
<dt>ColorSeparationMatteType</dt>
<dd> </dd>
<dt>OptimizeType</dt>
<dd> </dd>
</dl>
<h3 class="const" id="InterlaceType">InterlaceType</h3>
<p>Specify <span class="imquote">the ordering of the red, green,
and blue pixel information in the image. Interlacing is usually
used to make image information available to the user faster by
taking advantage of the space vs time tradeoff. For example,
interlacing allows images on the Web to be recognizable sooner
and satellite images to accumulate/render with image resolution
increasing over time. Use <code>LineInterlace</code> or
<code>PlaneInterlace</code> to create an interlaced GIF or
progressive JPEG image.</span> See <a href=
"imageattrs.html#interlace">interlace</a>.</p>
<dl>
<dt>UndefinedInterlace</dt>
<dd>No interlace type has been specified.</dd>
<dt>NoInterlace</dt>
<dd class="imquote">Don't interlace image
(RGBRGBRGBRGBRGBRGB...)</dd>
<dt>LineInterlace</dt>
<dd class="imquote">Use scanline interlacing
(RRR...GGG...BBB...RRR...GGG...BBB...)</dd>
<dt>PlaneInterlace</dt>
<dd class="imquote">Use plane interlacing
(RRRRRR...GGGGGG...BBBBBB...)</dd>
<dt>PartitionInterlace</dt>
<dd class="imquote">Similar to plane interlacing except that
the different planes are saved to individual files (e.g.
image.R, image.G, and image.B)</dd>
</dl>
<h3 class="const" id="MetricType">MetricType</h3>
<p>The distortion metric type. See <a href=