Evas_Output_Size (3) - Linux Manuals

Evas_Output_Size: Functions that set and retrieve the output and viewport size of an evas.

NAME

Evas Output and Viewport Resizing Functions - Functions that set and retrieve the output and viewport size of an evas.

Functions

EAPI void evas_output_size_set (Evas *e, int w, int h)
Sets the output size of the render engine of the given evas.
EAPI void evas_output_size_get (const Evas *e, int *w, int *h)
Retrieve the output size of the render engine of the given evas.
EAPI void evas_output_viewport_set (Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
Sets the output viewport of the given evas in evas units.
EAPI void evas_output_viewport_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
Get the render engine's output viewport co-ordinates in canvas units.

Detailed Description

Functions that set and retrieve the output and viewport size of an evas.

Function Documentation

EAPI void evas_output_size_get (const Evas * e, int * w, int * h)

Retrieve the output size of the render engine of the given evas.

The output size is given in whatever the output units are for the engine.

If either w or h is NULL, then it is ignored. If e is invalid, the returned results are undefined.

Parameters:

e The given evas.
w The pointer to an integer to store the width in.
h The pointer to an integer to store the height in.

EAPI void evas_output_size_set (Evas * e, int w, int h)

Sets the output size of the render engine of the given evas.

The evas will render to a rectangle of the given size once this function is called. The output size is independent of the viewport size. The viewport will be stretched to fill the given rectangle.

The units used for w and h depend on the engine used by the evas.

Parameters:

e The given evas.
w The width in output units, usually pixels.
h The height in output units, usually pixels.

EAPI void evas_output_viewport_get (const Evas * e, Evas_Coord * x, Evas_Coord * y, Evas_Coord * w, Evas_Coord * h)

Get the render engine's output viewport co-ordinates in canvas units.

Parameters:

e The pointer to the Evas Canvas
x The pointer to a x variable to be filled in
y The pointer to a y variable to be filled in
w The pointer to a width variable to be filled in
h The pointer to a height variable to be filled in

Calling this function writes the current canvas output viewport size and location values into the variables pointed to by x, y, w and h. On success the variables have the output location and size values written to them in canvas units. Any of x, y, w or h that are NULL will not be written to. If e is invalid, the results are undefined.

Example:

 extern Evas *evas;
 Evas_Coord x, y, width, height;

 evas_output_viewport_get(evas, &x, &y, &w, &h);

EAPI void evas_output_viewport_set (Evas * e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)

Sets the output viewport of the given evas in evas units.

The output viewport is the area of the evas that will be visible to the viewer. The viewport will be stretched to fit the output target of the evas when rendering is performed.

Note:

The coordinate values do not have to map 1-to-1 with the output target. However, it is generally advised that it is done for ease of use.

Parameters:

e The given evas.
x The top-left corner x value of the viewport.
y The top-left corner y value of the viewport.
w The width of the viewport. Must be greater than 0.
h The height of the viewport. Must be greater than 0.

Author

Generated automatically by Doxygen for Evas from the source code.