Public Member Functions | |
Management | |
| Point | getPosition () |
| Position in parent canvas view units. More... | |
| void | setPosition (Point position) |
| Set position in parent canvas view units. More... | |
| Point | getSize () |
| Size in parent canvas view units. More... | |
| void | setSize (Point size) |
| Set size in parent canvas view units. More... | |
| TexMatrix2 | getTransform () |
| Transformation matrix affecting the canvas and all its content. More... | |
| void | setTransform (TexMatrix2 transform) |
| Set transformation matrix affecting the canvas and all its content. More... | |
| ColorMatrix | getColorTransform () |
| Color transformation matrix affecting the canvas and all its content. More... | |
| void | setColorTransform (ColorMatrix transform) |
| Set color transformation matrix affecting the canvas and all its content. More... | |
| bool | getVisible () |
| Canvas is visible. More... | |
| void | setVisible (bool visible) |
| Set if canvas is visible. More... | |
| float | getOrder () |
| Render order. Larger renders ontop of smaller. More... | |
| void | setOrder (float order) |
| Set render order. Larger renders ontop of smaller. More... | |
| float | getTransparency () |
| Transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More... | |
| void | setTransparency (float transparency) |
| Set transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More... | |
| CanvasBlendMode | getBlendMode () |
| Blend mode used to blend canvas over previous content. More... | |
| void | setBlendMode (CanvasBlendMode blendMode) |
| Set blend mode used to blend canvas over previous content. More... | |
| Canvas | getMask () |
| Mask canvas or null. More... | |
| void | setMask (Canvas mask) |
| Set mask canvas or null. More... | |
| CanvasView | getParentView () |
| Parent canvas view or null. More... | |
| Canvas | getParentMask () |
| Parent canvas mask or null. More... | |
| bool | equals (Object other) |
| Canvas is equal to another object. More... | |
| int | hashCode () |
| Hash code for use as dictionary keys. More... | |
Protected Member Functions | |
Constructors | |
| Canvas | new () |
| Create canvas. More... | |
Detailed Description
This is a native class. It can not be instanced directly.
Member Function Documentation
◆ equals()
| bool Dragengine.Scenery.Canvas.equals | ( | Object | other | ) |
Canvas is equal to another object.
Implements Object.equals(Object).
- Returns
- true if other is of type canvas and components are equal.
Reimplemented in Dragengine.Scenery.CanvasView, Dragengine.Scenery.CanvasVideoPlayer, Dragengine.Scenery.CanvasText, Dragengine.Scenery.CanvasRenderWorld, Dragengine.Scenery.CanvasPaint, Dragengine.Scenery.CanvasImage, and Dragengine.Scenery.CanvasCanvasView.
◆ getBlendMode()
| CanvasBlendMode Dragengine.Scenery.Canvas.getBlendMode | ( | ) |
Blend mode used to blend canvas over previous content.
◆ getColorTransform()
| ColorMatrix Dragengine.Scenery.Canvas.getColorTransform | ( | ) |
Color transformation matrix affecting the canvas and all its content.
◆ getMask()
| Canvas Dragengine.Scenery.Canvas.getMask | ( | ) |
Mask canvas or null.
- Version
- 1.5
Mask canvas content is converted to grayscale.
◆ getOrder()
| float Dragengine.Scenery.Canvas.getOrder | ( | ) |
Render order. Larger renders ontop of smaller.
◆ getParentMask()
| Canvas Dragengine.Scenery.Canvas.getParentMask | ( | ) |
Parent canvas mask or null.
- Version
- 1.11
◆ getParentView()
| CanvasView Dragengine.Scenery.Canvas.getParentView | ( | ) |
Parent canvas view or null.
- Version
- 1.11
◆ getPosition()
| Point Dragengine.Scenery.Canvas.getPosition | ( | ) |
Position in parent canvas view units.
◆ getSize()
| Point Dragengine.Scenery.Canvas.getSize | ( | ) |
Size in parent canvas view units.
◆ getTransform()
| TexMatrix2 Dragengine.Scenery.Canvas.getTransform | ( | ) |
Transformation matrix affecting the canvas and all its content.
◆ getTransparency()
| float Dragengine.Scenery.Canvas.getTransparency | ( | ) |
Transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent.
◆ getVisible()
| bool Dragengine.Scenery.Canvas.getVisible | ( | ) |
Canvas is visible.
◆ hashCode()
| int Dragengine.Scenery.Canvas.hashCode | ( | ) |
Hash code for use as dictionary keys.
Implements Object.hashCode().
Reimplemented in Dragengine.Scenery.CanvasView, Dragengine.Scenery.CanvasVideoPlayer, Dragengine.Scenery.CanvasText, Dragengine.Scenery.CanvasRenderWorld, Dragengine.Scenery.CanvasPaint, Dragengine.Scenery.CanvasImage, and Dragengine.Scenery.CanvasCanvasView.
◆ new()
|
protected |
◆ setBlendMode()
| void Dragengine.Scenery.Canvas.setBlendMode | ( | CanvasBlendMode | blendMode | ) |
Set blend mode used to blend canvas over previous content.
◆ setColorTransform()
| void Dragengine.Scenery.Canvas.setColorTransform | ( | ColorMatrix | transform | ) |
Set color transformation matrix affecting the canvas and all its content.
◆ setMask()
| void Dragengine.Scenery.Canvas.setMask | ( | Canvas | mask | ) |
Set mask canvas or null.
- Version
- 1.5
Mask canvas content is converted to grayscale.
◆ setOrder()
| void Dragengine.Scenery.Canvas.setOrder | ( | float | order | ) |
Set render order. Larger renders ontop of smaller.
◆ setPosition()
| void Dragengine.Scenery.Canvas.setPosition | ( | Point | position | ) |
Set position in parent canvas view units.
◆ setSize()
| void Dragengine.Scenery.Canvas.setSize | ( | Point | size | ) |
Set size in parent canvas view units.
◆ setTransform()
| void Dragengine.Scenery.Canvas.setTransform | ( | TexMatrix2 | transform | ) |
Set transformation matrix affecting the canvas and all its content.
◆ setTransparency()
| void Dragengine.Scenery.Canvas.setTransparency | ( | float | transparency | ) |
Set transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent.
◆ setVisible()
| void Dragengine.Scenery.Canvas.setVisible | ( | bool | visible | ) |
Set if canvas is visible.
The documentation for this class was generated from the following file:
