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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::HardwareBuffer 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::HardwareBuffer Class Reference</h1>Abstract class defining common features of hardware buffers. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::HardwareBuffer:
16<p><center><img src="classOgre_1_1HardwareBuffer.png" usemap="#Ogre::HardwareBuffer_map" border="0" alt=""></center>
17<map name="Ogre::HardwareBuffer_map">
18<area href="classOgre_1_1HardwareIndexBuffer.html" alt="Ogre::HardwareIndexBuffer" shape="rect" coords="0,56,231,80">
19<area href="classOgre_1_1HardwarePixelBuffer.html" alt="Ogre::HardwarePixelBuffer" shape="rect" coords="482,56,713,80">
20<area href="classOgre_1_1HardwareVertexBuffer.html" alt="Ogre::HardwareVertexBuffer" shape="rect" coords="964,56,1195,80">
21<area href="classOgre_1_1D3D9HardwareIndexBuffer.html" alt="Ogre::D3D9HardwareIndexBuffer" shape="rect" coords="241,112,472,136">
22<area href="classOgre_1_1DefaultHardwareIndexBuffer.html" alt="Ogre::DefaultHardwareIndexBuffer" shape="rect" coords="241,168,472,192">
23<area href="classOgre_1_1GLDefaultHardwareIndexBuffer.html" alt="Ogre::GLDefaultHardwareIndexBuffer" shape="rect" coords="241,224,472,248">
24<area href="classOgre_1_1GLHardwareIndexBuffer.html" alt="Ogre::GLHardwareIndexBuffer" shape="rect" coords="241,280,472,304">
25<area href="classOgre_1_1D3D7HardwarePixelBuffer.html" alt="Ogre::D3D7HardwarePixelBuffer" shape="rect" coords="723,112,954,136">
26<area href="classOgre_1_1D3D9HardwarePixelBuffer.html" alt="Ogre::D3D9HardwarePixelBuffer" shape="rect" coords="723,168,954,192">
27<area href="classOgre_1_1GLHardwarePixelBuffer.html" alt="Ogre::GLHardwarePixelBuffer" shape="rect" coords="723,224,954,248">
28<area href="classOgre_1_1D3D9HardwareVertexBuffer.html" alt="Ogre::D3D9HardwareVertexBuffer" shape="rect" coords="1205,112,1436,136">
29<area href="classOgre_1_1DefaultHardwareVertexBuffer.html" alt="Ogre::DefaultHardwareVertexBuffer" shape="rect" coords="1205,168,1436,192">
30<area href="classOgre_1_1GLDefaultHardwareVertexBuffer.html" alt="Ogre::GLDefaultHardwareVertexBuffer" shape="rect" coords="1205,224,1436,248">
31<area href="classOgre_1_1GLHardwareVertexBuffer.html" alt="Ogre::GLHardwareVertexBuffer" shape="rect" coords="1205,280,1436,304">
32</map>
33<a href="classOgre_1_1HardwareBuffer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
34<tr><td></td></tr>
35<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a> { <br>
37&nbsp;&nbsp;<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw0">HBU_STATIC</a> =  1,
38<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw1">HBU_DYNAMIC</a> =  2,
39<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw2">HBU_WRITE_ONLY</a> =  4,
40<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw3">HBU_DISCARDABLE</a> =  8,
41<br>
42&nbsp;&nbsp;<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw4">HBU_STATIC_WRITE_ONLY</a> =  5,
43<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw5">HBU_DYNAMIC_WRITE_ONLY</a> =  6,
44<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw6">HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE</a> =  14
45<br>
46 }</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enums describing buffer usage; not mutually exclusive.  <a href="#Ogre_1_1HardwareVertexBufferw11">More...</a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a> { <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw7">HBL_NORMAL</a>,
50<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw8">HBL_DISCARD</a>,
51<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw9">HBL_READ_ONLY</a>,
52<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw10">HBL_NO_OVERWRITE</a>
53 }</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Locking options.  <a href="#Ogre_1_1HardwareVertexBufferw12">More...</a><br><br></td></tr>
56<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareBuffera0">HardwareBuffer</a> (<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a> usage, bool systemMemory, bool useShadowBuffer)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, to be called by <a class="el" href="classOgre_1_1HardwareBufferManager.html">HardwareBufferManager</a> only.  <a href="#Ogre_1_1HardwareBuffera0"></a><br><br></td></tr>
60<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareBuffera1">~HardwareBuffer</a> ()</td></tr>
61
62<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera4">lock</a> (size_t offset, size_t length, <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a> options)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock the buffer for (potentially) reading / writing.  <a href="#Ogre_1_1HardwareVertexBuffera4"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera5">lock</a> (<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a> options)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock the entire buffer for (potentially) reading / writing.  <a href="#Ogre_1_1HardwareVertexBuffera5"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock</a> (void)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases the lock on this buffer.  <a href="#Ogre_1_1HardwareVertexBuffera6"></a><br><br></td></tr>
71<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera7">readData</a> (size_t offset, size_t length, void *pDest)=0</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads data from the buffer and places it in the memory pointed to by pDest.  <a href="#Ogre_1_1HardwareVertexBuffera7"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera8">writeData</a> (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)=0</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.  <a href="#Ogre_1_1HardwareVertexBuffera8"></a><br><br></td></tr>
77<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera9">copyData</a> (<a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> &amp;srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy data from another buffer into this one.  <a href="#Ogre_1_1HardwareVertexBuffera9"></a><br><br></td></tr>
80<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera10">_updateFromShadow</a> (void)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the real buffer from the shadow buffer, if required.  <a href="#Ogre_1_1HardwareVertexBuffera10"></a><br><br></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera11">getSizeInBytes</a> (void) const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the size of this buffer in bytes.  <a href="#Ogre_1_1HardwareVertexBuffera11"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera12">getUsage</a> (void) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the Usage flags with which this buffer was created.  <a href="#Ogre_1_1HardwareVertexBuffera12"></a><br><br></td></tr>
89<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera13">isSystemMemory</a> (void) const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this buffer is held in system memory.  <a href="#Ogre_1_1HardwareVertexBuffera13"></a><br><br></td></tr>
92<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera14">hasShadowBuffer</a> (void) const </td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this buffer has a system memory shadow for quicker reading.  <a href="#Ogre_1_1HardwareVertexBuffera14"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera15">isLocked</a> (void) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not this buffer is currently locked.  <a href="#Ogre_1_1HardwareVertexBuffera15"></a><br><br></td></tr>
98<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera16">suppressHardwareUpdate</a> (bool suppress)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Pass.html">Pass</a> true to suppress hardware upload of shadow buffer changes.  <a href="#Ogre_1_1HardwareVertexBuffera16"></a><br><br></td></tr>
101<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
102<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferb0">lockImpl</a> (size_t offset, size_t length, <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a> options)=0</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera4">lock()</a>.  <a href="#Ogre_1_1HardwareVertexBufferb0"></a><br><br></td></tr>
105<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferb1">unlockImpl</a> (void)=0</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock()</a>.  <a href="#Ogre_1_1HardwareVertexBufferb1"></a><br><br></td></tr>
108<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
109<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp2">mSizeInBytes</a></td></tr>
110
111<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp3">mUsage</a></td></tr>
112
113<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp4">mIsLocked</a></td></tr>
114
115<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp5">mLockStart</a></td></tr>
116
117<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp6">mLockSize</a></td></tr>
118
119<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp7">mSystemMemory</a></td></tr>
120
121<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp8">mUseShadowBuffer</a></td></tr>
122
123<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp9">mpShadowBuffer</a></td></tr>
124
125<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp10">mShadowUpdated</a></td></tr>
126
127<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp11">mSuppressHardwareUpdate</a></td></tr>
128
129</table>
130<hr><a name="_details"></a><h2>Detailed Description</h2>
131Abstract class defining common features of hardware buffers.
132<p>
133<dl compact><dt><b>Remarks:</b></dt><dd>A 'hardware buffer' is any area of memory held outside of core system ram, and in our case refers mostly to video ram, although in theory this class could be used with other memory areas such as sound card memory, custom coprocessor memory etc. </dd></dl>
134<dl compact><dt><b></b></dt><dd>This reflects the fact that memory held outside of main system RAM must be interacted with in a more formal fashion in order to promote cooperative and optimal usage of the buffers between the various processing units which manipulate them. </dd></dl>
135<dl compact><dt><b></b></dt><dd>This abstract class defines the core interface which is common to all buffers, whether it be vertex buffers, index buffers, texture memory or framebuffer memory etc. </dd></dl>
136<dl compact><dt><b></b></dt><dd>Buffers have the ability to be 'shadowed' in system memory, this is because the kinds of access allowed on hardware buffers is not always as flexible as that allowed for areas of system memory - for example it is often either impossible, or extremely undesirable from a performance standpoint to read from a hardware buffer; when writing to hardware buffers, you should also write every byte and do it sequentially. In situations where this is too restrictive, it is possible to create a hardware, write-only buffer (the most efficient kind) and to back it with a system memory 'shadow' copy which can be read and updated arbitrarily. <a class="el" href="namespaceOgre.html">Ogre</a> handles synchronising this buffer with the real hardware buffer (which should still be created with the HBU_DYNAMIC flag if you intend to update it very frequently). Whilst this approach does have it's own costs, such as increased memory overhead, these costs can often be outweighed by the performance benefits of using a more hardware efficient buffer. You should look for the 'useShadowBuffer' parameter on the creation methods used to create the buffer of the type you require (see <a class="el" href="classOgre_1_1HardwareBufferManager.html">HardwareBufferManager</a>) to enable this feature. </dd></dl>
137
138<p>
139
140<p>
141Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00064">64</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.<hr><h2>Member Enumeration Documentation</h2>
142<a class="anchor" name="Ogre_1_1HardwareVertexBufferw12" doxytag="Ogre::HardwareBuffer::LockOptions" ></a><p>
143<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
144  <tr>
145    <td class="mdRow">
146      <table cellpadding="0" cellspacing="0" border="0">
147        <tr>
148          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">Ogre::HardwareBuffer::LockOptions</a>
149      </table>
150    </td>
151  </tr>
152</table>
153<table cellspacing=5 cellpadding=0 border=0>
154  <tr>
155    <td>
156      &nbsp;
157    </td>
158    <td>
159
160<p>
161Locking options.
162<p>
163<dl compact><dt><b>Enumeration values: </b></dt><dd>
164<table border=0 cellspacing=2 cellpadding=0>
165<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw7" doxytag="HBL_NORMAL" ></a>HBL_NORMAL</em>&nbsp;</td><td>
166Normal mode, ie allows read/write and contents are preserved. </td></tr>
167<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw8" doxytag="HBL_DISCARD" ></a>HBL_DISCARD</em>&nbsp;</td><td>
168Discards the <em>entire</em> buffer while locking; this allows optimisation to be performed because synchronisation issues are relaxed.
169<p>
170Only allowed on buffers created with the HBU_DYNAMIC flag.</td></tr>
171<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw9" doxytag="HBL_READ_ONLY" ></a>HBL_READ_ONLY</em>&nbsp;</td><td>
172Lock the buffer for reading only.
173<p>
174Not allowed in buffers which are created with HBU_WRITE_ONLY. Mandatory on statuc buffers, ie those created without the HBU_DYNAMIC flag.</td></tr>
175<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw12Ogre_1_1HardwareVertexBufferw10" doxytag="HBL_NO_OVERWRITE" ></a>HBL_NO_OVERWRITE</em>&nbsp;</td><td>
176As HBL_NORMAL, except the application guarantees not to overwrite any region of the buffer which has already been used in this frame, can allow some optimisation on some APIs. </td></tr>
177</table>
178</dl>
179
180<p>
181Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00111">111</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
182  </tr>
183</table>
184<a class="anchor" name="Ogre_1_1HardwareVertexBufferw11" doxytag="Ogre::HardwareBuffer::Usage" ></a><p>
185<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
186  <tr>
187    <td class="mdRow">
188      <table cellpadding="0" cellspacing="0" border="0">
189        <tr>
190          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Ogre::HardwareBuffer::Usage</a>
191      </table>
192    </td>
193  </tr>
194</table>
195<table cellspacing=5 cellpadding=0 border=0>
196  <tr>
197    <td>
198      &nbsp;
199    </td>
200    <td>
201
202<p>
203Enums describing buffer usage; not mutually exclusive.
204<p>
205<dl compact><dt><b>Enumeration values: </b></dt><dd>
206<table border=0 cellspacing=2 cellpadding=0>
207<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw0" doxytag="HBU_STATIC" ></a>HBU_STATIC</em>&nbsp;</td><td>
208Static buffer which the application rarely modifies once created.
209<p>
210Modifying the contents of this buffer will involve a performance hit. </td></tr>
211<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw1" doxytag="HBU_DYNAMIC" ></a>HBU_DYNAMIC</em>&nbsp;</td><td>
212Indicates the application would like to modify this buffer with the CPU fairly often.
213<p>
214Buffers created with this flag will typically end up in AGP memory rather than video memory.</td></tr>
215<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw2" doxytag="HBU_WRITE_ONLY" ></a>HBU_WRITE_ONLY</em>&nbsp;</td><td>
216Indicates the application will never read the contents of the buffer back, it will only ever write data.
217<p>
218Locking a buffer with this flag will ALWAYS return a pointer to new, blank memory rather than the memory associated with the contents of the buffer; this avoids DMA stalls because you can write to a new memory area while the previous one is being used.</td></tr>
219<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw3" doxytag="HBU_DISCARDABLE" ></a>HBU_DISCARDABLE</em>&nbsp;</td><td>
220Indicates that the application will be refilling the contents of the buffer regularly (not just updating, but generating the contents from scratch), and therefore does not mind if the contents of the buffer are lost somehow and need to be recreated.
221<p>
222This allows and additional level of optimisation on the buffer. This option only really makes sense when combined with HBU_DYNAMIC_WRITE_ONLY. </td></tr>
223<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw4" doxytag="HBU_STATIC_WRITE_ONLY" ></a>HBU_STATIC_WRITE_ONLY</em>&nbsp;</td><td>
224Combination of HBU_STATIC and HBU_WRITE_ONLY. </td></tr>
225<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw5" doxytag="HBU_DYNAMIC_WRITE_ONLY" ></a>HBU_DYNAMIC_WRITE_ONLY</em>&nbsp;</td><td>
226Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.
227<p>
228If you use this, strongly consider using HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE instead if you update the entire contents of the buffer very regularly. </td></tr>
229<tr><td valign=top><em><a class="anchor" name="Ogre_1_1HardwareVertexBufferw11Ogre_1_1HardwareVertexBufferw6" doxytag="HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE" ></a>HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE</em>&nbsp;</td><td>
230Combination of HBU_DYNAMIC, HBU_WRITE_ONLY and HBU_DISCARDABLE. </td></tr>
231</table>
232</dl>
233
234<p>
235Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00069">69</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
236  </tr>
237</table>
238<hr><h2>Constructor &amp; Destructor Documentation</h2>
239<a class="anchor" name="Ogre_1_1HardwareBuffera0" doxytag="Ogre::HardwareBuffer::HardwareBuffer" ></a><p>
240<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
241  <tr>
242    <td class="mdRow">
243      <table cellpadding="0" cellspacing="0" border="0">
244        <tr>
245          <td class="md" nowrap valign="top"> Ogre::HardwareBuffer::HardwareBuffer </td>
246          <td class="md" valign="top">(&nbsp;</td>
247          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a>&nbsp;</td>
248          <td class="mdname" nowrap> <em>usage</em>, </td>
249        </tr>
250        <tr>
251          <td class="md" nowrap align="right"></td>
252          <td></td>
253          <td class="md" nowrap>bool&nbsp;</td>
254          <td class="mdname" nowrap> <em>systemMemory</em>, </td>
255        </tr>
256        <tr>
257          <td class="md" nowrap align="right"></td>
258          <td></td>
259          <td class="md" nowrap>bool&nbsp;</td>
260          <td class="mdname" nowrap> <em>useShadowBuffer</em></td>
261        </tr>
262        <tr>
263          <td></td>
264          <td class="md">)&nbsp;</td>
265          <td class="md" colspan="2"></td>
266        </tr>
267
268      </table>
269    </td>
270  </tr>
271</table>
272<table cellspacing=5 cellpadding=0 border=0>
273  <tr>
274    <td>
275      &nbsp;
276    </td>
277    <td>
278
279<p>
280Constructor, to be called by <a class="el" href="classOgre_1_1HardwareBufferManager.html">HardwareBufferManager</a> only.
281<p>
282
283<p>
284Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00149">149</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1HardwareBuffera1" doxytag="Ogre::HardwareBuffer::~HardwareBuffer" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> virtual Ogre::HardwareBuffer::~<a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap><code> [virtual]</code></td>
298        </tr>
299
300      </table>
301    </td>
302  </tr>
303</table>
304<table cellspacing=5 cellpadding=0 border=0>
305  <tr>
306    <td>
307      &nbsp;
308    </td>
309    <td>
310
311<p>
312
313<p>
314Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00164">164</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
315  </tr>
316</table>
317<hr><h2>Member Function Documentation</h2>
318<a class="anchor" name="Ogre_1_1HardwareVertexBuffera10" doxytag="Ogre::HardwareBuffer::_updateFromShadow" ></a><p>
319<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
320  <tr>
321    <td class="mdRow">
322      <table cellpadding="0" cellspacing="0" border="0">
323        <tr>
324          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::_updateFromShadow </td>
325          <td class="md" valign="top">(&nbsp;</td>
326          <td class="md" nowrap valign="top">void&nbsp;</td>
327          <td class="mdname1" valign="top" nowrap>          </td>
328          <td class="md" valign="top">&nbsp;)&nbsp;</td>
329          <td class="md" nowrap><code> [virtual]</code></td>
330        </tr>
331
332      </table>
333    </td>
334  </tr>
335</table>
336<table cellspacing=5 cellpadding=0 border=0>
337  <tr>
338    <td>
339      &nbsp;
340    </td>
341    <td>
342
343<p>
344Updates the real buffer from the shadow buffer, if required.
345<p>
346
347<p>
348Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00275">275</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
349  </tr>
350</table>
351<a class="anchor" name="Ogre_1_1HardwareVertexBuffera9" doxytag="Ogre::HardwareBuffer::copyData" ></a><p>
352<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
353  <tr>
354    <td class="mdRow">
355      <table cellpadding="0" cellspacing="0" border="0">
356        <tr>
357          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::copyData </td>
358          <td class="md" valign="top">(&nbsp;</td>
359          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a> &amp;&nbsp;</td>
360          <td class="mdname" nowrap> <em>srcBuffer</em>, </td>
361        </tr>
362        <tr>
363          <td class="md" nowrap align="right"></td>
364          <td></td>
365          <td class="md" nowrap>size_t&nbsp;</td>
366          <td class="mdname" nowrap> <em>srcOffset</em>, </td>
367        </tr>
368        <tr>
369          <td class="md" nowrap align="right"></td>
370          <td></td>
371          <td class="md" nowrap>size_t&nbsp;</td>
372          <td class="mdname" nowrap> <em>dstOffset</em>, </td>
373        </tr>
374        <tr>
375          <td class="md" nowrap align="right"></td>
376          <td></td>
377          <td class="md" nowrap>size_t&nbsp;</td>
378          <td class="mdname" nowrap> <em>length</em>, </td>
379        </tr>
380        <tr>
381          <td class="md" nowrap align="right"></td>
382          <td></td>
383          <td class="md" nowrap>bool&nbsp;</td>
384          <td class="mdname" nowrap> <em>discardWholeBuffer</em> = false</td>
385        </tr>
386        <tr>
387          <td></td>
388          <td class="md">)&nbsp;</td>
389          <td class="md" colspan="2"><code> [virtual]</code></td>
390        </tr>
391
392      </table>
393    </td>
394  </tr>
395</table>
396<table cellspacing=5 cellpadding=0 border=0>
397  <tr>
398    <td>
399      &nbsp;
400    </td>
401    <td>
402
403<p>
404Copy data from another buffer into this one.
405<p>
406<dl compact><dt><b>Remarks:</b></dt><dd>Note that the source buffer must not be created with the usage HBU_WRITE_ONLY otherwise this will fail. </dd></dl>
407<dl compact><dt><b>Parameters:</b></dt><dd>
408  <table border="0" cellspacing="2" cellpadding="0">
409    <tr><td valign=top><em>srcBuffer</em>&nbsp;</td><td>The buffer from which to read the copied data </td></tr>
410    <tr><td valign=top><em>srcOffset</em>&nbsp;</td><td>Offset in the source buffer at which to start reading </td></tr>
411    <tr><td valign=top><em>dstOffset</em>&nbsp;</td><td>Offset in the destination buffer to start writing </td></tr>
412    <tr><td valign=top><em>length</em>&nbsp;</td><td>Length of the data to copy, in bytes. </td></tr>
413    <tr><td valign=top><em>discardWholeBuffer</em>&nbsp;</td><td>If true, will discard the entire contents of this buffer before copying</td></tr>
414  </table>
415</dl>
416
417<p>
418Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00265">265</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
419<p>
420References <a class="el" href="OgreHardwareBuffer_8h-source.html#l00171">lock()</a>, and <a class="el" href="OgreHardwareBuffer_8h-source.html#l00217">unlock()</a>.    </td>
421  </tr>
422</table>
423<a class="anchor" name="Ogre_1_1HardwareVertexBuffera11" doxytag="Ogre::HardwareBuffer::getSizeInBytes" ></a><p>
424<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
425  <tr>
426    <td class="mdRow">
427      <table cellpadding="0" cellspacing="0" border="0">
428        <tr>
429          <td class="md" nowrap valign="top"> size_t Ogre::HardwareBuffer::getSizeInBytes </td>
430          <td class="md" valign="top">(&nbsp;</td>
431          <td class="md" nowrap valign="top">void&nbsp;</td>
432          <td class="mdname1" valign="top" nowrap>          </td>
433          <td class="md" valign="top">&nbsp;)&nbsp;</td>
434          <td class="md" nowrap> const</td>
435        </tr>
436
437      </table>
438    </td>
439  </tr>
440</table>
441<table cellspacing=5 cellpadding=0 border=0>
442  <tr>
443    <td>
444      &nbsp;
445    </td>
446    <td>
447
448<p>
449Returns the size of this buffer in bytes.
450<p>
451
452<p>
453Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00300">300</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
454  </tr>
455</table>
456<a class="anchor" name="Ogre_1_1HardwareVertexBuffera12" doxytag="Ogre::HardwareBuffer::getUsage" ></a><p>
457<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
458  <tr>
459    <td class="mdRow">
460      <table cellpadding="0" cellspacing="0" border="0">
461        <tr>
462          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a> Ogre::HardwareBuffer::getUsage </td>
463          <td class="md" valign="top">(&nbsp;</td>
464          <td class="md" nowrap valign="top">void&nbsp;</td>
465          <td class="mdname1" valign="top" nowrap>          </td>
466          <td class="md" valign="top">&nbsp;)&nbsp;</td>
467          <td class="md" nowrap> const</td>
468        </tr>
469
470      </table>
471    </td>
472  </tr>
473</table>
474<table cellspacing=5 cellpadding=0 border=0>
475  <tr>
476    <td>
477      &nbsp;
478    </td>
479    <td>
480
481<p>
482Returns the Usage flags with which this buffer was created.
483<p>
484
485<p>
486Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00302">302</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
487  </tr>
488</table>
489<a class="anchor" name="Ogre_1_1HardwareVertexBuffera14" doxytag="Ogre::HardwareBuffer::hasShadowBuffer" ></a><p>
490<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
491  <tr>
492    <td class="mdRow">
493      <table cellpadding="0" cellspacing="0" border="0">
494        <tr>
495          <td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::hasShadowBuffer </td>
496          <td class="md" valign="top">(&nbsp;</td>
497          <td class="md" nowrap valign="top">void&nbsp;</td>
498          <td class="mdname1" valign="top" nowrap>          </td>
499          <td class="md" valign="top">&nbsp;)&nbsp;</td>
500          <td class="md" nowrap> const</td>
501        </tr>
502
503      </table>
504    </td>
505  </tr>
506</table>
507<table cellspacing=5 cellpadding=0 border=0>
508  <tr>
509    <td>
510      &nbsp;
511    </td>
512    <td>
513
514<p>
515Returns whether this buffer has a system memory shadow for quicker reading.
516<p>
517
518<p>
519Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00306">306</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
520  </tr>
521</table>
522<a class="anchor" name="Ogre_1_1HardwareVertexBuffera15" doxytag="Ogre::HardwareBuffer::isLocked" ></a><p>
523<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
524  <tr>
525    <td class="mdRow">
526      <table cellpadding="0" cellspacing="0" border="0">
527        <tr>
528          <td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::isLocked </td>
529          <td class="md" valign="top">(&nbsp;</td>
530          <td class="md" nowrap valign="top">void&nbsp;</td>
531          <td class="mdname1" valign="top" nowrap>          </td>
532          <td class="md" valign="top">&nbsp;)&nbsp;</td>
533          <td class="md" nowrap> const</td>
534        </tr>
535
536      </table>
537    </td>
538  </tr>
539</table>
540<table cellspacing=5 cellpadding=0 border=0>
541  <tr>
542    <td>
543      &nbsp;
544    </td>
545    <td>
546
547<p>
548Returns whether or not this buffer is currently locked.
549<p>
550
551<p>
552Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00308">308</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
553  </tr>
554</table>
555<a class="anchor" name="Ogre_1_1HardwareVertexBuffera13" doxytag="Ogre::HardwareBuffer::isSystemMemory" ></a><p>
556<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
557  <tr>
558    <td class="mdRow">
559      <table cellpadding="0" cellspacing="0" border="0">
560        <tr>
561          <td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::isSystemMemory </td>
562          <td class="md" valign="top">(&nbsp;</td>
563          <td class="md" nowrap valign="top">void&nbsp;</td>
564          <td class="mdname1" valign="top" nowrap>          </td>
565          <td class="md" valign="top">&nbsp;)&nbsp;</td>
566          <td class="md" nowrap> const</td>
567        </tr>
568
569      </table>
570    </td>
571  </tr>
572</table>
573<table cellspacing=5 cellpadding=0 border=0>
574  <tr>
575    <td>
576      &nbsp;
577    </td>
578    <td>
579
580<p>
581Returns whether this buffer is held in system memory.
582<p>
583
584<p>
585Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00304">304</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
586  </tr>
587</table>
588<a class="anchor" name="Ogre_1_1HardwareVertexBuffera5" doxytag="Ogre::HardwareBuffer::lock" ></a><p>
589<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
590  <tr>
591    <td class="mdRow">
592      <table cellpadding="0" cellspacing="0" border="0">
593        <tr>
594          <td class="md" nowrap valign="top"> void* Ogre::HardwareBuffer::lock </td>
595          <td class="md" valign="top">(&nbsp;</td>
596          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a>&nbsp;</td>
597          <td class="mdname1" valign="top" nowrap> <em>options</em>          </td>
598          <td class="md" valign="top">&nbsp;)&nbsp;</td>
599          <td class="md" nowrap></td>
600        </tr>
601
602      </table>
603    </td>
604  </tr>
605</table>
606<table cellspacing=5 cellpadding=0 border=0>
607  <tr>
608    <td>
609      &nbsp;
610    </td>
611    <td>
612
613<p>
614Lock the entire buffer for (potentially) reading / writing.
615<p>
616<dl compact><dt><b>Parameters:</b></dt><dd>
617  <table border="0" cellspacing="2" cellpadding="0">
618    <tr><td valign=top><em>options</em>&nbsp;</td><td>Locking options </td></tr>
619  </table>
620</dl>
621<dl compact><dt><b>Returns:</b></dt><dd>Pointer to the locked memory </dd></dl>
622
623<p>
624Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00201">201</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
625  </tr>
626</table>
627<a class="anchor" name="Ogre_1_1HardwareVertexBuffera4" doxytag="Ogre::HardwareBuffer::lock" ></a><p>
628<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
629  <tr>
630    <td class="mdRow">
631      <table cellpadding="0" cellspacing="0" border="0">
632        <tr>
633          <td class="md" nowrap valign="top"> virtual void* Ogre::HardwareBuffer::lock </td>
634          <td class="md" valign="top">(&nbsp;</td>
635          <td class="md" nowrap valign="top">size_t&nbsp;</td>
636          <td class="mdname" nowrap> <em>offset</em>, </td>
637        </tr>
638        <tr>
639          <td class="md" nowrap align="right"></td>
640          <td></td>
641          <td class="md" nowrap>size_t&nbsp;</td>
642          <td class="mdname" nowrap> <em>length</em>, </td>
643        </tr>
644        <tr>
645          <td class="md" nowrap align="right"></td>
646          <td></td>
647          <td class="md" nowrap><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a>&nbsp;</td>
648          <td class="mdname" nowrap> <em>options</em></td>
649        </tr>
650        <tr>
651          <td></td>
652          <td class="md">)&nbsp;</td>
653          <td class="md" colspan="2"><code> [virtual]</code></td>
654        </tr>
655
656      </table>
657    </td>
658  </tr>
659</table>
660<table cellspacing=5 cellpadding=0 border=0>
661  <tr>
662    <td>
663      &nbsp;
664    </td>
665    <td>
666
667<p>
668Lock the buffer for (potentially) reading / writing.
669<p>
670<dl compact><dt><b>Parameters:</b></dt><dd>
671  <table border="0" cellspacing="2" cellpadding="0">
672    <tr><td valign=top><em>offset</em>&nbsp;</td><td>The byte offset from the start of the buffer to lock </td></tr>
673    <tr><td valign=top><em>length</em>&nbsp;</td><td>The size of the area to lock, in bytes </td></tr>
674    <tr><td valign=top><em>options</em>&nbsp;</td><td>Locking options </td></tr>
675  </table>
676</dl>
677<dl compact><dt><b>Returns:</b></dt><dd>Pointer to the locked memory</dd></dl>
678
679<p>
680Reimplemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBuffera4">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBuffera4">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera3">Ogre::HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBuffera4">Ogre::GLDefaultHardwareVertexBuffer</a>, and <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBuffera4">Ogre::GLDefaultHardwareIndexBuffer</a>.
681<p>
682Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00171">171</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
683<p>
684Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00265">copyData()</a>.    </td>
685  </tr>
686</table>
687<a class="anchor" name="Ogre_1_1HardwareVertexBufferb0" doxytag="Ogre::HardwareBuffer::lockImpl" ></a><p>
688<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
689  <tr>
690    <td class="mdRow">
691      <table cellpadding="0" cellspacing="0" border="0">
692        <tr>
693          <td class="md" nowrap valign="top"> virtual void* Ogre::HardwareBuffer::lockImpl </td>
694          <td class="md" valign="top">(&nbsp;</td>
695          <td class="md" nowrap valign="top">size_t&nbsp;</td>
696          <td class="mdname" nowrap> <em>offset</em>, </td>
697        </tr>
698        <tr>
699          <td class="md" nowrap align="right"></td>
700          <td></td>
701          <td class="md" nowrap>size_t&nbsp;</td>
702          <td class="mdname" nowrap> <em>length</em>, </td>
703        </tr>
704        <tr>
705          <td class="md" nowrap align="right"></td>
706          <td></td>
707          <td class="md" nowrap><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw12">LockOptions</a>&nbsp;</td>
708          <td class="mdname" nowrap> <em>options</em></td>
709        </tr>
710        <tr>
711          <td></td>
712          <td class="md">)&nbsp;</td>
713          <td class="md" colspan="2"><code> [protected, pure virtual]</code></td>
714        </tr>
715
716      </table>
717    </td>
718  </tr>
719</table>
720<table cellspacing=5 cellpadding=0 border=0>
721  <tr>
722    <td>
723      &nbsp;
724    </td>
725    <td>
726
727<p>
728Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera4">lock()</a>.
729<p>
730
731<p>
732Implemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBufferb0">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBufferb0">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferb1">Ogre::HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareIndexBuffer.html#Ogre_1_1D3D9HardwareIndexBufferb0">Ogre::D3D9HardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareVertexBuffer.html#Ogre_1_1D3D9HardwareVertexBufferb0">Ogre::D3D9HardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBufferb0">Ogre::GLDefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBufferb0">Ogre::GLDefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLHardwareIndexBuffer.html#Ogre_1_1GLHardwareIndexBufferb0">Ogre::GLHardwareIndexBuffer</a>, and <a class="el" href="classOgre_1_1GLHardwareVertexBuffer.html#Ogre_1_1GLHardwareVertexBufferb0">Ogre::GLHardwareVertexBuffer</a>.    </td>
733  </tr>
734</table>
735<a class="anchor" name="Ogre_1_1HardwareVertexBuffera7" doxytag="Ogre::HardwareBuffer::readData" ></a><p>
736<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
737  <tr>
738    <td class="mdRow">
739      <table cellpadding="0" cellspacing="0" border="0">
740        <tr>
741          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::readData </td>
742          <td class="md" valign="top">(&nbsp;</td>
743          <td class="md" nowrap valign="top">size_t&nbsp;</td>
744          <td class="mdname" nowrap> <em>offset</em>, </td>
745        </tr>
746        <tr>
747          <td class="md" nowrap align="right"></td>
748          <td></td>
749          <td class="md" nowrap>size_t&nbsp;</td>
750          <td class="mdname" nowrap> <em>length</em>, </td>
751        </tr>
752        <tr>
753          <td class="md" nowrap align="right"></td>
754          <td></td>
755          <td class="md" nowrap>void *&nbsp;</td>
756          <td class="mdname" nowrap> <em>pDest</em></td>
757        </tr>
758        <tr>
759          <td></td>
760          <td class="md">)&nbsp;</td>
761          <td class="md" colspan="2"><code> [pure virtual]</code></td>
762        </tr>
763
764      </table>
765    </td>
766  </tr>
767</table>
768<table cellspacing=5 cellpadding=0 border=0>
769  <tr>
770    <td>
771      &nbsp;
772    </td>
773    <td>
774
775<p>
776Reads data from the buffer and places it in the memory pointed to by pDest.
777<p>
778<dl compact><dt><b>Parameters:</b></dt><dd>
779  <table border="0" cellspacing="2" cellpadding="0">
780    <tr><td valign=top><em>offset</em>&nbsp;</td><td>The byte offset from the start of the buffer to read </td></tr>
781    <tr><td valign=top><em>length</em>&nbsp;</td><td>The size of the area to read, in bytes </td></tr>
782    <tr><td valign=top><em>pDest</em>&nbsp;</td><td>The area of memory in which to place the data, must be large enough to accommodate the data! </td></tr>
783  </table>
784</dl>
785
786<p>
787Implemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBuffera2">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBuffera2">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera5">Ogre::HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareIndexBuffer.html#Ogre_1_1D3D9HardwareIndexBuffera2">Ogre::D3D9HardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareVertexBuffer.html#Ogre_1_1D3D9HardwareVertexBuffera2">Ogre::D3D9HardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBuffera2">Ogre::GLDefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBuffera2">Ogre::GLDefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLHardwareIndexBuffer.html#Ogre_1_1GLHardwareIndexBuffera2">Ogre::GLHardwareIndexBuffer</a>, and <a class="el" href="classOgre_1_1GLHardwareVertexBuffer.html#Ogre_1_1GLHardwareVertexBuffera2">Ogre::GLHardwareVertexBuffer</a>.    </td>
788  </tr>
789</table>
790<a class="anchor" name="Ogre_1_1HardwareVertexBuffera16" doxytag="Ogre::HardwareBuffer::suppressHardwareUpdate" ></a><p>
791<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
792  <tr>
793    <td class="mdRow">
794      <table cellpadding="0" cellspacing="0" border="0">
795        <tr>
796          <td class="md" nowrap valign="top"> void Ogre::HardwareBuffer::suppressHardwareUpdate </td>
797          <td class="md" valign="top">(&nbsp;</td>
798          <td class="md" nowrap valign="top">bool&nbsp;</td>
799          <td class="mdname1" valign="top" nowrap> <em>suppress</em>          </td>
800          <td class="md" valign="top">&nbsp;)&nbsp;</td>
801          <td class="md" nowrap></td>
802        </tr>
803
804      </table>
805    </td>
806  </tr>
807</table>
808<table cellspacing=5 cellpadding=0 border=0>
809  <tr>
810    <td>
811      &nbsp;
812    </td>
813    <td>
814
815<p>
816<a class="el" href="classOgre_1_1Pass.html">Pass</a> true to suppress hardware upload of shadow buffer changes.
817<p>
818
819<p>
820Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00312">312</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
821  </tr>
822</table>
823<a class="anchor" name="Ogre_1_1HardwareVertexBuffera6" doxytag="Ogre::HardwareBuffer::unlock" ></a><p>
824<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
825  <tr>
826    <td class="mdRow">
827      <table cellpadding="0" cellspacing="0" border="0">
828        <tr>
829          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::unlock </td>
830          <td class="md" valign="top">(&nbsp;</td>
831          <td class="md" nowrap valign="top">void&nbsp;</td>
832          <td class="mdname1" valign="top" nowrap>          </td>
833          <td class="md" valign="top">&nbsp;)&nbsp;</td>
834          <td class="md" nowrap><code> [virtual]</code></td>
835        </tr>
836
837      </table>
838    </td>
839  </tr>
840</table>
841<table cellspacing=5 cellpadding=0 border=0>
842  <tr>
843    <td>
844      &nbsp;
845    </td>
846    <td>
847
848<p>
849Releases the lock on this buffer.
850<p>
851<dl compact><dt><b>Remarks:</b></dt><dd>Locking and unlocking a buffer can, in some rare circumstances such as switching video modes whilst the buffer is locked, corrupt the contents of a buffer. This is pretty rare, but if it occurs, this method will throw an exception, meaning you must re-upload the data. </dd></dl>
852<dl compact><dt><b></b></dt><dd>Note that using the 'read' and 'write' forms of updating the buffer does not suffer from this problem, so if you want to be 100% sure your data will not be lost, use the 'read' and 'write' forms instead. </dd></dl>
853
854<p>
855Reimplemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBuffera5">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBuffera5">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBuffera5">Ogre::GLDefaultHardwareVertexBuffer</a>, and <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBuffera5">Ogre::GLDefaultHardwareIndexBuffer</a>.
856<p>
857Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00217">217</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
858<p>
859Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00265">copyData()</a>.    </td>
860  </tr>
861</table>
862<a class="anchor" name="Ogre_1_1HardwareVertexBufferb1" doxytag="Ogre::HardwareBuffer::unlockImpl" ></a><p>
863<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
864  <tr>
865    <td class="mdRow">
866      <table cellpadding="0" cellspacing="0" border="0">
867        <tr>
868          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::unlockImpl </td>
869          <td class="md" valign="top">(&nbsp;</td>
870          <td class="md" nowrap valign="top">void&nbsp;</td>
871          <td class="mdname1" valign="top" nowrap>          </td>
872          <td class="md" valign="top">&nbsp;)&nbsp;</td>
873          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
874        </tr>
875
876      </table>
877    </td>
878  </tr>
879</table>
880<table cellspacing=5 cellpadding=0 border=0>
881  <tr>
882    <td>
883      &nbsp;
884    </td>
885    <td>
886
887<p>
888Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock()</a>.
889<p>
890
891<p>
892Implemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBufferb1">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBufferb1">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1D3D7HardwarePixelBuffer.html#Ogre_1_1D3D7HardwarePixelBufferb1">Ogre::D3D7HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareIndexBuffer.html#Ogre_1_1D3D9HardwareIndexBufferb1">Ogre::D3D9HardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwarePixelBuffer.html#Ogre_1_1D3D9HardwarePixelBufferb1">Ogre::D3D9HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareVertexBuffer.html#Ogre_1_1D3D9HardwareVertexBufferb1">Ogre::D3D9HardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBufferb1">Ogre::GLDefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBufferb1">Ogre::GLDefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLHardwareIndexBuffer.html#Ogre_1_1GLHardwareIndexBufferb1">Ogre::GLHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLHardwarePixelBufferb1">Ogre::GLHardwarePixelBuffer</a>, and <a class="el" href="classOgre_1_1GLHardwareVertexBuffer.html#Ogre_1_1GLHardwareVertexBufferb1">Ogre::GLHardwareVertexBuffer</a>.    </td>
893  </tr>
894</table>
895<a class="anchor" name="Ogre_1_1HardwareVertexBuffera8" doxytag="Ogre::HardwareBuffer::writeData" ></a><p>
896<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
897  <tr>
898    <td class="mdRow">
899      <table cellpadding="0" cellspacing="0" border="0">
900        <tr>
901          <td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::writeData </td>
902          <td class="md" valign="top">(&nbsp;</td>
903          <td class="md" nowrap valign="top">size_t&nbsp;</td>
904          <td class="mdname" nowrap> <em>offset</em>, </td>
905        </tr>
906        <tr>
907          <td class="md" nowrap align="right"></td>
908          <td></td>
909          <td class="md" nowrap>size_t&nbsp;</td>
910          <td class="mdname" nowrap> <em>length</em>, </td>
911        </tr>
912        <tr>
913          <td class="md" nowrap align="right"></td>
914          <td></td>
915          <td class="md" nowrap>const void *&nbsp;</td>
916          <td class="mdname" nowrap> <em>pSource</em>, </td>
917        </tr>
918        <tr>
919          <td class="md" nowrap align="right"></td>
920          <td></td>
921          <td class="md" nowrap>bool&nbsp;</td>
922          <td class="mdname" nowrap> <em>discardWholeBuffer</em> = false</td>
923        </tr>
924        <tr>
925          <td></td>
926          <td class="md">)&nbsp;</td>
927          <td class="md" colspan="2"><code> [pure virtual]</code></td>
928        </tr>
929
930      </table>
931    </td>
932  </tr>
933</table>
934<table cellspacing=5 cellpadding=0 border=0>
935  <tr>
936    <td>
937      &nbsp;
938    </td>
939    <td>
940
941<p>
942Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.
943<p>
944<dl compact><dt><b>Parameters:</b></dt><dd>
945  <table border="0" cellspacing="2" cellpadding="0">
946    <tr><td valign=top><em>offset</em>&nbsp;</td><td>The byte offset from the start of the buffer to start writing </td></tr>
947    <tr><td valign=top><em>length</em>&nbsp;</td><td>The size of the data to write to, in bytes </td></tr>
948    <tr><td valign=top><em>pSource</em>&nbsp;</td><td>The source of the data to be written </td></tr>
949    <tr><td valign=top><em>discardWholeBuffer</em>&nbsp;</td><td>If true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can. </td></tr>
950  </table>
951</dl>
952
953<p>
954Implemented in <a class="el" href="classOgre_1_1DefaultHardwareVertexBuffer.html#Ogre_1_1DefaultHardwareVertexBuffera3">Ogre::DefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1DefaultHardwareIndexBuffer.html#Ogre_1_1DefaultHardwareIndexBuffera3">Ogre::DefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera6">Ogre::HardwarePixelBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareIndexBuffer.html#Ogre_1_1D3D9HardwareIndexBuffera3">Ogre::D3D9HardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1D3D9HardwareVertexBuffer.html#Ogre_1_1D3D9HardwareVertexBuffera3">Ogre::D3D9HardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBuffera3">Ogre::GLDefaultHardwareVertexBuffer</a>, <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBuffera3">Ogre::GLDefaultHardwareIndexBuffer</a>, <a class="el" href="classOgre_1_1GLHardwareIndexBuffer.html#Ogre_1_1GLHardwareIndexBuffera3">Ogre::GLHardwareIndexBuffer</a>, and <a class="el" href="classOgre_1_1GLHardwareVertexBuffer.html#Ogre_1_1GLHardwareVertexBuffera3">Ogre::GLHardwareVertexBuffer</a>.    </td>
955  </tr>
956</table>
957<hr><h2>Member Data Documentation</h2>
958<a class="anchor" name="Ogre_1_1HardwareVertexBufferp4" doxytag="Ogre::HardwareBuffer::mIsLocked" ></a><p>
959<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
960  <tr>
961    <td class="mdRow">
962      <table cellpadding="0" cellspacing="0" border="0">
963        <tr>
964          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp4">Ogre::HardwareBuffer::mIsLocked</a><code> [protected]</code>
965      </table>
966    </td>
967  </tr>
968</table>
969<table cellspacing=5 cellpadding=0 border=0>
970  <tr>
971    <td>
972      &nbsp;
973    </td>
974    <td>
975
976<p>
977
978<p>
979Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00133">133</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
980  </tr>
981</table>
982<a class="anchor" name="Ogre_1_1HardwareVertexBufferp6" doxytag="Ogre::HardwareBuffer::mLockSize" ></a><p>
983<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
984  <tr>
985    <td class="mdRow">
986      <table cellpadding="0" cellspacing="0" border="0">
987        <tr>
988          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp6">Ogre::HardwareBuffer::mLockSize</a><code> [protected]</code>
989      </table>
990    </td>
991  </tr>
992</table>
993<table cellspacing=5 cellpadding=0 border=0>
994  <tr>
995    <td>
996      &nbsp;
997    </td>
998    <td>
999
1000<p>
1001
1002<p>
1003Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00135">135</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1004  </tr>
1005</table>
1006<a class="anchor" name="Ogre_1_1HardwareVertexBufferp5" doxytag="Ogre::HardwareBuffer::mLockStart" ></a><p>
1007<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1008  <tr>
1009    <td class="mdRow">
1010      <table cellpadding="0" cellspacing="0" border="0">
1011        <tr>
1012          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp5">Ogre::HardwareBuffer::mLockStart</a><code> [protected]</code>
1013      </table>
1014    </td>
1015  </tr>
1016</table>
1017<table cellspacing=5 cellpadding=0 border=0>
1018  <tr>
1019    <td>
1020      &nbsp;
1021    </td>
1022    <td>
1023
1024<p>
1025
1026<p>
1027Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00134">134</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1028  </tr>
1029</table>
1030<a class="anchor" name="Ogre_1_1HardwareVertexBufferp9" doxytag="Ogre::HardwareBuffer::mpShadowBuffer" ></a><p>
1031<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1032  <tr>
1033    <td class="mdRow">
1034      <table cellpadding="0" cellspacing="0" border="0">
1035        <tr>
1036          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a>* <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp9">Ogre::HardwareBuffer::mpShadowBuffer</a><code> [protected]</code>
1037      </table>
1038    </td>
1039  </tr>
1040</table>
1041<table cellspacing=5 cellpadding=0 border=0>
1042  <tr>
1043    <td>
1044      &nbsp;
1045    </td>
1046    <td>
1047
1048<p>
1049
1050<p>
1051Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00138">138</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1052  </tr>
1053</table>
1054<a class="anchor" name="Ogre_1_1HardwareVertexBufferp10" doxytag="Ogre::HardwareBuffer::mShadowUpdated" ></a><p>
1055<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1056  <tr>
1057    <td class="mdRow">
1058      <table cellpadding="0" cellspacing="0" border="0">
1059        <tr>
1060          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp10">Ogre::HardwareBuffer::mShadowUpdated</a><code> [protected]</code>
1061      </table>
1062    </td>
1063  </tr>
1064</table>
1065<table cellspacing=5 cellpadding=0 border=0>
1066  <tr>
1067    <td>
1068      &nbsp;
1069    </td>
1070    <td>
1071
1072<p>
1073
1074<p>
1075Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00139">139</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1076  </tr>
1077</table>
1078<a class="anchor" name="Ogre_1_1HardwareVertexBufferp2" doxytag="Ogre::HardwareBuffer::mSizeInBytes" ></a><p>
1079<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1080  <tr>
1081    <td class="mdRow">
1082      <table cellpadding="0" cellspacing="0" border="0">
1083        <tr>
1084          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp2">Ogre::HardwareBuffer::mSizeInBytes</a><code> [protected]</code>
1085      </table>
1086    </td>
1087  </tr>
1088</table>
1089<table cellspacing=5 cellpadding=0 border=0>
1090  <tr>
1091    <td>
1092      &nbsp;
1093    </td>
1094    <td>
1095
1096<p>
1097
1098<p>
1099Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00131">131</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1100  </tr>
1101</table>
1102<a class="anchor" name="Ogre_1_1HardwareVertexBufferp11" doxytag="Ogre::HardwareBuffer::mSuppressHardwareUpdate" ></a><p>
1103<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1104  <tr>
1105    <td class="mdRow">
1106      <table cellpadding="0" cellspacing="0" border="0">
1107        <tr>
1108          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp11">Ogre::HardwareBuffer::mSuppressHardwareUpdate</a><code> [protected]</code>
1109      </table>
1110    </td>
1111  </tr>
1112</table>
1113<table cellspacing=5 cellpadding=0 border=0>
1114  <tr>
1115    <td>
1116      &nbsp;
1117    </td>
1118    <td>
1119
1120<p>
1121
1122<p>
1123Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00140">140</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1124  </tr>
1125</table>
1126<a class="anchor" name="Ogre_1_1HardwareVertexBufferp7" doxytag="Ogre::HardwareBuffer::mSystemMemory" ></a><p>
1127<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1128  <tr>
1129    <td class="mdRow">
1130      <table cellpadding="0" cellspacing="0" border="0">
1131        <tr>
1132          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp7">Ogre::HardwareBuffer::mSystemMemory</a><code> [protected]</code>
1133      </table>
1134    </td>
1135  </tr>
1136</table>
1137<table cellspacing=5 cellpadding=0 border=0>
1138  <tr>
1139    <td>
1140      &nbsp;
1141    </td>
1142    <td>
1143
1144<p>
1145
1146<p>
1147Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00136">136</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1148  </tr>
1149</table>
1150<a class="anchor" name="Ogre_1_1HardwareVertexBufferp3" doxytag="Ogre::HardwareBuffer::mUsage" ></a><p>
1151<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1152  <tr>
1153    <td class="mdRow">
1154      <table cellpadding="0" cellspacing="0" border="0">
1155        <tr>
1156          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferw11">Usage</a> <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp3">Ogre::HardwareBuffer::mUsage</a><code> [protected]</code>
1157      </table>
1158    </td>
1159  </tr>
1160</table>
1161<table cellspacing=5 cellpadding=0 border=0>
1162  <tr>
1163    <td>
1164      &nbsp;
1165    </td>
1166    <td>
1167
1168<p>
1169
1170<p>
1171Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00132">132</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1172  </tr>
1173</table>
1174<a class="anchor" name="Ogre_1_1HardwareVertexBufferp8" doxytag="Ogre::HardwareBuffer::mUseShadowBuffer" ></a><p>
1175<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1176  <tr>
1177    <td class="mdRow">
1178      <table cellpadding="0" cellspacing="0" border="0">
1179        <tr>
1180          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferp8">Ogre::HardwareBuffer::mUseShadowBuffer</a><code> [protected]</code>
1181      </table>
1182    </td>
1183  </tr>
1184</table>
1185<table cellspacing=5 cellpadding=0 border=0>
1186  <tr>
1187    <td>
1188      &nbsp;
1189    </td>
1190    <td>
1191
1192<p>
1193
1194<p>
1195Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00137">137</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.    </td>
1196  </tr>
1197</table>
1198<hr>The documentation for this class was generated from the following file:<ul>
1199<li><a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a></ul>
1200<hr>
1201<p>
1202Copyright &copy; 2000-2005 by The OGRE Team<br />
1203<!--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/>
1204This 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/>
1205                <!--/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#">
1206                <Work rdf:about="">
1207                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1208        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1209                </Work>
1210                <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> -->
1211
1212Last modified Sun Feb 12 13:00:39 2006
1213</p>
1214</body>
1215</html>
Note: See TracBrowser for help on using the repository browser.