kmagick/com.cherryleafroad.kmagick/PixelWand

PixelWand

class PixelWand : Closeable

PixelWand API. Used for specifying certain colors.

Constructors

PixelWand

fun PixelWand()

Types

Companion

object Companion

Functions

clearException

external fun clearException()

Clear any internal exceptions

clone

fun clone(): PixelWand

Clone the wand into a new one.

open override fun close()

This isn't meant to be called manually. You can call destroy instead. This does the same thing as destroy, but it's here to be used with a use{} block for convenience. For example wand.use { }

destroy

external fun destroy()

It's recommended to manually destroy all wands when finished.

getException

external fun getException(): NativeMagickException

Get the internal exception type and message

getExceptionType

fun getExceptionType(): ExceptionType

Get the type of internal exception

isSimilar

external fun isSimilar(other: PixelWand, fuzz: Double): Boolean

Check if the distance between two colors is less than the specified distance.

isWand

external fun isWand(): Boolean

Check to see if this is still the correct wand.

Properties

alpha

var alpha: Double

The normalized alpha value of the PixelWand.

alphaQuantum

var alphaQuantum: Quantum

The alpha value of the PixelWand.

black

var black: Double

The normalized black color of the PixelWand.

blackQuantum

var blackQuantum: Quantum

The black color of the PixelWand.

blue

var blue: Double

The normalized blue color of the PixelWand.

blueQuantum

var blueQuantum: Quantum

The blue color of the PixelWand.

color

var color: String

The color of the PixelWand as a string.

colorCount

var colorCount: Long

The color count associated with this color.

cyan

var cyan: Double

The normalized cyan color of the PixelWand.

cyanQuantum

var cyanQuantum: Quantum

The cyan color of the PixelWand.

fuzz

var fuzz: Double

The fuzz value of the PixelWand.

green

var green: Double

The normalized green color of the PixelWand.

greenQuantum

var greenQuantum: Quantum

The green color of the PixelWand.

hsl

var hsl: HSL

The normalized HSL color of the PixelWand.

val id: ULong

The unique id of the wand.

index

var index: Quantum

The colormap index of the PixelWand.

isInitialized

val isInitialized: Boolean

Check to see if this is initialized with the underlying C obj.

magenta

var magenta: Double

The normalized magenta color of the PixelWand.

magentaQuantum

var magentaQuantum: Quantum

The magenta color of the PixelWand.

normalizedColor

val normalizedColor: String

The normalized color of the PixelWand as a string.

red

var red: Double

The normalized red color of the PixelWand.

redQuantum

var redQuantum: Quantum

The red color of the PixelWand.

yellow

var yellow: Double

The normalized yellow color of the PixelWand.

yellowQuantum

var yellowQuantum: Quantum

The yellow color of the PixelWand.