source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1HardwareBufferLicensee.html @ 657

Revision 657, 7.2 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::HardwareBufferLicensee class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::HardwareBufferLicensee Class Reference</h1>Abtract interface representing a 'licensee' of a hardware buffer copy. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreHardwareBufferManager_8h-source.html">OgreHardwareBufferManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::HardwareBufferLicensee:
16<p><center><img src="classOgre_1_1HardwareBufferLicensee.png" usemap="#Ogre::HardwareBufferLicensee_map" border="0" alt=""></center>
17<map name="Ogre::HardwareBufferLicensee_map">
18<area href="classOgre_1_1TempBlendedBufferInfo.html" alt="Ogre::TempBlendedBufferInfo" shape="rect" coords="0,56,189,80">
19</map>
20<a href="classOgre_1_1HardwareBufferLicensee-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBufferLicensee.html#Ogre_1_1HardwareBufferLicenseea0">~HardwareBufferLicensee</a> ()</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBufferLicensee.html#Ogre_1_1HardwareBufferLicenseea1">licenseExpired</a> (<a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> *buffer)=0</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is called when the buffer license is expired and is about to be returned to the shared pool.  <a href="#Ogre_1_1HardwareBufferLicenseea1"></a><br><br></td></tr>
28</table>
29<hr><a name="_details"></a><h2>Detailed Description</h2>
30Abtract interface representing a 'licensee' of a hardware buffer copy.
31<p>
32remarks Often it's useful to have temporary buffers which are used for working but are not necessarily needed permanently. However, creating and destroying buffers is expensive, so we need a way to share these working areas, especially those based on existing fixed buffers. This class represents a licensee of one of those temporary buffers, and must be implemented by any user of a temporary buffer if they wish to be notified when the license is expired.
33<p>
34
35<p>
36Definition at line <a class="el" href="OgreHardwareBufferManager_8h-source.html#l00048">48</a> of file <a class="el" href="OgreHardwareBufferManager_8h-source.html">OgreHardwareBufferManager.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
37<a class="anchor" name="Ogre_1_1HardwareBufferLicenseea0" doxytag="Ogre::HardwareBufferLicensee::~HardwareBufferLicensee" ></a><p>
38<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
39  <tr>
40    <td class="mdRow">
41      <table cellpadding="0" cellspacing="0" border="0">
42        <tr>
43          <td class="md" nowrap valign="top"> virtual Ogre::HardwareBufferLicensee::~<a class="el" href="classOgre_1_1HardwareBufferLicensee.html">HardwareBufferLicensee</a> </td>
44          <td class="md" valign="top">(&nbsp;</td>
45          <td class="mdname1" valign="top" nowrap>          </td>
46          <td class="md" valign="top">&nbsp;)&nbsp;</td>
47          <td class="md" nowrap><code> [virtual]</code></td>
48        </tr>
49
50      </table>
51    </td>
52  </tr>
53</table>
54<table cellspacing=5 cellpadding=0 border=0>
55  <tr>
56    <td>
57      &nbsp;
58    </td>
59    <td>
60
61<p>
62
63<p>
64Definition at line <a class="el" href="OgreHardwareBufferManager_8h-source.html#l00051">51</a> of file <a class="el" href="OgreHardwareBufferManager_8h-source.html">OgreHardwareBufferManager.h</a>.    </td>
65  </tr>
66</table>
67<hr><h2>Member Function Documentation</h2>
68<a class="anchor" name="Ogre_1_1HardwareBufferLicenseea1" doxytag="Ogre::HardwareBufferLicensee::licenseExpired" ></a><p>
69<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
70  <tr>
71    <td class="mdRow">
72      <table cellpadding="0" cellspacing="0" border="0">
73        <tr>
74          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBufferLicensee::licenseExpired </td>
75          <td class="md" valign="top">(&nbsp;</td>
76          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> *&nbsp;</td>
77          <td class="mdname1" valign="top" nowrap> <em>buffer</em>          </td>
78          <td class="md" valign="top">&nbsp;)&nbsp;</td>
79          <td class="md" nowrap><code> [pure virtual]</code></td>
80        </tr>
81
82      </table>
83    </td>
84  </tr>
85</table>
86<table cellspacing=5 cellpadding=0 border=0>
87  <tr>
88    <td>
89      &nbsp;
90    </td>
91    <td>
92
93<p>
94This method is called when the buffer license is expired and is about to be returned to the shared pool.
95<p>
96
97<p>
98Implemented in <a class="el" href="classOgre_1_1TempBlendedBufferInfo.html#Ogre_1_1TempBlendedBufferInfoa3">Ogre::TempBlendedBufferInfo</a>.    </td>
99  </tr>
100</table>
101<hr>The documentation for this class was generated from the following file:<ul>
102<li><a class="el" href="OgreHardwareBufferManager_8h-source.html">OgreHardwareBufferManager.h</a></ul>
103<hr>
104<p>
105Copyright &copy; 2000-2005 by The OGRE Team<br />
106<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
107This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
108                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
109                <Work rdf:about="">
110                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
111        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
112                </Work>
113                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
114
115Last modified Sun Feb 12 13:00:39 2006
116</p>
117</body>
118</html>
Note: See TracBrowser for help on using the repository browser.