<html>
<head>
<title>Ogre::HardwareBuffer class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::HardwareBuffer Class Reference</h1>Abstract class defining common features of hardware buffers.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>></code>
<p>
Inheritance diagram for Ogre::HardwareBuffer:<p><center><img src="classOgre_1_1HardwareBuffer__inherit__graph.png" border="0" usemap="#Ogre_1_1HardwareBuffer__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1HardwareBuffer__inherit__map">
<area href="classOgre_1_1HardwareIndexBuffer.html" shape="rect" coords="209,24,377,5" alt="">
<area href="classOgre_1_1HardwareVertexBuffer.html" shape="rect" coords="205,66,381,48" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::HardwareBuffer:<p><center><img src="classOgre_1_1HardwareBuffer__coll__graph.png" border="0" usemap="#Ogre_1_1HardwareBuffer__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1HardwareBuffer__coll__map">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1HardwareBuffer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> { <br>
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers0">HBU_STATIC</a> = 1,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers1">HBU_DYNAMIC</a> = 2,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers2">HBU_WRITE_ONLY</a> = 4,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers3">HBU_STATIC_WRITE_ONLY</a> = 5,
<br>
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers4">HBU_DYNAMIC_WRITE_ONLY</a> = 6
<br>
}</td></tr>
<tr><td> </td><td><font size=-1><em>Enums describing buffer usage; not mutually exclusive.</em> <a href="#Ogre_1_1HardwareVertexBuffers9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10">LockOptions</a> { <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers5">HBL_NORMAL</a>,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers6">HBL_DISCARD</a>,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers7">HBL_READ_ONLY</a>,
<a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers8">HBL_NO_OVERWRITE</a>
}</td></tr>
<tr><td> </td><td><font size=-1><em>Locking options.</em> <a href="#Ogre_1_1HardwareVertexBuffers10">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td 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_1HardwareVertexBuffers9">Usage</a> usage, bool systemMemory, bool useShadowBuffer)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor, to be called by <a class="el" href="classOgre_1_1HardwareBufferManager.html">HardwareBufferManager</a> only.</em> <a href="#Ogre_1_1HardwareBuffera0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareBuffera1">~HardwareBuffer</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void * </td><td 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_1HardwareVertexBuffers10">LockOptions</a> options)</td></tr>
<tr><td> </td><td><font size=-1><em>Lock the buffer for (potentially) reading / writing.</em> <a href="#Ogre_1_1HardwareVertexBuffera4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void * </td><td 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_1HardwareVertexBuffers10">LockOptions</a> options)</td></tr>
<tr><td> </td><td><font size=-1><em>Lock the entire buffer for (potentially) reading / writing.</em> <a href="#Ogre_1_1HardwareVertexBuffera5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Releases the lock on this buffer.</em> <a href="#Ogre_1_1HardwareVertexBuffera6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td 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>
<tr><td> </td><td><font size=-1><em>Reads data from the buffer and places it in the memory pointed to by pDest.</em> <a href="#Ogre_1_1HardwareVertexBuffera7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td 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>
<tr><td> </td><td><font size=-1><em>Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.</em> <a href="#Ogre_1_1HardwareVertexBuffera8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera9">copyData</a> (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy data from another buffer into this one.</em> <a href="#Ogre_1_1HardwareVertexBuffera9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera10">_updateFromShadow</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Updates the real buffer from the shadow buffer, if required.</em> <a href="#Ogre_1_1HardwareVertexBuffera10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera11">getSizeInBytes</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size of this buffer in bytes.</em> <a href="#Ogre_1_1HardwareVertexBuffera11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera12">getUsage</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the Usage flags with which this buffer was created.</em> <a href="#Ogre_1_1HardwareVertexBuffera12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera13">isSystemMemory</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether this buffer is held in system memory.</em> <a href="#Ogre_1_1HardwareVertexBuffera13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera14">isLocked</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not this buffer is currently locked.</em> <a href="#Ogre_1_1HardwareVertexBuffera14"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual void * </td><td 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_1HardwareVertexBuffers10">LockOptions</a> options)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera4">lock</a>().</em> <a href="#Ogre_1_1HardwareVertexBufferb0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferb1">unlockImpl</a> (void)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock</a>().</em> <a href="#Ogre_1_1HardwareVertexBufferb1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern2">mSizeInBytes</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern3">mUsage</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern4">mIsLocked</a></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern5">mLockStart</a></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern6">mLockSize</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern7">mSystemMemory</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern8">mUseShadowBuffer</a></td></tr>
<tr><td nowrap align=right valign=top>HardwareBuffer * </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern9">mpShadowBuffer</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffern10">mShadowUpdated</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class defining common features of hardware buffers.
<p>
<dl compact><dt><b>
Remarks: </b><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.
<p>
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.
<p>
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.
<p>
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. </dl>
<p>
<p>
Definition 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>
<a name="Ogre_1_1HardwareVertexBuffers10" doxytag="Ogre::HardwareBuffer::LockOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum Ogre::HardwareBuffer::LockOptions
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Locking options.
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers5" doxytag="HBL_NORMAL"></a><em>HBL_NORMAL</em></em> </td><td>
Normal mode, ie allows read/write and contents are preserved.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers6" doxytag="HBL_DISCARD"></a><em>HBL_DISCARD</em></em> </td><td>
Discards the <em>entire</em> buffer while locking; this allows optimisation to be performed because synchronisation issues are relaxed.
<p>
Only allowed on buffers created with the HBU_DYNAMIC flag. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers7" doxytag="HBL_READ_ONLY"></a><em>HBL_READ_ONLY</em></em> </td><td>
Lock the buffer for reading only.
<p>
Not allowed in buffers which are created with HBU_WRITE_ONLY. Mandatory on statuc buffers, ie those created without the HBU_DYNAMIC flag. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers10Ogre_1_1HardwareVertexBuffers8" doxytag="HBL_NO_OVERWRITE"></a><em>HBL_NO_OVERWRITE</em></em> </td><td>
As 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>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00096">96</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffers9" doxytag="Ogre::HardwareBuffer::Usage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum Ogre::HardwareBuffer::Usage
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Enums describing buffer usage; not mutually exclusive.
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers0" doxytag="HBU_STATIC"></a><em>HBU_STATIC</em></em> </td><td>
Static buffer which the application rarely modifies once created.
<p>
Modifying the contents of this buffer will involve a performance hit. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers1" doxytag="HBU_DYNAMIC"></a><em>HBU_DYNAMIC</em></em> </td><td>
Indicates the application would like to modify this buffer with the CPU fairly often.
<p>
Buffers created with this flag will typically end up in AGP memory rather than video memory. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers2" doxytag="HBU_WRITE_ONLY"></a><em>HBU_WRITE_ONLY</em></em> </td><td>
Indicates the application will never read the contents of the buffer back, it will only ever write data.
<p>
Locking 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>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers3" doxytag="HBU_STATIC_WRITE_ONLY"></a><em>HBU_STATIC_WRITE_ONLY</em></em> </td><td>
Combination of HBU_STATIC and HBU_WRITE_ONLY.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1HardwareVertexBuffers9Ogre_1_1HardwareVertexBuffers4" doxytag="HBU_DYNAMIC_WRITE_ONLY"></a><em>HBU_DYNAMIC_WRITE_ONLY</em></em> </td><td>
Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.</td></tr>
</table>
</dl>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1HardwareBuffera0" doxytag="Ogre::HardwareBuffer::HardwareBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::HardwareBuffer::HardwareBuffer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> </td>
<td class="mdname" nowrap> <em>usage</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>systemMemory</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>useShadowBuffer</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor, to be called by <a class="el" href="classOgre_1_1HardwareBufferManager.html">HardwareBufferManager</a> only.
<p>
<p>
Definition 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>
</tr>
</table>
<a name="Ogre_1_1HardwareBuffera1" doxytag="Ogre::HardwareBuffer::~HardwareBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::HardwareBuffer::~HardwareBuffer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1HardwareVertexBuffera10" doxytag="Ogre::HardwareBuffer::_updateFromShadow"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::_updateFromShadow </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Updates the real buffer from the shadow buffer, if required.
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00247">247</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
References <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferb0">lockImpl</a>(), and <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBufferb1">unlockImpl</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera9" doxytag="Ogre::HardwareBuffer::copyData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::copyData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">HardwareBuffer & </td>
<td class="mdname" nowrap> <em>srcBuffer</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>srcOffset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>dstOffset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>discardWholeBuffer</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy data from another buffer into this one.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Note that the source buffer must not be created with the usage HBU_WRITE_ONLY otherwise this will fail. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>srcBuffer</em> </td><td>
The buffer from which to read the copied data </td></tr>
<tr><td valign=top><em>srcOffset</em> </td><td>
Offset in the source buffer at which to start reading </td></tr>
<tr><td valign=top><em>dstOffset</em> </td><td>
Offset in the destination buffer to start writing </td></tr>
<tr><td valign=top><em>length</em> </td><td>
Length of the data to copy, in bytes. </td></tr>
<tr><td valign=top><em>discardWholeBuffer</em> </td><td>
If true, will discard the entire contents of this buffer before copying </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00237">237</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
References <a class="el" href="OgreHardwareBuffer_8h-source.html#l00143">lock</a>(), and <a class="el" href="OgreHardwareBuffer_8h-source.html#l00189">unlock</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera11" doxytag="Ogre::HardwareBuffer::getSizeInBytes"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t Ogre::HardwareBuffer::getSizeInBytes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the size of this buffer in bytes.
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00272">272</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera12" doxytag="Ogre::HardwareBuffer::getUsage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> Ogre::HardwareBuffer::getUsage </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the Usage flags with which this buffer was created.
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00274">274</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera14" doxytag="Ogre::HardwareBuffer::isLocked"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::isLocked </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not this buffer is currently locked.
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00278">278</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00189">unlock</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera13" doxytag="Ogre::HardwareBuffer::isSystemMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::isSystemMemory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether this buffer is held in system memory.
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00276">276</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera5" doxytag="Ogre::HardwareBuffer::lock"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* Ogre::HardwareBuffer::lock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10">LockOptions</a> </td>
<td class="mdname1" valign="top" nowrap> <em>options</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Lock the entire buffer for (potentially) reading / writing.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>options</em> </td><td>
Locking options </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
Pointer to the locked memory </dl>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00173">173</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera4" doxytag="Ogre::HardwareBuffer::lock"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void* Ogre::HardwareBuffer::lock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname" nowrap> <em>offset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10">LockOptions</a> </td>
<td class="mdname" nowrap> <em>options</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Lock the buffer for (potentially) reading / writing.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>offset</em> </td><td>
The byte offset from the start of the buffer to lock </td></tr>
<tr><td valign=top><em>length</em> </td><td>
The size of the area to lock, in bytes </td></tr>
<tr><td valign=top><em>options</em> </td><td>
Locking options </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
Pointer to the locked memory </dl>
<p>
Reimplemented 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_1GLDefaultHardwareVertexBuffer.html#Ogre_1_1GLDefaultHardwareVertexBuffera4">Ogre::GLDefaultHardwareVertexBuffer</a>, and <a class="el" href="classOgre_1_1GLDefaultHardwareIndexBuffer.html#Ogre_1_1GLDefaultHardwareIndexBuffera4">Ogre::GLDefaultHardwareIndexBuffer</a>.
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00143">143</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00237">copyData</a>(), <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00094">Ogre::D3D9HardwareVertexBuffer::readData</a>(), <a class="el" href="OgreD3D9HardwareIndexBuffer_8cpp-source.html#l00098">Ogre::D3D9HardwareIndexBuffer::readData</a>(), <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00105">Ogre::D3D9HardwareVertexBuffer::writeData</a>(), and <a class="el" href="OgreD3D9HardwareIndexBuffer_8cpp-source.html#l00109">Ogre::D3D9HardwareIndexBuffer::writeData</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBufferb0" doxytag="Ogre::HardwareBuffer::lockImpl"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void* Ogre::HardwareBuffer::lockImpl </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname" nowrap> <em>offset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers10">LockOptions</a> </td>
<td class="mdname" nowrap> <em>options</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera4">lock</a>().
<p>
<p>
Implemented 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_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>.
<p>
Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00247">_updateFromShadow</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera7" doxytag="Ogre::HardwareBuffer::readData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::readData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname" nowrap> <em>offset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>pDest</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Reads data from the buffer and places it in the memory pointed to by pDest.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>offset</em> </td><td>
The byte offset from the start of the buffer to read </td></tr>
<tr><td valign=top><em>length</em> </td><td>
The size of the area to read, in bytes </td></tr>
<tr><td valign=top><em>pDest</em> </td><td>
The area of memory in which to place the data, must be large enough to accommodate the data! </td></tr>
</table>
</dl>
<p>
Implemented 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_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>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera6" doxytag="Ogre::HardwareBuffer::unlock"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::unlock </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Releases the lock on this buffer.
<p>
<dl compact><dt><b>
Remarks: </b><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.
<p>
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. </dl>
<p>
Reimplemented 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>.
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00189">189</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
References <a class="el" href="OgreHardwareBuffer_8h-source.html#l00278">isLocked</a>().
<p>
Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00237">copyData</a>(), <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00094">Ogre::D3D9HardwareVertexBuffer::readData</a>(), <a class="el" href="OgreD3D9HardwareIndexBuffer_8cpp-source.html#l00098">Ogre::D3D9HardwareIndexBuffer::readData</a>(), <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00105">Ogre::D3D9HardwareVertexBuffer::writeData</a>(), and <a class="el" href="OgreD3D9HardwareIndexBuffer_8cpp-source.html#l00109">Ogre::D3D9HardwareIndexBuffer::writeData</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBufferb1" doxytag="Ogre::HardwareBuffer::unlockImpl"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::unlockImpl </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Internal implementation of <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffera6">unlock</a>().
<p>
<p>
Implemented 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_1D3D9HardwareIndexBuffer.html#Ogre_1_1D3D9HardwareIndexBufferb1">Ogre::D3D9HardwareIndexBuffer</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>, and <a class="el" href="classOgre_1_1GLHardwareVertexBuffer.html#Ogre_1_1GLHardwareVertexBufferb1">Ogre::GLHardwareVertexBuffer</a>.
<p>
Referenced by <a class="el" href="OgreHardwareBuffer_8h-source.html#l00247">_updateFromShadow</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffera8" doxytag="Ogre::HardwareBuffer::writeData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::HardwareBuffer::writeData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname" nowrap> <em>offset</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const void * </td>
<td class="mdname" nowrap> <em>pSource</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>discardWholeBuffer</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>offset</em> </td><td>
The byte offset from the start of the buffer to start writing </td></tr>
<tr><td valign=top><em>length</em> </td><td>
The size of the data to write to, in bytes </td></tr>
<tr><td valign=top><em>pSource</em> </td><td>
The source of the data to be written </td></tr>
<tr><td valign=top><em>discardWholeBuffer</em> </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>
</table>
</dl>
<p>
Implemented 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_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>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1HardwareVertexBuffern4" doxytag="Ogre::HardwareBuffer::mIsLocked"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::mIsLocked<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00118">118</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00103">Ogre::GLDefaultHardwareIndexBuffer::lock</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00052">Ogre::GLDefaultHardwareVertexBuffer::lock</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00104">Ogre::DefaultHardwareIndexBuffer::lock</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00053">Ogre::DefaultHardwareVertexBuffer::lock</a>(), <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00059">Ogre::GLHardwareVertexBuffer::lockImpl</a>(), <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00059">Ogre::GLHardwareIndexBuffer::lockImpl</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00109">Ogre::GLDefaultHardwareIndexBuffer::unlock</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00058">Ogre::GLDefaultHardwareVertexBuffer::unlock</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00110">Ogre::DefaultHardwareIndexBuffer::unlock</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00059">Ogre::DefaultHardwareVertexBuffer::unlock</a>(), <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00116">Ogre::GLHardwareVertexBuffer::unlockImpl</a>(), and <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00118">Ogre::GLHardwareIndexBuffer::unlockImpl</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern6" doxytag="Ogre::HardwareBuffer::mLockSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t Ogre::HardwareBuffer::mLockSize<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00120">120</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern5" doxytag="Ogre::HardwareBuffer::mLockStart"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t Ogre::HardwareBuffer::mLockStart<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00119">119</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern9" doxytag="Ogre::HardwareBuffer::mpShadowBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> HardwareBuffer* Ogre::HardwareBuffer::mpShadowBuffer<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00123">123</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreHardwareIndexBuffer_8cpp-source.html#l00034">Ogre::HardwareIndexBuffer::HardwareIndexBuffer</a>(), <a class="el" href="OgreHardwareVertexBuffer_8cpp-source.html#l00036">Ogre::HardwareVertexBuffer::HardwareVertexBuffer</a>(), <a class="el" href="OgreHardwareIndexBuffer_8cpp-source.html#l00061">Ogre::HardwareIndexBuffer::~HardwareIndexBuffer</a>(), and <a class="el" href="OgreHardwareVertexBuffer_8cpp-source.html#l00055">Ogre::HardwareVertexBuffer::~HardwareVertexBuffer</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern10" doxytag="Ogre::HardwareBuffer::mShadowUpdated"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::mShadowUpdated<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00124">124</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern2" doxytag="Ogre::HardwareBuffer::mSizeInBytes"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t Ogre::HardwareBuffer::mSizeInBytes<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00116">116</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00032">Ogre::D3D9HardwareVertexBuffer::D3D9HardwareVertexBuffer</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00081">Ogre::DefaultHardwareIndexBuffer::DefaultHardwareIndexBuffer</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00030">Ogre::DefaultHardwareVertexBuffer::DefaultHardwareVertexBuffer</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00080">Ogre::GLDefaultHardwareIndexBuffer::GLDefaultHardwareIndexBuffer</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00029">Ogre::GLDefaultHardwareVertexBuffer::GLDefaultHardwareVertexBuffer</a>(), <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00032">Ogre::GLHardwareIndexBuffer::GLHardwareIndexBuffer</a>(), <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00032">Ogre::GLHardwareVertexBuffer::GLHardwareVertexBuffer</a>(), <a class="el" href="OgreHardwareIndexBuffer_8cpp-source.html#l00034">Ogre::HardwareIndexBuffer::HardwareIndexBuffer</a>(), <a class="el" href="OgreHardwareVertexBuffer_8cpp-source.html#l00036">Ogre::HardwareVertexBuffer::HardwareVertexBuffer</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00115">Ogre::GLDefaultHardwareIndexBuffer::readData</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00064">Ogre::GLDefaultHardwareVertexBuffer::readData</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00116">Ogre::DefaultHardwareIndexBuffer::readData</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00065">Ogre::DefaultHardwareVertexBuffer::readData</a>(), <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00137">Ogre::GLHardwareVertexBuffer::writeData</a>(), <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00139">Ogre::GLHardwareIndexBuffer::writeData</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00121">Ogre::GLDefaultHardwareIndexBuffer::writeData</a>(), <a class="el" href="OgreGLDefaultHardwareBufferManager_8cpp-source.html#l00070">Ogre::GLDefaultHardwareVertexBuffer::writeData</a>(), <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00122">Ogre::DefaultHardwareIndexBuffer::writeData</a>(), and <a class="el" href="OgreDefaultHardwareBufferManager_8cpp-source.html#l00071">Ogre::DefaultHardwareVertexBuffer::writeData</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern7" doxytag="Ogre::HardwareBuffer::mSystemMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::mSystemMemory<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00121">121</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern3" doxytag="Ogre::HardwareBuffer::mUsage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareBuffer.html#Ogre_1_1HardwareVertexBuffers9">Usage</a> Ogre::HardwareBuffer::mUsage<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00117">117</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>.
<p>
Referenced by <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00059">Ogre::GLHardwareVertexBuffer::lockImpl</a>(), <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00059">Ogre::GLHardwareIndexBuffer::lockImpl</a>(), <a class="el" href="OgreD3D9HardwareVertexBuffer_8cpp-source.html#l00059">Ogre::D3D9HardwareVertexBuffer::lockImpl</a>(), <a class="el" href="OgreD3D9HardwareIndexBuffer_8cpp-source.html#l00061">Ogre::D3D9HardwareIndexBuffer::lockImpl</a>(), <a class="el" href="OgreGLHardwareVertexBuffer_8cpp-source.html#l00137">Ogre::GLHardwareVertexBuffer::writeData</a>(), and <a class="el" href="OgreGLHardwareIndexBuffer_8cpp-source.html#l00139">Ogre::GLHardwareIndexBuffer::writeData</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1HardwareVertexBuffern8" doxytag="Ogre::HardwareBuffer::mUseShadowBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::HardwareBuffer::mUseShadowBuffer<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreHardwareBuffer_8h-source.html#l00122">122</a> of file <a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreHardwareBuffer_8h-source.html">OgreHardwareBuffer.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:50 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2332
