Package com.cherryleafroad.kmagick

Types

Link copied to clipboard
enum AlignType : Enum<AlignType>
Link copied to clipboard
enum AlphaChannelOption : Enum<AlphaChannelOption>

Gives control of the alpha/matte channel of an image.

Link copied to clipboard
enum ChannelType : Enum<ChannelType>

ChannelType is used as an argument when doing color separations. Use ChannelType when extracting a layer from an image. MatteChannel is useful for extracting the opacity values from an image. Note that an image may be represented in RGB, RGBA, CMYK, or CMYKA, pixel formats and a channel may only be extracted if it is valid for the current pixel format.

Link copied to clipboard
enum ClipPathUnits : Enum<ClipPathUnits>
Link copied to clipboard
enum ColorspaceType : Enum<ColorspaceType>

The ColorspaceType enumeration is used to 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 han do distances in RGB space. These color spaces may give better results when color reducing an image. Refer to quantize for more details.

Link copied to clipboard
data class Comparison(distortion: Double, diffImage: MagickWand?)

Holds the result of a comparison between 2 images using MagickWand.compareImages()

Link copied to clipboard
enum CompositeOperator : Enum<CompositeOperator>

CompositeOperator is used to select the image composition algorithm used to compose a composite image with an image. By default, each of the composite image pixels are replaced by the corresponding image tile pixel. Specify CompositeOperator to select a different algorithm.

Link copied to clipboard
enum CompressionType : Enum<CompressionType>

CompressionType is used to 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, ImageMagick selects a compression type compatable with the image type.

Link copied to clipboard
enum DecorationType : Enum<DecorationType>

The DecorationType enumerations are used to specify line decorations of rendered text.

Link copied to clipboard
enum DirectionType : Enum<DirectionType>
Link copied to clipboard
enum DisposeType : Enum<DisposeType>

Define the GIF disposal image setting for images that are being created or read in.

Link copied to clipboard
enum DitherMethod : Enum<DitherMethod>

Apply a Riemersma or Floyd-Steinberg error diffusion dither to images when general color reduction is applied via an option, or automagically when saving to specific formats. This enabled by default.

Link copied to clipboard
class DrawingWand : Closeable

DrawingWand API. For drawing things on the image (such as text).

Link copied to clipboard
class DrawingWandException(message: String) : MagickException

The exception that all DrawingWand's throw if there's an error.

Link copied to clipboard
enum EndianType : Enum<EndianType>

The EndianType enumerations are used to specify the endian option for formats which support it (e.g. TIFF).

Link copied to clipboard
enum EvaluateOperator : Enum<EvaluateOperator>
Link copied to clipboard
enum ExceptionType : Enum<ExceptionType>

Represents an internal imagemagick exception type.

Link copied to clipboard
enum FillRule : Enum<FillRule>

FillRule specifies the algorithm which is to be used to determine what parts of the canvas are included inside the shape. See the documentation on SVG's fill-rule property for usage details.

Link copied to clipboard
enum FilterType : Enum<FilterType>

FilterTypes are used to adjust the filter algorithm used when resizing images. Different filters experience varying degrees of success with various images and can take sipngicantly different amounts of processing time. ImageMagick 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.

Link copied to clipboard
enum GravityType : Enum<GravityType>

GravityType specifies 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 NorthWestGravity.

Link copied to clipboard
data class HSL(hue: Double, saturation: Double, lightness: Double)

Represents a hue, saturation, and lightness values

Link copied to clipboard
enum ImageType : Enum<ImageType>

ImageType indicates the type classification of the image.

Link copied to clipboard
enum InterlaceType : Enum<InterlaceType>

InterlaceType specifies 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.

Link copied to clipboard
enum LineCap : Enum<LineCap>

The LineCap enumerations specify shape to be used at the end of open subpaths when they are stroked. See SVG's 'stroke-linecap' for examples.

Link copied to clipboard
enum LineJoin : Enum<LineJoin>

The LineJoin enumerations specify the shape to be used at the corners of paths or basic shapes when they are stroked. See SVG's 'stroke-linejoin' for examples.

Link copied to clipboard
enum LogLevel : Enum<LogLevel>

The internal log level.

Link copied to clipboard
object Magick : Closeable
Link copied to clipboard
open class MagickException(message: String) : Exception

The base exception class for all imagemagick exceptions.

Link copied to clipboard
class MagickWand : Closeable

MagickWand API. Used to hold the images as well as operate on them.

Link copied to clipboard
class MagickWandException(message: String) : MagickException

The exception that all MagickWand's throw if there's an error.

Link copied to clipboard
enum MetricType : Enum<MetricType>

A measure of the differences between images according to the type given metric.

Link copied to clipboard
data class NativeMagickException(exceptionType: ExceptionType, message: String)

NativeMagickException holds an exception produced internally by ImageMagick.

Link copied to clipboard
enum OrientationType : Enum<OrientationType>

OrientationType specifies the orientation of the image. Useful for when the image is produced via a different ordinate system, the camera was turned on its side, or the page was scanned sideways.

Link copied to clipboard
data class PageGeometry(width: Long, height: Long, x: Long, y: Long)

Retrieve the page geometry (width, height, x offset, y offset) of the image.

Link copied to clipboard
enum PixelInterpolateMethod : Enum<PixelInterpolateMethod>

Set the pixel color interpolation method to use when looking up a color based on a floating point or real value.

Link copied to clipboard
class PixelWand : Closeable

PixelWand API. Used for specifying certain colors.

Link copied to clipboard
class PixelWandException(message: String) : MagickException

The exception that all PixelWand's throw if there's an error.

Link copied to clipboard
typealias Quantum = Float
Link copied to clipboard
enum RenderingIntent : Enum<RenderingIntent>

Rendering intent is a concept defined by ICC Spec ICC.1:1998-09, "File Format for Color Profiles". ImageMagick uses RenderingIntent in order to support ICC Color Profiles.

Link copied to clipboard
data class Resolution(x: Double, y: Double)

The image (horizontal) x-resolution and the image (vertical) y-resolution.

Link copied to clipboard
enum ResolutionType : Enum<ResolutionType>

By default, ImageMagick defines resolutions in pixels per inch. ResolutionType provides a means to adjust this.

Link copied to clipboard
enum ResourceType : Enum<ResourceType>

Useful for dynamically reducing system resources before attempting risky, or slow running, Image operations.

Link copied to clipboard
enum StretchType : Enum<StretchType>

The StretchType enumerations are used to specify the relative width of a font to the regular width for the font family. If the width is not important, the AnyStretch enumeration may be specified for a wildcard match.

Link copied to clipboard
enum StyleType : Enum<StyleType>

The StyleType enumerations are used to specify the style (e.g. Italic) of a font. If the style is not important, the AnyStyle enumeration may be specified for a wildcard match.

Link copied to clipboard
enum WandType : Enum<WandType>

The wand type