<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>cairomm: Cairo::Device Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">cairomm
 <span id="projectnumber">1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCairo.html">Cairo</a></li><li class="navelem"><a class="el" href="classCairo_1_1Device.html">Device</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classCairo_1_1Device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Cairo::Device Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Devices are the abstraction <a class="el" href="namespaceCairo.html">Cairo</a> employs for the rendering system used by a cairo_surface_t.
<a href="classCairo_1_1Device.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device_1_1Lock.html">Lock</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A convenience class for acquiring a <a class="el" href="classCairo_1_1Device.html" title="Devices are the abstraction Cairo employs for the rendering system used by a cairo_surface_t. ">Device</a> object in an exception-safe manner. <a href="classCairo_1_1Device_1_1Lock.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a327c8a8ac39f484f68a550ae34f82411"><td class="memItemLeft" align="right" valign="top">typedef cairo_device_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a></td></tr>
<tr class="separator:a327c8a8ac39f484f68a550ae34f82411"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aec567647cc3675369f49fdcc469c6132"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#aec567647cc3675369f49fdcc469c6132">Device</a> (cairo_device_t*<a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>, bool has_reference=false)</td></tr>
<tr class="memdesc:aec567647cc3675369f49fdcc469c6132"><td class="mdescLeft"> </td><td class="mdescRight">Create a C++ wrapper for the C instance. <a href="#aec567647cc3675369f49fdcc469c6132">More...</a><br /></td></tr>
<tr class="separator:aec567647cc3675369f49fdcc469c6132"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94fd2ef7446a1653e7e7a8e2642ec826"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a94fd2ef7446a1653e7e7a8e2642ec826">~Device</a> ()</td></tr>
<tr class="separator:a94fd2ef7446a1653e7e7a8e2642ec826"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73a80a27c988f840701272fd571f9b5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCairo.html#acd6c59cfdf7e4c9df93011f5dcf9b55c">DeviceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a73a80a27c988f840701272fd571f9b5d">get_type</a> () const </td></tr>
<tr class="memdesc:a73a80a27c988f840701272fd571f9b5d"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the type of the device. <a href="#a73a80a27c988f840701272fd571f9b5d">More...</a><br /></td></tr>
<tr class="separator:a73a80a27c988f840701272fd571f9b5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c41a4a0a95d25fa60012036d165abd9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a8c41a4a0a95d25fa60012036d165abd9">flush</a> ()</td></tr>
<tr class="memdesc:a8c41a4a0a95d25fa60012036d165abd9"><td class="mdescLeft"> </td><td class="mdescRight">Finish any pending operations for the device and also restore any temporary modifications cairo has made to the device's state. <a href="#a8c41a4a0a95d25fa60012036d165abd9">More...</a><br /></td></tr>
<tr class="separator:a8c41a4a0a95d25fa60012036d165abd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe9262cdb04d7ec3f58d48333d1898f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#afe9262cdb04d7ec3f58d48333d1898f5">finish</a> ()</td></tr>
<tr class="memdesc:afe9262cdb04d7ec3f58d48333d1898f5"><td class="mdescLeft"> </td><td class="mdescRight">This function finishes the device and drops all references to external resources. <a href="#afe9262cdb04d7ec3f58d48333d1898f5">More...</a><br /></td></tr>
<tr class="separator:afe9262cdb04d7ec3f58d48333d1898f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedd60074545b2d744fda80fde40bfb79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#aedd60074545b2d744fda80fde40bfb79">acquire</a> ()</td></tr>
<tr class="memdesc:aedd60074545b2d744fda80fde40bfb79"><td class="mdescLeft"> </td><td class="mdescRight">Acquires the device for the current thread. <a href="#aedd60074545b2d744fda80fde40bfb79">More...</a><br /></td></tr>
<tr class="separator:aedd60074545b2d744fda80fde40bfb79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a044504de9e04b01d52a65521f48c0556"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a044504de9e04b01d52a65521f48c0556">release</a> ()</td></tr>
<tr class="memdesc:a044504de9e04b01d52a65521f48c0556"><td class="mdescLeft"> </td><td class="mdescRight">Releases a device previously acquired using <a class="el" href="classCairo_1_1Device.html#aedd60074545b2d744fda80fde40bfb79" title="Acquires the device for the current thread. ">acquire()</a>. <a href="#a044504de9e04b01d52a65521f48c0556">More...</a><br /></td></tr>
<tr class="separator:a044504de9e04b01d52a65521f48c0556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af460646f6002455f842ad763051bc86c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#af460646f6002455f842ad763051bc86c">cobj</a> ()</td></tr>
<tr class="separator:af460646f6002455f842ad763051bc86c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad873aed7e520543740e1b886668dd568"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#ad873aed7e520543740e1b886668dd568">cobj</a> () const </td></tr>
<tr class="separator:ad873aed7e520543740e1b886668dd568"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f5bce224e01fa9fc98306361ae4e14f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a5f5bce224e01fa9fc98306361ae4e14f">reference</a> () const </td></tr>
<tr class="separator:a5f5bce224e01fa9fc98306361ae4e14f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a633b0e213b716ff4427f00025f53477f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a633b0e213b716ff4427f00025f53477f">unreference</a> () const </td></tr>
<tr class="separator:a633b0e213b716ff4427f00025f53477f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2252dec9ccb0905a5b74491d4b09315d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Device.html#a2252dec9ccb0905a5b74491d4b09315d">m_cobject</a></td></tr>
<tr class="separator:a2252dec9ccb0905a5b74491d4b09315d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Devices are the abstraction <a class="el" href="namespaceCairo.html">Cairo</a> employs for the rendering system used by a cairo_surface_t. </p>
<p>You can get the device of a surface using <a class="el" href="classCairo_1_1Surface.html#a3d1f19c2210e0e7a4aa3d3053b90107f" title="This function returns the device for a surface. ">Surface::get_device()</a>.</p>
<p>Devices are created using custom functions specific to the rendering system you want to use. See the documentation for the surface types for those functions.</p>
<p>An important function that devices fulfill is sharing access to the rendering system between <a class="el" href="namespaceCairo.html">Cairo</a> and your application. If you want to access a device directly that you used to draw to with <a class="el" href="namespaceCairo.html">Cairo</a>, you must first call <a class="el" href="classCairo_1_1Device.html#a8c41a4a0a95d25fa60012036d165abd9" title="Finish any pending operations for the device and also restore any temporary modifications cairo has m...">flush()</a> to ensure that <a class="el" href="namespaceCairo.html">Cairo</a> finishes all operations on the device and resets it to a clean state.</p>
<p><a class="el" href="namespaceCairo.html">Cairo</a> also provides the functions <a class="el" href="classCairo_1_1Device.html#aedd60074545b2d744fda80fde40bfb79" title="Acquires the device for the current thread. ">acquire()</a> and <a class="el" href="classCairo_1_1Device.html#a044504de9e04b01d52a65521f48c0556" title="Releases a device previously acquired using acquire(). ">release()</a> to synchronize access to the rendering system in a multithreaded environment. This is done internally, but can also be used by applications. There is also a <a class="el" href="classCairo_1_1Device_1_1Lock.html" title="A convenience class for acquiring a Device object in an exception-safe manner. ">Device::Lock</a> convenience class that allows the device to be acquired and released in an exception-safe manner.</p>
<p>This is a reference-counted object that should be used via <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer. ">Cairo::RefPtr</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10 </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a327c8a8ac39f484f68a550ae34f82411"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef cairo_device_t <a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">Cairo::Device::cobject</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aec567647cc3675369f49fdcc469c6132"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Cairo::Device::Device </td>
<td>(</td>
<td class="paramtype">cairo_device_t * </td>
<td class="paramname"><em>cobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>has_reference</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a C++ wrapper for the C instance. </p>
<p>This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer. ">RefPtr</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cobject</td><td>The C instance. </td></tr>
<tr><td class="paramname">has_reference</td><td>Whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a94fd2ef7446a1653e7e7a8e2642ec826"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Cairo::Device::~Device </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aedd60074545b2d744fda80fde40bfb79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::acquire </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquires the device for the current thread. </p>
<p>This function will block until no other thread has acquired the device.</p>
<p>If no exception is thrown, you successfully acquired the device. From now on your thread owns the device and no other thread will be able to acquire it until a matching call to <a class="el" href="classCairo_1_1Device.html#a044504de9e04b01d52a65521f48c0556" title="Releases a device previously acquired using acquire(). ">release()</a>. It is allowed to recursively acquire the device multiple times from the same thread.</p>
<dl class="section note"><dt>Note</dt><dd>It is recommended to use <a class="el" href="classCairo_1_1Device_1_1Lock.html" title="A convenience class for acquiring a Device object in an exception-safe manner. ">Device::Lock</a> to acquire devices in an exception-safe manner, rather than acquiring and releasing the device manually.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>You must never acquire two different devices at the same time unless this is explicitly allowed. Otherwise the possibility of deadlocks exist.</dd>
<dd>
As various <a class="el" href="namespaceCairo.html">Cairo</a> functions can acquire devices when called, these functions may also cause deadlocks when you call them with an acquired device. So you must not have a device acquired when calling them. These functions are marked in the documentation. </dd></dl>
</div>
</div>
<a class="anchor" id="af460646f6002455f842ad763051bc86c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* Cairo::Device::cobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad873aed7e520543740e1b886668dd568"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* Cairo::Device::cobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afe9262cdb04d7ec3f58d48333d1898f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::finish </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function finishes the device and drops all references to external resources. </p>
<p>All surfaces, fonts and other objects created for this device will be finished, too. Further operations on the device will not affect the device but will instead trigger a DEVICE_FINISHED error.</p>
<p>When the last reference to the device is dropped, cairo will call <a class="el" href="classCairo_1_1Device.html#afe9262cdb04d7ec3f58d48333d1898f5" title="This function finishes the device and drops all references to external resources. ...">finish()</a> if it hasn't been called already, before freeing the resources associated with the device.</p>
<p>This function may acquire devices. </p>
</div>
</div>
<a class="anchor" id="a8c41a4a0a95d25fa60012036d165abd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finish any pending operations for the device and also restore any temporary modifications cairo has made to the device's state. </p>
<p>This function must be called before switching from using the device with <a class="el" href="namespaceCairo.html">Cairo</a> to operating on it directly with native APIs. If the device doesn't support direct access, then this function does nothing.</p>
<p>This function may acquire devices. </p>
</div>
</div>
<a class="anchor" id="a73a80a27c988f840701272fd571f9b5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceCairo.html#acd6c59cfdf7e4c9df93011f5dcf9b55c">DeviceType</a> Cairo::Device::get_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the type of the device. </p>
</div>
</div>
<a class="anchor" id="a5f5bce224e01fa9fc98306361ae4e14f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::reference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a044504de9e04b01d52a65521f48c0556"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases a device previously acquired using <a class="el" href="classCairo_1_1Device.html#aedd60074545b2d744fda80fde40bfb79" title="Acquires the device for the current thread. ">acquire()</a>. </p>
</div>
</div>
<a class="anchor" id="a633b0e213b716ff4427f00025f53477f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Device::unreference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a2252dec9ccb0905a5b74491d4b09315d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCairo_1_1Device.html#a327c8a8ac39f484f68a550ae34f82411">cobject</a>* Cairo::Device::m_cobject</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cairomm/device.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 21 2015 21:56:36 for cairomm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>