Options

A class that wraps ImageInfo, DrawInfo and QuantizeInfo

class Options {
ImageInfo* imageInfo;
QuantizeInfo* quantizeInfo;
DrawInfo* drawInfo;
}

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

adjoin
void adjoin(bool flag)
bool adjoin()

Join images into a single multi-image file.

antialias
bool antialias()

Control antialiasing of rendered Postscript and Postscript or TrueType fonts. The default is true.

antialias
void antialias(bool antialias)

Control antialiasing of rendered Postscript and Postscript or TrueType fonts. The default is true.

backgroundColor
void backgroundColor(string color)
void backgroundColor(Color color)
Color backgroundColor()

Set the image background color. The default is "white".

backgroundTexture
void backgroundTexture(string str)
string backgroundTexture()

Set a texture to tile onto the image background. Corresponds to the -texture option to ImageMagick's convert and mogrify commands.

borderColor
void borderColor(string color)
void borderColor(Color color)
Color borderColor()

Set the image border color. The default is "#dfdfdf".

boxColor
Color boxColor()
void boxColor(Color color)

If set, causes the text to be drawn over a box of the specified color.

boxColor
void boxColor(string color)

If set, causes the text to be drawn over a box of the specified color.

colorspace
void colorspace(ColorspaceType space)
ColorspaceType colorspace()

Specifies the image pixel interpretation.

compression
void compression(CompressionType compress)
CompressionType compression()

Specifies the type of compression used when writing the image. Only some image formats support compression. For those that do, only some compression types are supported. If you specify an compression type that is not supported, the default compression type (usually NoCompression) is used instead.

define
void define(string format, string key, string value = "")

Define an option. Use this method to set options for reading or writing certain image formats. The list of supported options changes from release to release. For a list of the valid image formats, keys, and values, refer to the documentation for the -define option for the release of ImageMagick installed on your system.

density
void density(string str)
void density(Geometry geometry)
Geometry density()

Specifies the vertical and horizontal resolution in pixels. The default density is "72.0x72.0". This attribute can be used when writing JBIG, PCL, PS, PS2, and PS3 format images.

depth
void depth(size_t d)
size_t depth()

Specifies the image depth

dither
void dither(bool d)
size_t dither()

This attribute can be used when writing GIF images.

endian
void endian(EndianType type)
EndianType endian()

Specify the endianess of the image when reading the image file.

file
void file(FILE* f)
FILE* file()

Image file descriptor.

filename
void filename(string str)
string filename()

Image filename/path.

fillColor
Color fillColor()
void fillColor(Color color)

Color to use when filling drawn objects. The default is "black".

fillColor
void fillColor(string color)

Color to use when filling drawn objects. The default is "black".

fillPattern
const(dmagick.Image.Image) fillPattern()

Pattern image to use when filling drawn objects.

fillPattern
void fillPattern(dmagick.Image.Image pattern)

Pattern image to use when filling drawn objects.

fillRule
FillRule fillRule()

Rule to use when filling drawn objects.

fillRule
void fillRule(FillRule rule)

Rule to use when filling drawn objects.

font
void font(string str)
string font()

The font name or filename. You can tag a font to specify whether it is a Postscript, Truetype, or OPTION1 font. For example, Arial.ttf is a Truetype font, ps:helvetica is Postscript, and x:fixed is OPTION1.

fontFamily
string fontFamily()

Specify the font family, such as "arial" or "helvetica".

fontFamily
void fontFamily(string type)

Specify the font family, such as "arial" or "helvetica".

fontSize
void fontSize(double size)
double fontSize()

Text rendering font point size

fontStretch
StretchType fontStretch()

Specify the spacing between text characters.

fontStretch
void fontStretch(StretchType type)

Specify the spacing between text characters.

fontStyle
StyleType fontStyle()

Specify the font style, i.e. italic, oblique, or normal.

fontStyle
void fontStyle(StyleType type)

Specify the font style, i.e. italic, oblique, or normal.

