<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xcm: X Color Management Core API's</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>X Color Management Core API's</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structXcolorProfile.html">XcolorProfile</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structXcolorRegion.html">XcolorRegion</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#gac3d636fe830a4f99c45781891bcde4cb">XcolorProfileUpload</a> (Display *dpy, <a class="el" href="structXcolorProfile.html">XcolorProfile</a> *profile)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uploads the profile into all screens of the display. <a href="#gac3d636fe830a4f99c45781891bcde4cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#ga048e39df2428724e6f67312a260cd590">XcolorProfileDelete</a> (Display *dpy, <a class="el" href="structXcolorProfile.html">XcolorProfile</a> *profile)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decreases the ref-count of the profile. <a href="#ga048e39df2428724e6f67312a260cd590"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#ga682343ef7b2f6128bf286b629792541b">XcolorRegionInsert</a> (Display *dpy, Window win, unsigned long pos, <a class="el" href="structXcolorRegion.html">XcolorRegion</a> *region, unsigned long nRegions)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts the supplied regions into the stack. <a href="#ga682343ef7b2f6128bf286b629792541b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structXcolorRegion.html">XcolorRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#ga552977f2c99ed2a0cd2393c99189490d">XcolorRegionFetch</a> (Display *dpy, Window win, unsigned long *nRegions)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetches the existing regions. <a href="#ga552977f2c99ed2a0cd2393c99189490d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#ga5f4ec32f4952e1bbce1836245b3e8cc2">XcolorRegionDelete</a> (Display *dpy, Window win, unsigned long start, unsigned long count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes regions. <a href="#ga5f4ec32f4952e1bbce1836245b3e8cc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Xcm.html#ga73e4212037989b224318b523aad74a91">XcolorRegionActivate</a> (Display *dpy, Window win, unsigned long start, unsigned long count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activates regions. <a href="#ga73e4212037989b224318b523aad74a91"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga048e39df2428724e6f67312a260cd590"></a><!-- doxytag: member="Xcm.h::XcolorProfileDelete" ref="ga048e39df2428724e6f67312a260cd590" args="(Display *dpy, XcolorProfile *profile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcolorProfileDelete </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXcolorProfile.html">XcolorProfile</a> * </td>
<td class="paramname"> <em>profile</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decreases the ref-count of the profile. </p>
<p>Function XcolorProfileDelete You shouldn't use the profile anymore after this call because it could have been removed from the internal database in the compositing manager. If you do, nothing bad will happen, just that color management won't work on regions that use this profile. </p>
</div>
</div>
<a class="anchor" id="gac3d636fe830a4f99c45781891bcde4cb"></a><!-- doxytag: member="Xcm.h::XcolorProfileUpload" ref="gac3d636fe830a4f99c45781891bcde4cb" args="(Display *dpy, XcolorProfile *profile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcolorProfileUpload </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXcolorProfile.html">XcolorProfile</a> * </td>
<td class="paramname"> <em>profile</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Uploads the profile into all screens of the display. </p>
<p>Function XcolorProfileUpload Uploads the profile into all screens of the display. Profiles are ref-counted inside the compositing manager, so make sure to call <a class="el" href="group__Xcm.html#ga048e39df2428724e6f67312a260cd590" title="Decreases the ref-count of the profile.">XcolorProfileDelete()</a> before your application exits or when you don't need the profile anymore. </p>
</div>
</div>
<a class="anchor" id="ga73e4212037989b224318b523aad74a91"></a><!-- doxytag: member="Xcm.h::XcolorRegionActivate" ref="ga73e4212037989b224318b523aad74a91" args="(Display *dpy, Window win, unsigned long start, unsigned long count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcolorRegionActivate </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"> <em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activates regions. </p>
<p>Function XcolorRegionActivate Activates 'count' regions starting at positiong 'start' in the stack. Unlike the other functions it does not check whether 'start + count' extends beyond the stack end. To disable all regions pass zero to 'count'. </p>
</div>
</div>
<a class="anchor" id="ga5f4ec32f4952e1bbce1836245b3e8cc2"></a><!-- doxytag: member="Xcm.h::XcolorRegionDelete" ref="ga5f4ec32f4952e1bbce1836245b3e8cc2" args="(Display *dpy, Window win, unsigned long start, unsigned long count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcolorRegionDelete </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"> <em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes regions. </p>
<p>Function XcolorRegionDelete Deletes 'count' regions starting at 'start' in the stack. If 'start + count' in beyond the stack end, nothing will be done and the function returns '-1'. </p>
</div>
</div>
<a class="anchor" id="ga552977f2c99ed2a0cd2393c99189490d"></a><!-- doxytag: member="Xcm.h::XcolorRegionFetch" ref="ga552977f2c99ed2a0cd2393c99189490d" args="(Display *dpy, Window win, unsigned long *nRegions)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structXcolorRegion.html">XcolorRegion</a>* XcolorRegionFetch </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"> <em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long * </td>
<td class="paramname"> <em>nRegions</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches the existing regions. </p>
<p>Function XcolorRegionFetch Fetches the existing regions and returns an array of 'XcolorRegion'. After you're done, free the array using XFree(). The number of regions is put into 'nRegions'. </p>
</div>
</div>
<a class="anchor" id="ga682343ef7b2f6128bf286b629792541b"></a><!-- doxytag: member="Xcm.h::XcolorRegionInsert" ref="ga682343ef7b2f6128bf286b629792541b" args="(Display *dpy, Window win, unsigned long pos, XcolorRegion *region, unsigned long nRegions)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcolorRegionInsert </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"> <em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"> <em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXcolorRegion.html">XcolorRegion</a> * </td>
<td class="paramname"> <em>region</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>nRegions</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts the supplied regions into the stack. </p>
<p>Function XcolorRegionInsert Inserts the supplied regions into the stack at the position 'pos', shifting the existing profiles upwards in the stack. If 'pos' is beyond the stack end, nothing will be done and the function returns '-1'. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Jan 7 2011 for Xcm by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
x86_64
>
media
>
updates
>
by-pkgid
>
016f37853498e153dba5892061587760
>
files
>
21
