GED 2006 (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GED 2006: SharedObject Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>SharedObject Class Reference</h1><!-- doxytag: class="SharedObject" --><code>#include <<a class="el" href="pluginsupport_8h-source.html">pluginsupport.h</a>></code>
<p>
<a href="classSharedObject-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#444069c56bced391ac78ca5ab42654e2">pFB</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#c47f2547fe697f44f7997a8f238df66f">shmBitmap</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#034479606c674cca631becc33f31ae1e">bitmapAlloc</a> (<a class="el" href="structBoxSize.html">BoxSize</a> &size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#e63f2cd402837491378e76bcaf13197c">bitmapFree</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPixel.html">Pixel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#0e9028adb4928c00b32350b27418eb31">bitmapAttach</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#1e01bc0962640694e8fbfc2c70ef8870">detach</a> (<a class="el" href="structPixel.html">Pixel</a> *addr)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#236aa9dd603e636f8eefc598f5ca457c">create</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> &fb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#a31e5a0aeb969df595c4a7af1a4f33b3">destroy</a> (int shmID)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classSharedObject.html">SharedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#64df856e91692b9d602e3f875dbed889">attach</a> (int shmID)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedObject.html#0a414ab77ef0a03d5221479319813e5c">detach</a> (<a class="el" href="classSharedObject.html">SharedObject</a> *addr)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
IPC shared object
<p>
<p>
Definition at line <a class="el" href="pluginsupport_8h-source.html#l00108">108</a> of file <a class="el" href="pluginsupport_8h-source.html">pluginsupport.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="444069c56bced391ac78ca5ab42654e2"></a><!-- doxytag: member="SharedObject::pFB" ref="444069c56bced391ac78ca5ab42654e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFrameBuffer.html">FrameBuffer</a>* SharedObject::pFB </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return pointer to frame buffer. </dd></dl>
<p>
Definition at line <a class="el" href="pluginsupport_8h-source.html#l00113">113</a> of file <a class="el" href="pluginsupport_8h-source.html">pluginsupport.h</a>.
</div>
</div><p>
<a class="anchor" name="c47f2547fe697f44f7997a8f238df66f"></a><!-- doxytag: member="SharedObject::shmBitmap" ref="c47f2547fe697f44f7997a8f238df66f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SharedObject::shmBitmap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return shmID for image bitmap. </dd></dl>
<p>
Definition at line <a class="el" href="pluginsupport_8h-source.html#l00118">118</a> of file <a class="el" href="pluginsupport_8h-source.html">pluginsupport.h</a>.
</div>
</div><p>
<a class="anchor" name="236aa9dd603e636f8eefc598f5ca457c"></a><!-- doxytag: member="SharedObject::create" ref="236aa9dd603e636f8eefc598f5ca457c" args="(FrameBuffer &fb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int SharedObject::create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> & </td>
<td class="paramname"> <em>fb</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create shared object from plain frame buffer. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fb</em> </td><td>Source frame buffer. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return id of shared object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a31e5a0aeb969df595c4a7af1a4f33b3"></a><!-- doxytag: member="SharedObject::destroy" ref="a31e5a0aeb969df595c4a7af1a4f33b3" args="(int shmID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void SharedObject::destroy </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>shmID</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy shared object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>shmID</em> </td><td>Id returned by <a class="el" href="classSharedObject.html#236aa9dd603e636f8eefc598f5ca457c">SharedObject::create()</a> method. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="64df856e91692b9d602e3f875dbed889"></a><!-- doxytag: member="SharedObject::attach" ref="64df856e91692b9d602e3f875dbed889" args="(int shmID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classSharedObject.html">SharedObject</a>* SharedObject::attach </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>shmID</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach process to shared object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>shmID</em> </td><td>Id of shared object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return address of shared object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0a414ab77ef0a03d5221479319813e5c"></a><!-- doxytag: member="SharedObject::detach" ref="0a414ab77ef0a03d5221479319813e5c" args="(SharedObject *addr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void SharedObject::detach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSharedObject.html">SharedObject</a> * </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach process from shared object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>Address of shared object returned by <a class="el" href="classSharedObject.html#64df856e91692b9d602e3f875dbed889">SharedObject::attach()</a> method. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="034479606c674cca631becc33f31ae1e"></a><!-- doxytag: member="SharedObject::bitmapAlloc" ref="034479606c674cca631becc33f31ae1e" args="(BoxSize &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SharedObject::bitmapAlloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structBoxSize.html">BoxSize</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate shared bitmap. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Size of bitmap. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e63f2cd402837491378e76bcaf13197c"></a><!-- doxytag: member="SharedObject::bitmapFree" ref="e63f2cd402837491378e76bcaf13197c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SharedObject::bitmapFree </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free shared memory allocated by <a class="el" href="classSharedObject.html#034479606c674cca631becc33f31ae1e">SharedObject::bitmapAlloc()</a> method.
</div>
</div><p>
<a class="anchor" name="0e9028adb4928c00b32350b27418eb31"></a><!-- doxytag: member="SharedObject::bitmapAttach" ref="0e9028adb4928c00b32350b27418eb31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPixel.html">Pixel</a>* SharedObject::bitmapAttach </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach process to bitmap. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return address of attached bitmap. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1e01bc0962640694e8fbfc2c70ef8870"></a><!-- doxytag: member="SharedObject::detach" ref="1e01bc0962640694e8fbfc2c70ef8870" args="(Pixel *addr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SharedObject::detach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPixel.html">Pixel</a> * </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach process from bitmap. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>Address of shared object returned by <a class="el" href="classSharedObject.html#0e9028adb4928c00b32350b27418eb31">SharedObject::bitmapAttach()</a> method. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pluginsupport_8h-source.html">pluginsupport.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 29 00:01:04 2007 for GED 2006 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classSharedObject.html [Download]