ImageLike

Abstract Value Members

abstract def copy: Image

Creates a new image with the same data as this image.
Creates a new image with the same data as this image. Any operations to the copied image will not write back to the original. Images can be copied multiple times as well as copies copied etc.
returns
A copy of this image.
abstract def empty: Image

Creates an empty Image with the same dimensions of this image.
Creates an empty Image with the same dimensions of this image.
returns
a new Image that is a clone of this image but with uninitialized data
abstract def filter(filter: Filter): R

Creates a copy of this image with the given filter applied.
Creates a copy of this image with the given filter applied. The original (this) image is unchanged.
filter
the filter to apply. See com.sksamuel.scrimage.Filter.
returns
A new image with the given filter applied.
abstract def fit(targetWidth: Int, targetHeight: Int, color: Color, scaleMethod: ScaleMethod, position: Position): R
abstract def height: Int
abstract def map(f: (Int, Int, Int) ⇒ Int): R

Maps the pixels of this image into another image by applying the given function to each point.
Maps the pixels of this image into another image by applying the given function to each point.
The function accepts three parameters: x,y,p where x and y are the coordinates of the pixel being transformed and p is the current pixel value in ABGR format.
f
the function to transform pixel x,y with existing value p into new pixel value p' (p prime)
returns
abstract def padTo(targetWidth: Int, targetHeight: Int, color: Color = X11Colorlist.White): R

Creates a new image which is the result of this image padded to the canvas size specified.
Creates a new image which is the result of this image padded to the canvas size specified. If this image is already larger than the specified pad then the sizes of the existing image will be used instead.
Eg, requesting a pad of 200,200 on an image of 250,300 will result in keeping the 250,300.
Eg2, requesting a pad of 300,300 on an image of 400,250 will result in the width staying at 400 and the height padded to 300.
targetWidth
the size of the output canvas width
targetHeight
the size of the output canvas height
color
the background of the padded area.
returns
A new image that is the result of the padding
abstract def pixel(x: Int, y: Int): Int

Returns the pixel at the given coordinates as a integer in ARGB format.
Returns the pixel at the given coordinates as a integer in ARGB format.
x
the x coordinate of the pixel to grab
y
the y coordinate of the pixel to grab
returns
the ARGB value of the pixel
abstract def pixels: Array[Int]
abstract def resizeTo(targetWidth: Int, targetHeight: Int, position: Position, background: Color = X11Colorlist.White): R
abstract def scaleTo(targetWidth: Int, targetHeight: Int, scaleMethod: ScaleMethod = Bicubic): R

Scale will resize the canvas and scale the image to match.
Scale will resize the canvas and scale the image to match. This is like a "image resize" in Photoshop.
targetWidth
the target width
targetHeight
the target width
scaleMethod
the type of scaling method to use.
returns
a new Image that is the result of scaling this image
abstract def width: Int
abstract def clear(color: Color = X11Colorlist.White): Image

Clears all image data to the given color
Clears all image data to the given color

