AwtImage

Instance Constructors

new AwtImage(awt: BufferedImage)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def argb: Array[Array[Int]]

Returns the ARGB components for all pixels in this image
Returns the ARGB components for all pixels in this image
returns
an array containing ARGB components in that order.
def argb(x: Int, y: Int): Array[Int]

Returns the ARGB components for the pixel at the given coordinates
Returns the ARGB components for the pixel at the given coordinates
x
the x coordinate of the pixel component to grab
y
the y coordinate of the pixel component to grab
returns
an array containing ARGB components in that order.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val awt: BufferedImage
lazy val center: (Int, Int)

The centre coordinates for the image as an (x, y) tuple.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def col(x: Int): Array[Pixel]

returns
the pixels for the column identified by the x co-ordinate. 0 indexed.
def color(x: Int, y: Int): RGBColor

Returns the color at the given coordinates.
Returns the color at the given coordinates.
returns
the RGBColor value at the coords
def colours: Set[RGBColor]

Returns a set of the distinct colours used in this image.
Returns a set of the distinct colours used in this image.
returns
the set of distinct Colors
def contains(color: Color): Boolean

Returns true if a pixel with the given color exists
Returns true if a pixel with the given color exists
color
the pixel colour to look for.
returns
true if there exists at least one pixel that has the given pixels color
def count(p: (Pixel) ⇒ Boolean): Int

Counts the number of pixels that are true for the given predicate
Counts the number of pixels that are true for the given predicate
p
a predicate
returns
the number of pixels that evaluated true
def count(color: Color): Int

Counts the number of pixels with the given colour.
Counts the number of pixels with the given colour.
color
the colour to detect.
returns
the number of pixels that matched the colour of the given pixel
lazy val count: Int

Returns the number of pixels in the image.
Returns the number of pixels in the image.
returns
the number of pixels
lazy val dimensions: (Int, Int)

A tuple of the (width, height)
def empty: AwtImage

Returns a new AWT BufferedImage with the same dimensions and same AWT type.
Returns a new AWT BufferedImage with the same dimensions and same AWT type. The data is uninitialized.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
AwtImage → AnyRef → Any
def exists(p: (Pixel) ⇒ Boolean): Boolean

Returns true if the predicate is true for at least one pixel on the image.
Returns true if the predicate is true for at least one pixel on the image.
p
a predicate
returns
true if p holds for at least one pixel
def fastScaleAwt(targetWidth: Int, targetHeight: Int): BufferedImage

Returns a new AWT Image scaled using nearest-neighbour.
Returns a new AWT Image scaled using nearest-neighbour.

Attributes
protected[com.sksamuel.scrimage]
def fastScaleScrimage(targetWidth: Int, targetHeight: Int): BufferedImage

Attributes
protected[com.sksamuel.scrimage]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forall(f: (Int, Int, Pixel) ⇒ Boolean): Boolean

Returns true if the predicate is true for all pixels in the image.
Returns true if the predicate is true for all pixels in the image.
f
a predicate function that accepts 3 parameters - the x,y coordinate and the pixel at that coordinate
returns
true if f holds for at least one pixel
def foreach(f: (Int, Int, Pixel) ⇒ Unit): Unit

Executes the given side effecting function on each pixel.
Executes the given side effecting function on each pixel.
f
a function that accepts 3 parameters - the x,y coordinate and the pixel at that coordinate
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AwtImage → AnyRef → Any
lazy val height: Int
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def iterator: Iterator[Pixel]

Returns the pixels of the image as an iterator.
Returns the pixels of the image as an iterator. The iterator is the most efficient way to lazily iterator over the pixels as the pixels will only be fetched from the raster as needed.
returns
the iterator
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def offset(x: Int, y: Int): Int
def patch(x: Int, y: Int, patchWidth: Int, patchHeight: Int): Array[Pixel]
def patches(patchWidth: Int, patchHeight: Int): IndexedSeq[() ⇒ Array[Pixel]]

Returns all the patches of a given size in the image, assuming pixel alignment (no subpixel extraction).
Returns all the patches of a given size in the image, assuming pixel alignment (no subpixel extraction).
The patches are returned as a sequence of pixel matrices closures
def pixel(p: (Int, Int)): Pixel

Returns the pixel at the given coordinate.
Returns the pixel at the given coordinate.
p
the pixel as an integer tuple
returns
the pixel
def pixel(x: Int, y: Int): Pixel

Returns the pixel at the given coordinates.
Returns the pixel at the given coordinates.
x
the x coordinate of the pixel to grab
y
the y coordinate of the pixel to grab
returns
the Pixel at the location
def pixels(x: Int, y: Int, w: Int, h: Int): Array[Pixel]

Returns a rectangular region within the given boundaries as a single dimensional array of integers.
Returns a rectangular region within the given boundaries as a single dimensional array of integers.
Eg, pixels(10, 10, 30, 20) would result in an array of size 600 with the first row of the region in indexes 0,..,29, second row 30,..,59 etc.
x
the start x coordinate
y
the start y coordinate
w
the width of the region
h
the height of the region
returns
an Array of pixels for the region
def pixels: Array[Pixel]

Returns all the pixels for the image
Returns all the pixels for the image
returns
an array of pixels for this image
lazy val points: Seq[(Int, Int)]
lazy val radius: Int

The radius of the image defined as the centre to the corners.
lazy val ratio: Double

returns
Returns the aspect ratio for this image.
def rgb: Array[Array[Int]]
def rgb(x: Int, y: Int): Array[Int]
def rotate(angle: Double): BufferedImage

Returns a new AWT Image rotated with the given angle (in degrees)
Returns a new AWT Image rotated with the given angle (in degrees)

Attributes
protected[com.sksamuel.scrimage]
def row(y: Int): Array[Pixel]

returns
the pixels in the row identified by the y coordinate. 0 indexed.
def scale(targetWidth: Int, targetHeight: Int, scale: Scale): BufferedImage

Attributes
protected[com.sksamuel.scrimage]
def subpixel(x: Double, y: Double): Int

Uses linear interpolation to get a sub-pixel.
Uses linear interpolation to get a sub-pixel.
Legal values for x and y are in [0, width) and [0, height), respectively.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toNewBufferedImage(type: Int = awt.getType): BufferedImage

Returns a new AWT BufferedImage from this image.
Returns a new AWT BufferedImage from this image.
type
the type of buffered image to create, if not specified then defaults to the current image type
returns
a new, non-shared, BufferedImage with the same data as this Image.
def toString(): String

Definition Classes
AwtImage → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
lazy val width: Int

Related Doc: package scrimage

class AwtImage extends AnyRef

Instance Constructors

new AwtImage(awt: BufferedImage)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def argb: Array[Array[Int]]

def argb(x: Int, y: Int): Array[Int]

final def asInstanceOf[T0]: T0

val awt: BufferedImage

lazy val center: (Int, Int)

def clone(): AnyRef

def col(x: Int): Array[Pixel]

def color(x: Int, y: Int): RGBColor

def colours: Set[RGBColor]

def contains(color: Color): Boolean

def count(p: (Pixel) ⇒ Boolean): Int

def count(color: Color): Int

lazy val count: Int

lazy val dimensions: (Int, Int)

def empty: AwtImage

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def exists(p: (Pixel) ⇒ Boolean): Boolean

def fastScaleAwt(targetWidth: Int, targetHeight: Int): BufferedImage

def fastScaleScrimage(targetWidth: Int, targetHeight: Int): BufferedImage

def finalize(): Unit

def forall(f: (Int, Int, Pixel) ⇒ Boolean): Boolean

def foreach(f: (Int, Int, Pixel) ⇒ Unit): Unit

final def getClass(): Class[_]

def hashCode(): Int

lazy val height: Int

final def isInstanceOf[T0]: Boolean

def iterator: Iterator[Pixel]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def offset(x: Int, y: Int): Int

def patch(x: Int, y: Int, patchWidth: Int, patchHeight: Int): Array[Pixel]

def patches(patchWidth: Int, patchHeight: Int): IndexedSeq[() ⇒ Array[Pixel]]

def pixel(p: (Int, Int)): Pixel

def pixel(x: Int, y: Int): Pixel

def pixels(x: Int, y: Int, w: Int, h: Int): Array[Pixel]

def pixels: Array[Pixel]

lazy val points: Seq[(Int, Int)]

lazy val radius: Int

lazy val ratio: Double

def rgb: Array[Array[Int]]

def rgb(x: Int, y: Int): Array[Int]

def rotate(angle: Double): BufferedImage

def row(y: Int): Array[Pixel]

def scale(targetWidth: Int, targetHeight: Int, scale: Scale): BufferedImage

def subpixel(x: Double, y: Double): Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toNewBufferedImage(type: Int = awt.getType): BufferedImage

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

lazy val width: Int

Inherited from AnyRef

Inherited from Any

Ungrouped