ImageLike

Abstract Value Members

abstract def clear(color: Color = Color.WHITE): Image

Clears all image data to the given color
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 foreach(f: (Int, Int, Int) ⇒ Unit): Unit
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 pixels: Array[Int]
abstract def resizeTo(targetWidth: Int, targetHeight: Int, position: Position, background: Color = Color.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 writer[T <: ImageWriter](format: Format[T]): T

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def count(pixel: Int): Int

Counts the number of pixels with the given colour.
Counts the number of pixels with the given colour.
pixel
the colour to detect.
returns
the number of pixels that matched the colour of the given pixel
def dimensions: (Int, Int)
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
ImageLike → AnyRef → Any
def exists(pixel: Int): Boolean

pixel
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 = java.awt.Color.WHITE, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R
def fitToWidth(targetWidth: Int, color: Color = java.awt.Color.WHITE, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R
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
lazy val points: Seq[(Int, Int)]
def ratio: Double

returns
Returns the aspect ratio for this image.
def resize(scaleFactor: Double, position: Position = Center, background: Color = Color.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 = Color.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 = Color.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 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( ... )
def write(out: OutputStream, format: Format[_ <: ImageWriter]): Unit
def write(out: OutputStream): Unit
def write(file: File, format: Format[_ <: ImageWriter]): Unit
def write(file: File): Unit
def write(path: String, format: Format[_ <: ImageWriter]): Unit
def write(path: String): Unit
def write(format: Format[_ <: ImageWriter]): Array[Byte]
def write: Array[Byte]

trait ImageLike[R] extends AnyRef

Abstract Value Members

abstract def clear(color: Color = Color.WHITE): Image

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 foreach(f: (Int, Int, Int) ⇒ Unit): Unit

abstract def height: Int

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

abstract def pixels: Array[Int]

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

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

abstract def width: Int

abstract def writer[T <: ImageWriter](format: Format[T]): T

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

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def count(pixel: Int): Int

def dimensions: (Int, Int)

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def exists(pixel: Int): Boolean

def finalize(): Unit

def fitToHeight(targetHeight: Int, color: Color = java.awt.Color.WHITE, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R

def fitToWidth(targetWidth: Int, color: Color = java.awt.Color.WHITE, scaleMethod: ScaleMethod = Bicubic, position: Position = Center): R

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

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

def ratio: Double

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

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

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

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

def write(out: OutputStream, format: Format[_ <: ImageWriter]): Unit

def write(out: OutputStream): Unit

def write(file: File, format: Format[_ <: ImageWriter]): Unit

def write(file: File): Unit

def write(path: String, format: Format[_ <: ImageWriter]): Unit

def write(path: String): Unit

def write(format: Format[_ <: ImageWriter]): Array[Byte]

def write: Array[Byte]

Inherited from AnyRef

Inherited from Any

Ungrouped