fontWeight
size_t fontWeight()

Specify the font weight.

fontWeight
void fontWeight(size_t weight)

Specify the font weight.

fuzz
void fuzz(double f)
double fuzz()

Colors within this distance are considered equal. A number of algorithms search for a target color. By default the color must be exact. Use this option to match colors that are close to the target color in RGB space.

interlace
void interlace(InterlaceType type)
InterlaceType interlace()

Specify the _type of interlacing scheme for raw image formats such as RGB or YUV. NoInterlace means do not interlace, LineInterlace uses scanline interlacing, and PlaneInterlace uses plane interlacing. PartitionInterlace is like PlaneInterlace except the different planes are saved to individual files (e.g. image.R, image.G, and image.B). Use LineInterlace or PlaneInterlace to create an interlaced GIF or progressive JPEG image. The default is NoInterlace.

lineJoin
LineJoin lineJoin()

Specify how corners are drawn.

magick
void magick(string str)
string magick()

Image format (e.g. "GIF")

matteColor
void matteColor(string color)
void matteColor(Color color)
Color matteColor()

Set the image transparent color. The default is "#bdbdbd".

monochrome
void monochrome(bool m)
bool monochrome()

Transform the image to black and white on input. Only the EPT, PDF, and PS formats respect this attribute.

multiplyMatrix
AffineMatrix multiplyMatrix(AffineMatrix a, AffineMatrix b)

Returns the product of two Affine matrices The AffineMatrix looks like this:

page
void page(string str)
void page(Geometry geometry)
Geometry page()

Use this option to specify the dimensions and position of the Postscript page in dots per inch or in pixels. This option is typically used in concert with density.

quality
void quality(size_t q)
size_t quality()

The compression level for JPEG, MPEG, JPEG-2000, MIFF, MNG, and PNG image format. The default is 75

quantizeColorSpace
ColorspaceType quantizeColorSpace()

Colorspace to quantize colors in. Empirical evidence suggests that distances in color spaces such as YUV or YIQ 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. The default is RGB

quantizeColorSpace
void quantizeColorSpace(ColorspaceType type)

Colorspace to quantize colors in. Empirical evidence suggests that distances in color spaces such as YUV or YIQ 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. The default is RGB

quantizeColors
size_t quantizeColors()

Preferred number of _colors in the image. The actual number of _colors in the image may be less than your request, but never more. Images with less unique _colors than specified with this option will have any duplicate or unused _colors removed.

quantizeColors
void quantizeColors(size_t colors)

Preferred number of _colors in the image. The actual number of _colors in the image may be less than your request, but never more. Images with less unique _colors than specified with this option will have any duplicate or unused _colors removed.

quantizeDitherMethod
DitherMethod quantizeDitherMethod()

The basic strategy of dithering is to trade intensity resolution for spatial resolution by averaging the intensities of several neighboring pixels. Images which suffer from severe contouring when reducing colors can be improved with this option.

quantizeDitherMethod
void quantizeDitherMethod(DitherMethod method)

The basic strategy of dithering is to trade intensity resolution for spatial resolution by averaging the intensities of several neighboring pixels. Images which suffer from severe contouring when reducing colors can be improved with this option.

quantizeTreeDepth
void quantizeTreeDepth(size_t depth)
size_t quantizeTreeDepth()

Depth of the quantization color classification tree. Values of 0 or 1 allow selection of the optimal tree _depth for the color reduction algorithm. Values between 2 and 8 may be used to manually adjust the tree _depth.

resolutionUnits
ResolutionType resolutionUnits()

Units of image resolution.

resolutionUnits
void resolutionUnits(ResolutionType type)

Units of image resolution.

samplingFactor
string samplingFactor()

sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.

samplingFactor
void samplingFactor(string str)

sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.

size
Geometry size()
void size(Geometry geometry)

Set the width and height of the image when reading a built-in image format that does not have an inherent size, or when reading an image from a multi-resolution file format such as Photo CD, JBIG, or JPEG.

