Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.CanvasImage Class Reference

Canvas image. More...

Inheritance diagram for Dragengine.Gui.CanvasImage:
Dragengine.Gui.Canvas

Public Member Functions

Constructors
CanvasImage new ()
 Create canvas image. More...
 
Management
Image getImage ()
 Image or null if not set. More...
 
void setImage (Image image)
 Set image or null to unset. More...
 
int getRepeatX ()
 Repeat count along X axis. More...
 
void setRepeatX (int count)
 Set repeat count along X axis. More...
 
int getRepeatY ()
 Repeat count along Y axis. More...
 
void setRepeatY (int count)
 Set repeat count along Y axis. More...
 
bool equals (Object other)
 Canvas is equal to another object. More...
 
int hashCode ()
 Hash code for use as dictionary keys. More...
 
- Public Member Functions inherited from Dragengine.Gui.Canvas
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...
 

Additional Inherited Members

Constructors

Detailed Description

Canvas image.

This is a native class.

Member Function Documentation

◆ equals()

bool Dragengine.Gui.CanvasImage.equals ( Object  other)

Canvas is equal to another object.

Implements Object.equals(Object).

Returns
true if other is of type canvas and canvas are equal.

Reimplemented from Dragengine.Gui.Canvas.

◆ getImage()

Image Dragengine.Gui.CanvasImage.getImage ( )

Image or null if not set.

◆ getRepeatX()

int Dragengine.Gui.CanvasImage.getRepeatX ( )

Repeat count along X axis.

◆ getRepeatY()

int Dragengine.Gui.CanvasImage.getRepeatY ( )

Repeat count along Y axis.

◆ hashCode()

int Dragengine.Gui.CanvasImage.hashCode ( )

Hash code for use as dictionary keys.

Implements Object.hashCode().

Reimplemented from Dragengine.Gui.Canvas.

◆ new()

CanvasImage Dragengine.Gui.CanvasImage.new ( )

Create canvas image.

Reimplemented from Dragengine.Gui.Canvas.

◆ setImage()

void Dragengine.Gui.CanvasImage.setImage ( Image  image)

Set image or null to unset.

◆ setRepeatX()

void Dragengine.Gui.CanvasImage.setRepeatX ( int  count)

Set repeat count along X axis.

◆ setRepeatY()

void Dragengine.Gui.CanvasImage.setRepeatY ( int  count)

Set repeat count along Y axis.


The documentation for this class was generated from the following file: