Class EvasCanvas

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though. Most of these functions deal with low-level Evas actions like: create/destroy raw canvases, not bound to any displaying engine. tell a canvas, I got focused (in a windowing context, for example). tell a canvas, a region should not be calculated anymore in rendering. tell a canvas, to render its contents immediately. Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you will be looking at this section only if you're building low-level stuff. The groups within, present you functions that deal with the canvas directly too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas.

public class EvasCanvas

Inheritance

object

EvasCanvas

Properties

ImageCacheSize

Gets or sets the image cache. This function returns the image cache size of the canvas in bytes.

Declaration

public int ImageCacheSize { get; set; }

Property Value

Type	Description
int

Pointer

Gets the current known default pointer coordinates. This function returns the current known canvas unit coordinates of the mouse pointer.

Declaration

public Point Pointer { get; }

Property Value

Type	Description
Point

Methods

AddDamageRectangle(int, int, int, int)

Adds a damage rectangle.

Declaration

public void AddDamageRectangle(int x, int y, int width, int height)

Parameters

Type	Name	Description
int	x	The rectangle's top left corner's horizontal coordinate.
int	y	The rectangle's top left corner's vertical coordinate.
int	width	The rectangle's width.
int	height	The rectangle's height.

AddEventAction(EvasObjectCallbackType, Action)

Adds or registers an event to a given canvas event.

Declaration

public void AddEventAction(EvasObjectCallbackType type, Action action)

Parameters

Type	Name	Description
EvasObjectCallbackType	type	The type of event that triggers.
System.Action	action	The action to be called when the event is triggered.

AddObscuredRectangle(int, int, int, int)

Adds an "obscured region" to an Evas canvas.

Declaration

public void AddObscuredRectangle(int x, int y, int width, int height)

Parameters

Type	Name	Description
int	x	The rectangle's top left corner's horizontal coordinate.
int	y	The rectangle's top left corner's vertical coordinate.
int	width	The rectangle's width.
int	height	The rectangle's height.

ClearObscuredRectangle()

Removes all the "obscured regions" from an Evas canvas.

Declaration

public void ClearObscuredRectangle()

DeleteEventAction(EvasObjectCallbackType, Action)

Deletes an event to a given canvas event.

Declaration

public void DeleteEventAction(EvasObjectCallbackType type, Action action)

Parameters

Type	Name	Description
EvasObjectCallbackType	type	The type of event that triggers.
System.Action	action	The action to be called when the event is triggered

FlushImageCache()

Flushes the image cache of the canvas.

Declaration

public void FlushImageCache()