Window with a canvas that can be painted.
The Canvas provides access to both rendering and input functionallity, as the input must be tied to a window
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.
Attributes
- Companion
- object
- Graph
-
- Supertypes
- Known subtypes
-
trait LowLevelCanvastrait SurfaceBackedCanvas
Members list
Value members
Abstract methods
The settings applied to this canvas.
The settings applied to this canvas.
Attributes
Changes the settings applied to this canvas.
Changes the settings applied to this canvas.
Value parameters
- newSettings
-
new canvas settings
Attributes
Clears buffers, such as the backbuffer and keyboard inputs.
Clears buffers, such as the backbuffer and keyboard inputs.
Value parameters
- buffers
-
set of Canvas.Buffers to be cleared
Attributes
Gets the current keyboard input.
Gets the current keyboard input.
Attributes
- Returns
-
current keyboard input
Gets the current pointer input.
Gets the current pointer input.
Attributes
- Returns
-
current pointer input
Inherited methods
Draws a surface on top of this surface.
Draws a surface on top of this surface.
Value parameters
- blendMode
-
blend strategy to use
- ch
-
clip height of the source surface
- cw
-
clip width of the source surface
- cx
-
leftmost pixel on the source surface
- cy
-
topmost pixel on the source surface
- that
-
surface to draw
- x
-
leftmost pixel on the destination surface
- y
-
topmost pixel on the destination surface
Attributes
- Inherited from:
- MutableSurface
Fill the whole surface with a certain color.
Fill the whole surface with a certain color.
Value parameters
- color
-
Colorto fill the surface with
Attributes
- Inherited from:
- MutableSurface
Fill part of the surface with a certain color.
Fill part of the surface with a certain color.
Value parameters
- color
-
Colorto fill the surface with - h
-
region height
- w
-
region width
- x
-
leftmost pixel on the destination surface
- y
-
topmost pixel on the destination surface
Attributes
- Inherited from:
- MutableSurface
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.
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.
Value parameters
- x
-
pixel x position
- y
-
pixel y position
Attributes
- Returns
-
pixel color
- Inherited from:
- Surface
Gets the color from the this surface, falling back to a default color when out of bounds. Similar to getPixel(x, y).getOrElse(fallback), but avoids an allocation.
Gets the color from the this surface, falling back to a default color when out of bounds. Similar to getPixel(x, y).getOrElse(fallback), but avoids an allocation.
Value parameters
- fallback
-
fallback color
- x
-
pixel x position
- y
-
pixel y position
Attributes
- Returns
-
pixel color
- Inherited from:
- 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 the pixels from this surface. This operation can be perfomance intensive, so it might be worthwile to implement this operation on the application code.
Attributes
- Returns
-
color matrix
- Inherited from:
- Surface
Modifies this surface using surface view transformations
Modifies this surface using surface view transformations
Value parameters
- f
-
operations to apply
Attributes
- Inherited from:
- MutableSurface
Put a pixel in the surface with a certain color.
Put a pixel in the surface with a certain color.
Value parameters
- color
-
Colorto apply to the pixel - x
-
pixel x position
- y
-
pixel y position
Attributes
- Inherited from:
- MutableSurface
Copies this surface into a new surface stored in RAM.
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.
Value parameters
- x
-
pixel x position
- y
-
pixel y position
Attributes
- Returns
-
pixel color
- Inherited from:
- Surface
Puts a pixel in the surface in an unsafe way.
Puts a pixel in the surface in an unsafe way.
This operation is unsafe: writing a out of bounds pixel has undefined behavior. You should only use this if the performance of putPixel is not acceptable.
Value parameters
- x
-
pixel x position
- y
-
pixel y position
Attributes
- Returns
-
pixel color
- Inherited from:
- MutableSurface
Returns a view over this surface.
Returns a view over this surface.
Operations performed on a view are executed in a defered fashion.
Attributes
- Inherited from:
- Surface
Deprecated and Inherited methods
Draws a surface on top of this surface.
Draws a surface on top of this surface.
Value parameters
- ch
-
clip height of the source surface
- cw
-
clip width of the source surface
- cx
-
leftmost pixel on the source surface
- cy
-
topmost pixel on the source surface
- mask
-
color to use as a mask (pixels with this color won't be merged)
- that
-
surface to draw
- x
-
leftmost pixel on the destination surface
- y
-
topmost pixel on the destination surface
Attributes
- Deprecated
- true
- Inherited from:
- MutableSurface