Data Structures | |
struct | Eina_Tile_Grid_Info |
Grid type of a tiler. More... | |
Typedefs | |
typedef struct _Eina_Tiler | Eina_Tiler |
Tiler type. | |
typedef struct Eina_Tile_Grid_Info | Eina_Tile_Grid_Info |
Grid type of a tiler. | |
typedef struct _Eina_Tile_Grid_Slicer | Eina_Tile_Grid_Slicer |
Functions | |
Eina_Tiler * | eina_tiler_new (int w, int h) |
Creates a new tiler with w width and h height. More... | |
void | eina_tiler_free (Eina_Tiler *t) |
Frees a tiler. More... | |
void | eina_tiler_tile_size_set (Eina_Tiler *t, int w, int h) |
Sets the size of tiles for a tiler. More... | |
void | eina_tiler_area_size_set (Eina_Tiler *t, int w, int h) |
Change the size of the area covered by the tiler. More... | |
void | eina_tiler_area_size_get (const Eina_Tiler *t, int *w, int *h) |
Get the size of the area covered by the tiler. More... | |
void | eina_tiler_strict_set (Eina_Tiler *t, Eina_Bool strict) |
Define if we need to follow a strict grid of tile or a loosy one. More... | |
Eina_Bool | eina_tiler_empty (Eina_Tiler *t) |
Tell if a tiler is empty or not. More... | |
Eina_Bool | eina_tiler_rect_add (Eina_Tiler *t, const Eina_Rectangle *r) |
Adds a rectangle to a tiler. More... | |
void | eina_tiler_rect_del (Eina_Tiler *t, const Eina_Rectangle *r) |
Removes a rectangle from a tiler. More... | |
void | eina_tiler_clear (Eina_Tiler *t) |
Removes all rectangles from tiles. More... | |
Eina_Iterator * | eina_tiler_iterator_new (const Eina_Tiler *t) |
Create a iterator to access the tilers calculated rectangles. More... | |
Eina_Iterator * | eina_tile_grid_slicer_iterator_new (int x, int y, int w, int h, int tile_w, int tile_h) |
Creates a new Eina_Iterator that iterates over a list of tiles. More... | |
static Eina_Bool | eina_tile_grid_slicer_next (Eina_Tile_Grid_Slicer *slc, const Eina_Tile_Grid_Info **rect) |
Iterates over the tiles set by eina_tile_grid_slicer_setup(). More... | |
static Eina_Bool | eina_tile_grid_slicer_setup (Eina_Tile_Grid_Slicer *slc, int x, int y, int w, int h, int tile_w, int tile_h) |
Setup an Eina_Tile_Grid_Slicer struct. More... | |
Eina_Tiler is a tool to facilitate calculations of which areas are damaged and thus need to be re-rendered. The basic usage of Eina_Tiler is to give it the size of your canvas and a set of rectangular areas that need re-rendering, from that and using heuristics it'll tell you an efficient way to re-render in the form of a set of non-overlapping rectangles that covers the whole area that needs re-rendering.
The following is pseudo-code showing some simple use of Eina_Tiler:
Grid slicer and Eina_Tiler are usually used together, that is however not necessary, they can be used independently. Grid slicer provides an easy API to divide an area in tiles which is useful in certain applications to divide the area that will be rendered into tiles. It's customary to, then create one Eina_Tiler for each tile.
The following is pseudo-code showing a very simplified use of grid slicer together with Eina_Tiler:
Eina_Tiler* eina_tiler_new | ( | int | w, |
int | h | ||
) |
Creates a new tiler with w
width and h
height.
w | Width of the tiler |
h | Height of the tiler |
References EINA_MAGIC_SET, and EINA_TRUE.
void eina_tiler_free | ( | Eina_Tiler * | t | ) |
Frees a tiler.
t | The tiler to free. |
This function frees t
. It does not free the memory allocated for the elements of t
.
void eina_tiler_tile_size_set | ( | Eina_Tiler * | t, |
int | w, | ||
int | h | ||
) |
Sets the size of tiles for a tiler.
t | The tiler whose tile size will be set. |
w | Width of the tiles. |
h | Height of the tiles. |
w
and h
must be greater than zero, otherwise tile size won't be changed. References EAPI, and EINA_FALSE.
void eina_tiler_area_size_set | ( | Eina_Tiler * | t, |
int | w, | ||
int | h | ||
) |
Change the size of the area covered by the tiler.
t | The tiler whose area size will be set. |
w | Width of the area. |
h | Height of the area. |
void eina_tiler_area_size_get | ( | const Eina_Tiler * | t, |
int * | w, | ||
int * | h | ||
) |
Get the size of the area covered by the tiler.
t | The tiler whose area size will be fetched. |
w | Width of the area. |
h | Height of the area. |
void eina_tiler_strict_set | ( | Eina_Tiler * | t, |
Eina_Bool | strict | ||
) |
Define if we need to follow a strict grid of tile or a loosy one.
t | The tiler to apply the strict rules to. |
strict | Define if it will be strict or loosy |
By default it will be loosy.
Eina_Bool eina_tiler_empty | ( | Eina_Tiler * | t | ) |
Tell if a tiler is empty or not.
t | The tiler to apply the strict rules to. |
References EINA_TRUE.
Eina_Bool eina_tiler_rect_add | ( | Eina_Tiler * | t, |
const Eina_Rectangle * | r | ||
) |
Adds a rectangle to a tiler.
t | The tiler in which to add a container. |
r | The rectangle to be added. |
References EINA_FALSE, _Eina_Rectangle::h, and _Eina_Rectangle::w.
void eina_tiler_rect_del | ( | Eina_Tiler * | t, |
const Eina_Rectangle * | r | ||
) |
Removes a rectangle from a tiler.
t | The tiler in which to add a container. |
r | The rectangle to be removed. |
References EINA_FALSE, _Eina_Rectangle::h, and _Eina_Rectangle::w.
void eina_tiler_clear | ( | Eina_Tiler * | t | ) |
Removes all rectangles from tiles.
t | The tiler to clear. |
References EAPI.
Eina_Iterator* eina_tiler_iterator_new | ( | const Eina_Tiler * | t | ) |
Create a iterator to access the tilers calculated rectangles.
t | The tiler to iterate over. |
References EAPI, EINA_MAGIC_NONE, EINA_MAGIC_SET, eina_tile_grid_slicer_next(), EINA_TRUE, FUNC_ITERATOR_FREE, FUNC_ITERATOR_GET_CONTAINER, and FUNC_ITERATOR_NEXT.
Eina_Iterator* eina_tile_grid_slicer_iterator_new | ( | int | x, |
int | y, | ||
int | w, | ||
int | h, | ||
int | tile_w, | ||
int | tile_h | ||
) |
Creates a new Eina_Iterator that iterates over a list of tiles.
x | X axis coordinate. |
y | Y axis coordinate. |
w | width. |
h | height. |
tile_w | tile width. |
tile_h | tile height. |
NULL
on failure.The region defined by x, y, w, h will be divided in to a grid of tiles of width tile_w and height tile_h
, the returned iterator will iterate over every tile in the grid having as its data a Eina_Tile_Grid_Info.
References EINA_MAGIC_SET, eina_tile_grid_slicer_setup(), FUNC_ITERATOR_FREE, and FUNC_ITERATOR_NEXT.
|
inlinestatic |
Iterates over the tiles set by eina_tile_grid_slicer_setup().
slc | Pointer to an Eina_Tile_Grid_Slicer struct. |
rect | Pointer to a struct Eina_Tile_Grid_Info *. |
This functions iterates over each Eina_Tile_Grid_Info *rect of the grid. eina_tile_grid_slicer_setup() must be called first, and *rect is only valid if this function returns EINA_TRUE. Its content shouldn't be modified.
Referenced by eina_tiler_iterator_new().
|
inlinestatic |
Setup an Eina_Tile_Grid_Slicer struct.
slc | Pointer to an Eina_Tile_Grid_Slicer struct. |
x | X axis coordinate. |
y | Y axis coordinate. |
w | width. |
h | height. |
tile_w | tile width. |
tile_h | tile height. |
NULL
on failure.The region defined by x, y, w, h will be divided in to a grid of tiles of width tile_w and height tile_h
, slc
can then be used with eina_tile_grid_slicer_next() to access each tile.
Referenced by eina_tile_grid_slicer_iterator_new().