Trait/Object

eu.joaocosta.minart.graphics

Canvas

Related Docs: object Canvas | package graphics

Permalink

trait Canvas extends MutableSurface

Window with a canvas that can be painted.

The Canvas is the main concept behind minart, providing access to both rendering and input functionallity.

A canvas represents a window with a width * height pixels. There's also a scale variable that controls the integer scaling and a clearColor that is applied to the whole canvas when it's cleared.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Canvas
  2. MutableSurface
  3. Surface
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def changeSettings(newSettings: Settings): Unit

    Permalink

    Changes the settings applied to this canvas.

    Changes the settings applied to this canvas.

    newSettings

    new canvas settings

  2. abstract def clear(buffers: Set[Buffer] = Canvas.Buffer.all): Unit

    Permalink

    Clears buffers, such as the backbuffer and keyboard inputs.

    Clears buffers, such as the backbuffer and keyboard inputs.

    buffers

    set of Canvas.Buffers to be cleared

  3. abstract def fill(color: Color): Unit

    Permalink

    Fill the surface with a certain color

    Fill the surface with a certain color

    color

    Color to fill the surface with

    Definition Classes
    MutableSurface
  4. abstract def getKeyboardInput(): KeyboardInput

    Permalink

    Gets the current keyboard input.

    Gets the current keyboard input.

    returns

    current keyboard input

  5. abstract def getPixels(): Vector[Array[Color]]

    Permalink

    Returns the pixels from this surface.

    Returns the pixels from this surface. This operation can be perfomance intensive, so it might be worthwile to implement this operation on the application code.

    returns

    color matrix

    Definition Classes
    Surface
  6. abstract def getPointerInput(): PointerInput

    Permalink

    Gets the current pointer input.

    Gets the current pointer input.

    returns

    current pointer input

  7. abstract def putPixel(x: Int, y: Int, color: Color): Unit

    Permalink

    Put a pixel in the surface with a certain color.

    Put a pixel in the surface with a certain color.

    x

    pixel x position

    y

    pixel y position

    color

    Color to apply to the pixel

    Definition Classes
    MutableSurface
  8. abstract def redraw(): Unit

    Permalink

    Flips buffers and redraws the screen.

  9. abstract def settings: Settings

    Permalink

    The settings applied to this canvas.

  10. abstract def unsafeGetPixel(x: Int, y: Int): Color

    Permalink

    Gets the color from the this surface in an unsafe way.

    Gets the color from the this surface in an unsafe way.

    This operation is unsafe: reading a out of bounds pixel has undefined behavior. You should only use this if the performance of getPixel and getPixels are not acceptable.

    x

    pixel x position

    y

    pixel y position

    returns

    pixel color

    Definition Classes
    Surface

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def blit(that: Surface, mask: Option[Color] = None)(x: Int, y: Int, cx: Int = 0, cy: Int = 0, cw: Int = that.width, ch: Int = that.height): Unit

    Permalink

    Draws a surface on top of this surface.

    Draws a surface on top of this surface.

    that

    surface to draw

    mask

    color to use as a mask (pixels with this color won't be merged)

    x

    leftmost pixel on the destination surface

    y

    topmost pixel on the destination surface

    cx

    leftmost pixel on the source surface

    cy

    topmost pixel on the source surface

    cw

    clip width of the source surface

    ch

    clip height of the source surface

    Definition Classes
    MutableSurface
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getPixel(x: Int, y: Int): Option[Color]

    Permalink

    Gets the color from the this surface.

    Gets the color from the this surface. This operation can be perfomance intensive, so it might be worthwile to either use getPixels to fetch multiple pixels at the same time or to implement this operation on the application code.

    x

    pixel x position

    y

    pixel y position

    returns

    pixel color

    Definition Classes
    Surface
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def height: Int

    Permalink

    The surface height

    The surface height

    Definition Classes
    CanvasSurface
  14. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. final def toRamSurface(): RamSurface

    Permalink

    Copies this surface into a new surface stored in RAM

    Copies this surface into a new surface stored in RAM

    Definition Classes
    Surface
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def view: SurfaceView

    Permalink

    Returns a view over this surface.

    Returns a view over this surface.

    Operations performed on a view are executed in a defered fashion.

    Definition Classes
    Surface
  22. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def width: Int

    Permalink

    The surface width

    The surface width

    Definition Classes
    CanvasSurface

Deprecated Value Members

  1. def blitWithMask(that: Surface, mask: Color)(x: Int, y: Int, cx: Int = 0, cy: Int = 0, cw: Int = that.width, ch: Int = that.height): Unit

    Permalink

    Draws a surface on top of this surface and masks the pixels with a certain color.

    Draws a surface on top of this surface and masks the pixels with a certain color.

    that

    surface to draw

    mask

    color to usa as a mask

    x

    leftmost pixel on the destination surface

    y

    topmost pixel on the destination surface

    cx

    leftmost pixel on the source surface

    cy

    topmost pixel on the source surface

    cw

    clip width of the source surface

    ch

    clip height of the source surface

    Definition Classes
    MutableSurface
    Annotations
    @deprecated
    Deprecated

    Use blit instead

Inherited from MutableSurface

Inherited from Surface

Inherited from AnyRef

Inherited from Any

Ungrouped