Annotations
@deprecated
Deprecated
(Since version 1.4) use filled

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
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
lazy val center: (Int, Int)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def col(x: Int): Array[Int]
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 of the pixel
def colours: Set[Color]

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 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
def 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)
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
ImageLike → AnyRef → Any
def exists(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 finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fitToHeight(targetHeight: Int, color: Color = X11Colorlist.White, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R
def fitToWidth(targetWidth: Int, color: Color = X11Colorlist.White, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R
def forall(f: (Int, Int, Int) ⇒ Boolean): Boolean
def foreach(f: (Int, Int, Int) ⇒ Unit): Unit
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pad(size: Int, color: Color = X11Colorlist.White): R

Creates a new image which is the result of this image padded with the given number of pixels on each edge.
Creates a new image which is the result of this image padded with the given number of pixels on each edge.
Eg, requesting a pad of 30 on an image of 250,300 will result in a new image with a canvas size of 310,360
size
the number of pixels to add on each edge
color
the background of the padded area.
returns
A new image that is the result of the padding
def pixel(p: (Int, Int)): Int

Returns the pixel at the given coordinates as a integer in RGB format.
Returns the pixel at the given coordinates as a integer in RGB format.
p
the pixel as an integer tuple
returns
the ARGB value of the pixel
def pixels(x: Int, y: Int, w: Int, h: Int): Array[Int]

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
lazy val points: Seq[(Int, Int)]
lazy val radius: Int
lazy val ratio: Double

returns
Returns the aspect ratio for this image.
def resize(scaleFactor: Double, position: Position = Center, background: Color = X11Colorlist.White): R

Resize will resize the canvas, it will not scale the image.
Resize will resize the canvas, it will not scale the image. This is like a "canvas resize" in Photoshop.
scaleFactor
the scaleFactor. 1 retains original size. 0.5 is half. 2 double. etc
position
where to position the original image after the canvas size change. Defaults to centre.
background
the color to use for expande background areas. Defaults to White.
returns
a new Image that is the result of resizing the canvas.
def resizeToHeight(targetHeight: Int, position: Position = Center, background: Color = X11Colorlist.White): R

Resize will resize the canvas, it will not scale the image.
Resize will resize the canvas, it will not scale the image. This is like a "canvas resize" in Photoshop.
position
where to position the original image after the canvas size change
returns
a new Image that is the result of resizing the canvas.
def resizeToWidth(targetWidth: Int, position: Position = Center, background: Color = X11Colorlist.White): R

Resize will resize the canvas, it will not scale the image.
Resize will resize the canvas, it will not scale the image. This is like a "canvas resize" in Photoshop.
position
where to position the original image after the canvas size change
returns
a new Image that is the result of resizing the canvas.
def rgb: Array[Array[Int]]
def rgb(x: Int, y: Int): Array[Int]
def row(y: Int): Array[Int]
def scale(scaleFactor: Double, scaleMethod: ScaleMethod = Bicubic): R

Scale will resize the canvas and the image.
Scale will resize the canvas and the image. This is like a "image resize" in Photoshop.
scaleFactor
the target increase or decrease. 1 is the same as original.
scaleMethod
the type of scaling method to use.
returns
a new Image that is the result of scaling this image
def scaleToHeight(targetHeight: Int, scaleMethod: ScaleMethod = Bicubic): R

Scale will resize the canvas and scale the image to match.
Scale will resize the canvas and scale the image to match. This is like a "image resize" in Photoshop.
This overloaded version of scale will scale the image so that the new image has a height that matches the given targetHeight and the same aspect ratio as the original.
Eg, an image of 200,300 with a scaleToHeight of 450 will result in a scaled image of 300,450
targetHeight
the target height
scaleMethod
the type of scaling method to use.
returns
a new Image that is the result of scaling this image
def scaleToWidth(targetWidth: Int, scaleMethod: ScaleMethod = Bicubic): R

Scale will resize the canvas and scale the image to match.
Scale will resize the canvas and scale the image to match. This is like a "image resize" in Photoshop.
This overloaded version of scale will scale the image so that the new image has a width that matches the given targetWidth and the same aspect ratio as the original.
Eg, an image of 200,300 with a scaleToWidth of 400 will result in a scaled image of 400,600
targetWidth
the target width
scaleMethod
the type of scaling method to use.
returns
a new Image that is the result of scaling this image
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
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( ... )

trait ImageLike[R] extends AnyRef

Abstract Value Members

abstract def copy: Image

abstract def empty: Image

abstract def filter(filter: Filter): R

abstract def fit(targetWidth: Int, targetHeight: Int, color: Color, scaleMethod: ScaleMethod, position: Position): R

abstract def height: Int

abstract def map(f: (Int, Int, Int) ⇒ Int): R

abstract def padTo(targetWidth: Int, targetHeight: Int, color: Color = X11Colorlist.White): R

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

abstract def pixels: Array[Int]

abstract def resizeTo(targetWidth: Int, targetHeight: Int, position: Position, background: Color = X11Colorlist.White): R

abstract def scaleTo(targetWidth: Int, targetHeight: Int, scaleMethod: ScaleMethod = Bicubic): R

abstract def width: Int

abstract def clear(color: Color = X11Colorlist.White): Image

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def argb: Array[Array[Int]]

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

final def asInstanceOf[T0]: T0

lazy val center: (Int, Int)

def clone(): AnyRef

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

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

def colours: Set[Color]

def count(color: Color): Int

def count: Int

lazy val dimensions: (Int, Int)

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def exists(color: Color): Boolean

def finalize(): Unit

def fitToHeight(targetHeight: Int, color: Color = X11Colorlist.White, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R

def fitToWidth(targetWidth: Int, color: Color = X11Colorlist.White, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R

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

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pad(size: Int, color: Color = X11Colorlist.White): R

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

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

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

lazy val radius: Int

lazy val ratio: Double

def resize(scaleFactor: Double, position: Position = Center, background: Color = X11Colorlist.White): R

def resizeToHeight(targetHeight: Int, position: Position = Center, background: Color = X11Colorlist.White): R

def resizeToWidth(targetWidth: Int, position: Position = Center, background: Color = X11Colorlist.White): R

def rgb: Array[Array[Int]]

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

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

def scale(scaleFactor: Double, scaleMethod: ScaleMethod = Bicubic): R

def scaleToHeight(targetHeight: Int, scaleMethod: ScaleMethod = Bicubic): R

def scaleToWidth(targetWidth: Int, scaleMethod: ScaleMethod = Bicubic): R

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped