<html>
<head>
<title>Evas: Output and Viewport Resizing Functions</title>
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<meta name="author" content="Andres Blanc" >
<link rel="icon" href="img/favicon.png" type="image/x-icon">
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
<link rel="icon" href="img/favicon.png" type="image/ico">
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
<link rel="stylesheet" type="text/css" media="screen" href="e.css">
<link rel="stylesheet" type="text/css" media="screen" href="edoxy.css">
</head>
<body>
<div id="container">
<div id="header">
<div class="layout">
<h1><span>Enlightenment</span></h1>
<h2><span>Beauty at your fingertips</span></h2>
<div class="menu-container">
<div class="menu">
<ul>
<li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
<li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
<li><a href="http://www.enlightenment.org/">Home</a></li>
</ul>
</div>
</div>
<div class="doxytitle">
Evas Documentation <small>at Thu Jul 14 2011</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<li><a href="todo.html">Todo</a></li>
<li><a href="files.html">Files</a></li>
<li><a href="annotated.html">Data Structures</a></li>
<li><a href="globals.html">Globals</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="pages.html">Related Pages</a></li>
<li class="current"><a href="index.html">Main Page</a></li>
</ul>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Output and Viewport Resizing Functions</div> </div>
<div class="ingroups"><a class="el" href="group__Evas__Canvas.html">Canvas Functions</a></div></div>
<div class="contents">
<p>Functions that set and retrieve the output and viewport size of an evas.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Evas__Output__Size.html#gaaf571f18f97f4067f554ab7713f01063">evas_output_size_set</a> (<a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> *e, int w, int h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the output size of the render engine of the given evas. <a href="#gaaf571f18f97f4067f554ab7713f01063"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Evas__Output__Size.html#ga1f3497644d526ff5ded49b19c1ec732a">evas_output_size_get</a> (const <a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> *e, int *w, int *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the output size of the render engine of the given evas. <a href="#ga1f3497644d526ff5ded49b19c1ec732a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Evas__Output__Size.html#ga1d39edcaff429d884d4a70aa1fca0c08">evas_output_viewport_set</a> (<a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the output viewport of the given evas in evas units. <a href="#ga1d39edcaff429d884d4a70aa1fca0c08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Evas__Output__Size.html#gab94e38ef64004f0ead8cd8f7a8f69fee">evas_output_viewport_get</a> (const <a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the render engine's output viewport co-ordinates in canvas units. <a href="#gab94e38ef64004f0ead8cd8f7a8f69fee"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Functions that set and retrieve the output and viewport size of an evas. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga1f3497644d526ff5ded49b19c1ec732a"></a><!-- doxytag: member="evas_main.c::evas_output_size_get" ref="ga1f3497644d526ff5ded49b19c1ec732a" args="(const Evas *e, int *w, int *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void evas_output_size_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the output size of the render engine of the given evas. </p>
<p>The output size is given in whatever the output units are for the engine.</p>
<p>If either <code>w</code> or <code>h</code> is <code>NULL</code>, then it is ignored. If <code>e</code> is invalid, the returned results are undefined.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The given evas. </td></tr>
<tr><td class="paramname">w</td><td>The pointer to an integer to store the width in. </td></tr>
<tr><td class="paramname">h</td><td>The pointer to an integer to store the height in. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaaf571f18f97f4067f554ab7713f01063"></a><!-- doxytag: member="evas_main.c::evas_output_size_set" ref="gaaf571f18f97f4067f554ab7713f01063" args="(Evas *e, int w, int h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void evas_output_size_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the output size of the render engine of the given evas. </p>
<p>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.</p>
<p>The units used for <code>w</code> and <code>h</code> depend on the engine used by the evas.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The given evas. </td></tr>
<tr><td class="paramname">w</td><td>The width in output units, usually pixels. </td></tr>
<tr><td class="paramname">h</td><td>The height in output units, usually pixels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab94e38ef64004f0ead8cd8f7a8f69fee"></a><!-- doxytag: member="evas_main.c::evas_output_viewport_get" ref="gab94e38ef64004f0ead8cd8f7a8f69fee" args="(const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void evas_output_viewport_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord * </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord * </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord * </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord * </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the render engine's output viewport co-ordinates in canvas units. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The pointer to the Evas Canvas </td></tr>
<tr><td class="paramname">x</td><td>The pointer to a x variable to be filled in </td></tr>
<tr><td class="paramname">y</td><td>The pointer to a y variable to be filled in </td></tr>
<tr><td class="paramname">w</td><td>The pointer to a width variable to be filled in </td></tr>
<tr><td class="paramname">h</td><td>The pointer to a height variable to be filled in</td></tr>
</table>
</dd>
</dl>
<p>Calling this function writes the current canvas output viewport size and location values into the variables pointed to by <code>x</code>, <code>y</code>, <code>w</code> and <code>h</code>. On success the variables have the output location and size values written to them in canvas units. Any of <code>x</code>, <code>y</code>, <code>w</code> or <code>h</code> that are NULL will not be written to. If <code>e</code> is invalid, the results are undefined.</p>
<p>Example: </p>
<div class="fragment"><pre class="fragment"> <span class="keyword">extern</span> <a class="code" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043" title="An Evas canvas handle.">Evas</a> *evas;
Evas_Coord x, y, width, height;
<a class="code" href="group__Evas__Output__Size.html#gab94e38ef64004f0ead8cd8f7a8f69fee" title="Get the render engine's output viewport co-ordinates in canvas units.">evas_output_viewport_get</a>(evas, &x, &y, &w, &h);
</pre></div>
</div>
</div>
<a class="anchor" id="ga1d39edcaff429d884d4a70aa1fca0c08"></a><!-- doxytag: member="evas_main.c::evas_output_viewport_set" ref="ga1d39edcaff429d884d4a70aa1fca0c08" args="(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void evas_output_viewport_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Evas__Canvas.html#ga5ff87cc4ce6bc43e3b640a6d37f73043">Evas</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Evas_Coord </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the output viewport of the given evas in evas units. </p>
<p>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.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>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.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The given evas. </td></tr>
<tr><td class="paramname">x</td><td>The top-left corner x value of the viewport. </td></tr>
<tr><td class="paramname">y</td><td>The top-left corner y value of the viewport. </td></tr>
<tr><td class="paramname">w</td><td>The width of the viewport. Must be greater than 0. </td></tr>
<tr><td class="paramname">h</td><td>The height of the viewport. Must be greater than 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<div id="push"></div>
</div> <!-- #content -->
</div> <!-- .layout -->
</div> <!-- #container -->
<div id="footer">
<table><tr>
<td class="poweredby"><img src="doxygen.png"></td>
<td class="copyright">Copyright ©2011 Enlightenment</td>
<td class="generated">Docs generated Thu Jul 14 2011 20:45:33</td>
</tr></table>
</div>
</body>
</html>
