com.sksamuel.scrimage

AwtImage

class AwtImage extends AnyRef

Read only operations on a BufferedImage. You can think of this as a pimped-immutable-BufferedImage. None of the operations in this class will mutate the underlying awt buffer.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AwtImage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AwtImage(awt: BufferedImage)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. 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.

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

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. val awt: BufferedImage

  10. lazy val center: (Int, Int)

    The centre coordinates for the image as an (x, y) tuple.

  11. def clone(): AnyRef

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

    returns

    the pixels for the column identified by the x co-ordinate. 0 indexed.

  13. 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

  14. 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

  15. 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

  16. 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

  17. 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

  18. 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

  19. lazy val dimensions: (Int, Int)

    A tuple of the (width, height)

  20. 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.

  21. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AwtImage → AnyRef → Any
  23. 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

  24. 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]
  25. def fastScaleScrimage(targetWidth: Int, targetHeight: Int): BufferedImage

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. 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

  28. 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

  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. def hashCode(): Int

    Definition Classes
    AwtImage → AnyRef → Any
  31. lazy val height: Int

  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. 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

  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  37. def offset(x: Int, y: Int): Int

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

  39. 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

  40. 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

  41. 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

  42. 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

  43. 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

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

  45. lazy val radius: Int

    The radius of the image defined as the centre to the corners.

  46. lazy val ratio: Double

    returns

    Returns the aspect ratio for this image.

  47. def rgb: Array[Array[Int]]

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

  49. 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]
  50. def row(y: Int): Array[Pixel]

    returns

    the pixels in the row identified by the y coordinate. 0 indexed.

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

    Attributes
    protected[com.sksamuel.scrimage]
  52. 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.

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

    Definition Classes
    AnyRef
  54. 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.

  55. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped