<html>
<head>
<title>Ecore: X Shape extension</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" href="e.css">
<link rel="stylesheet" type="text/css" 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>
<table cellspacing="0" cellpadding="0" width="100%"><tr>
<td id="header_logo">
<a href="http://www.enlightenment.org"></a>
</td>
<td id="header_menu">
<table cellspacing="0" cellpadding="0" align="right"><tr>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=home">Home</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=news">News</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=about">About</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=download">Download</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=support">Support</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contact">Contact</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://trac.enlightenment.org/e">Tracker</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=docs">Docs</a></td>
</tr></table>
</td>
<td id="header_last"></td>
</tr></table>
<div class="doxytitle">
Ecore Documentation <small>at 2 Jul 2010</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<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.6.2-20100208 -->
<div class="contents">
<h1>X Shape extension</h1>
<p>Functions that use the shape extension of the X server to change shape of given windows.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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__Ecore__X__Shape__Group.html#gaea95067057a3486da393698b636317d9">ecore_x_window_shape_mask_set</a> (Ecore_X_Window dest_win, Ecore_X_Pixmap source_mask)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the shape of the given window to the given pixmap. <a href="#gaea95067057a3486da393698b636317d9"></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__Ecore__X__Shape__Group.html#gabb308c760ce2764ad4c8baa513203fc1">ecore_x_window_shape_rectangle_set</a> (Ecore_X_Window dest_win, int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the shape of the given window to a rectangle. <a href="#gabb308c760ce2764ad4c8baa513203fc1"></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__Ecore__X__Shape__Group.html#ga74946b8f12f5159e4a682512933a3d18">ecore_x_window_shape_rectangles_get_prefetch</a> (Ecore_X_Window window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends the ShapeGetRectangles request. <a href="#ga74946b8f12f5159e4a682512933a3d18"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab9cf8440f79e4242eb07e65227117404"></a><!-- doxytag: member="Ecore_X_Shape_Group::ecore_x_window_shape_rectangles_get_fetch" ref="gab9cf8440f79e4242eb07e65227117404" args="(void)" -->
EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__X__Shape__Group.html#gab9cf8440f79e4242eb07e65227117404">ecore_x_window_shape_rectangles_get_fetch</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the reply of the ShapeGetRectangles request sent by <a class="el" href="group__Ecore__X__Shape__Group.html#ga74946b8f12f5159e4a682512933a3d18" title="Sends the ShapeGetRectangles request.">ecore_x_window_shape_rectangles_get_prefetch()</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI Ecore_X_Rectangle * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__X__Shape__Group.html#ga3c8761f16e5732d395797bc02d289052">ecore_x_window_shape_rectangles_get</a> (Ecore_X_Window window __UNUSED__, int *num_ret)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">To document. <a href="#ga3c8761f16e5732d395797bc02d289052"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that use the shape extension of the X server to change shape of given windows. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaea95067057a3486da393698b636317d9"></a><!-- doxytag: member="ecore_xcb_shape.c::ecore_x_window_shape_mask_set" ref="gaea95067057a3486da393698b636317d9" args="(Ecore_X_Window dest_win, Ecore_X_Pixmap source_mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_x_window_shape_mask_set </td>
<td>(</td>
<td class="paramtype">Ecore_X_Window </td>
<td class="paramname"> <em>dest_win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Ecore_X_Pixmap </td>
<td class="paramname"> <em>source_mask</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the shape of the given window to the given pixmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest_win</em> </td><td>The given window. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_mask</em> </td><td>A 2-bit depth pixmap that provides the new shape of the window.</td></tr>
</table>
</dd>
</dl>
<p>Sets the shape of the window <code>dest_win</code> to the pixmap <code>source_mask</code>. </p>
</div>
</div>
<a class="anchor" id="gabb308c760ce2764ad4c8baa513203fc1"></a><!-- doxytag: member="ecore_xcb_shape.c::ecore_x_window_shape_rectangle_set" ref="gabb308c760ce2764ad4c8baa513203fc1" args="(Ecore_X_Window dest_win, int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_x_window_shape_rectangle_set </td>
<td>(</td>
<td class="paramtype">Ecore_X_Window </td>
<td class="paramname"> <em>dest_win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the shape of the given window to a rectangle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest_win</em> </td><td>The given window. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>The X coordinate of the top left corner of the rectangle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>The Y coordinate of the top left corner of the rectangle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>The width of the rectangle. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>The height of the rectangle.</td></tr>
</table>
</dd>
</dl>
<p>Sets the shape of the window <code>dest_win</code> to a rectangle defined by <code>x</code>, <code>y</code>, <code>width</code> and <code>height</code>. </p>
</div>
</div>
<a class="anchor" id="ga3c8761f16e5732d395797bc02d289052"></a><!-- doxytag: member="ecore_xcb_shape.c::ecore_x_window_shape_rectangles_get" ref="ga3c8761f16e5732d395797bc02d289052" args="(Ecore_X_Window window __UNUSED__, int *num_ret)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI Ecore_X_Rectangle* ecore_x_window_shape_rectangles_get </td>
<td>(</td>
<td class="paramtype">Ecore_X_Window window </td>
<td class="paramname"> <em>__UNUSED__</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>num_ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>To document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em> </td><td>Unused. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num_ret</em> </td><td>To document. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>To document.</dd></dl>
<p>To use this function, you must call before, and in order, <a class="el" href="group__Ecore__X__Shape__Group.html#ga74946b8f12f5159e4a682512933a3d18" title="Sends the ShapeGetRectangles request.">ecore_x_window_shape_rectangles_get_prefetch()</a>, which sends the ShapeGetRectangles request, then <a class="el" href="group__Ecore__X__Shape__Group.html#gab9cf8440f79e4242eb07e65227117404" title="Gets the reply of the ShapeGetRectangles request sent by ecore_x_window_shape_rectangles_get_prefetc...">ecore_x_window_shape_rectangles_get_fetch()</a>, which gets the reply. </p>
</div>
</div>
<a class="anchor" id="ga74946b8f12f5159e4a682512933a3d18"></a><!-- doxytag: member="ecore_xcb_shape.c::ecore_x_window_shape_rectangles_get_prefetch" ref="ga74946b8f12f5159e4a682512933a3d18" args="(Ecore_X_Window window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_x_window_shape_rectangles_get_prefetch </td>
<td>(</td>
<td class="paramtype">Ecore_X_Window </td>
<td class="paramname"> <em>window</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends the ShapeGetRectangles request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em> </td><td>Requested window. </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="copyright">Copyright ©2010 Enlightenment</td>
<td class="generated">Docs generated Fri Jul 2 12:11:50 2010</td>
</tr></table>
</div>
</body>
</html>