size
void size(string str)

Set the width and height of the image when reading a built-in image format that does not have an inherent size, or when reading an image from a multi-resolution file format such as Photo CD, JBIG, or JPEG.

strokeAntialias
void strokeAntialias(bool antialias)
bool strokeAntialias()

Enable or disable anti-aliasing when drawing object outlines.

strokeColor
void strokeColor(string color)
void strokeColor(Color color)
Color strokeColor()

Color to use when drawing object outlines.

strokeDashOffset
void strokeDashOffset(double offset)
double strokeDashOffset()

The initial distance into the dash pattern. The units are pixels.

strokeDashPattern
void strokeDashPattern(const(double)[] pattern)
double[] strokeDashPattern()

Describe a _pattern of dashes to be used when stroking paths. The arguments are a list of pixel widths of alternating dashes and gaps. All elements must be > 0.

strokeLineCap
void strokeLineCap(LineCap cap)
LineCap strokeLineCap()

Specify how the line ends should be drawn.

strokeLineJoin
void strokeLineJoin(LineJoin join)

Specify how corners are drawn.

strokeMiterlimit
void strokeMiterlimit(size_t limit)
size_t strokeMiterlimit()

Specify a constraint on the length of the "miter" formed by two lines meeting at an angle. If the angle if very sharp, the miter could be very long relative to the line thickness. The miter _limit is a _limit on the ratio of the miter length to the line width. The default is 4.

strokePattern
void strokePattern(dmagick.Image.Image pattern)
const(dmagick.Image.Image) strokePattern()

Pattern image to use while drawing object stroke

strokeWidth
void strokeWidth(double width)
double strokeWidth()

Stroke _width for use when drawing vector objects

subImage
size_t subImage()

Subimage of an image sequence

subImage
void subImage(size_t num)

Subimage of an image sequence

subRange
size_t subRange()

Number of images relative to the base image

subRange
void subRange(size_t num)

Number of images relative to the base image

textDensity
void textDensity(string str)
void textDensity(Geometry geometry)
Geometry textDensity()

The text density in the x and y directions. The default is "72x72".

textEncoding
void textEncoding(string str)
string textEncoding()

Specify the code set to use for text annotations. The only character encoding which may be specified at this time is "UTF-8" for representing Unicode as a sequence of bytes. Specify an empty string to use ASCII encoding. Successful text annotation using Unicode may require fonts designed to support Unicode. The default is "UTF-8"

transformOrigin
void transformOrigin(double tx, double ty)

Origin of coordinate system to use when annotating or drawing

transformReset
void transformReset()

Reset transformation parameters to default

transformRotation
void transformRotation(double angle)

Rotation to use when annotating or drawing

transformScale
void transformScale(double sx, double sy)

Scale to use when annotating or drawing

transformShearX
void transformShearX(double skewx)

Shear to use in X axis when annotating or drawing

transformShearY
void transformShearY(double skewy)

Shear to use in X axis when annotating or drawing

type
ImageType type()

Image type.

type
void type(ImageType t)

Image type.

undefine
void undefine(string format, string key)

Delete an option definition set by define. This is not the same as setting the option to a null value. The undefine method removes the option name from the list of options for the specified format. format = An image format name such as "ps" or "tiff". key = A string that identifies the option.

verbose
bool verbose()

Print detailed information about the image.

verbose
void verbose(bool v)

Print detailed information about the image.

view
string view()

FlashPix viewing parameters.

view
void view(string str)

FlashPix viewing parameters.

virtualPixelMethod
VirtualPixelMethod virtualPixelMethod()

Image virtual pixel _method.

virtualPixelMethod
void virtualPixelMethod(VirtualPixelMethod method)

Image virtual pixel _method.

x11Display
string x11Display()

X11 display to display to obtain fonts from or, to capture image from.

x11Display
void x11Display(string str)

X11 display to display to obtain fonts from or, to capture image from.

Meta