OgreHardwareIndexBuffer.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __HardwareIndexBuffer__
29 #define __HardwareIndexBuffer__
30 
31 // Precompiler options
32 #include "OgrePrerequisites.h"
33 #include "OgreHardwareBuffer.h"
34 #include "OgreSharedPtr.h"
35 
36 namespace Ogre {
37  class HardwareBufferManagerBase;
38 
47  {
48  public:
49  enum IndexType {
51  IT_32BIT
52  };
53 
54  protected:
57  size_t mNumIndexes;
58  size_t mIndexSize;
59 
60  public:
63  bool useSystemMemory, bool useShadowBuffer);
66  HardwareBufferManagerBase* getManager() const { return mMgr; }
68  IndexType getType(void) const { return mIndexType; }
70  size_t getNumIndexes(void) const { return mNumIndexes; }
72  size_t getIndexSize(void) const { return mIndexSize; }
73 
74  // NB subclasses should override lock, unlock, readData, writeData
75  };
76 
77 
79  class _OgreExport HardwareIndexBufferSharedPtr : public SharedPtr<HardwareIndexBuffer>
80  {
81  public:
84  };
85 
88 
91 }
92 #endif
93 
OgreSharedPtr.h
Ogre::HardwareIndexBuffer::mIndexType
IndexType mIndexType
Definition: OgreHardwareIndexBuffer.h:56
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::HardwareBufferManagerBase
Base definition of a hardware buffer manager.
Definition: OgreHardwareBufferManager.h:114
Ogre::HardwareIndexBuffer::~HardwareIndexBuffer
~HardwareIndexBuffer()
Ogre::HardwareIndexBufferSharedPtr
Shared pointer implementation used to share index buffers.
Definition: OgreHardwareIndexBuffer.h:80
Ogre::HardwareIndexBuffer::getNumIndexes
size_t getNumIndexes(void) const
Get the number of indexes in this buffer.
Definition: OgreHardwareIndexBuffer.h:70
Ogre::HardwareIndexBufferLockGuard
HardwareBufferLockGuard< HardwareIndexBufferSharedPtr > HardwareIndexBufferLockGuard
Locking helper.
Definition: OgreHardwareIndexBuffer.h:87
Ogre::HardwareIndexBuffer::mIndexSize
size_t mIndexSize
Definition: OgreHardwareIndexBuffer.h:58
Ogre::HardwareIndexBuffer
Specialisation of HardwareBuffer for vertex index buffers, still abstract.
Definition: OgreHardwareIndexBuffer.h:47
Ogre::HardwareIndexBuffer::mNumIndexes
size_t mNumIndexes
Definition: OgreHardwareIndexBuffer.h:57
OgrePrerequisites.h
Ogre::HardwareIndexBufferSharedPtr::HardwareIndexBufferSharedPtr
HardwareIndexBufferSharedPtr(HardwareIndexBuffer *buf)
Ogre::HardwareIndexBuffer::IT_16BIT
@ IT_16BIT
Definition: OgreHardwareIndexBuffer.h:50
Ogre::HardwareIndexBuffer::IndexType
IndexType
Definition: OgreHardwareIndexBuffer.h:49
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::HardwareIndexBuffer::HardwareIndexBuffer
HardwareIndexBuffer(HardwareBufferManagerBase *mgr, IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
Should be called by HardwareBufferManager.
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgreSharedPtr.h:112
Ogre::HardwareBuffer
Abstract class defining common features of hardware buffers.
Definition: OgreHardwareBuffer.h:75
Ogre::HardwareBuffer::Usage
Usage
Enums describing buffer usage; not mutually exclusive.
Definition: OgreHardwareBuffer.h:80
Ogre::HardwareIndexBuffer::getIndexSize
size_t getIndexSize(void) const
Get the size in bytes of each index.
Definition: OgreHardwareIndexBuffer.h:72
Ogre::HardwareIndexBuffer::getManager
HardwareBufferManagerBase * getManager() const
Return the manager of this buffer, if any.
Definition: OgreHardwareIndexBuffer.h:66
Ogre::HardwareIndexBuffer::mMgr
HardwareBufferManagerBase * mMgr
Definition: OgreHardwareIndexBuffer.h:55
OgreHardwareBuffer.h
Ogre::HardwareIndexBufferSharedPtr::HardwareIndexBufferSharedPtr
HardwareIndexBufferSharedPtr()
Definition: OgreHardwareIndexBuffer.h:82
Ogre::HardwareIndexBuffer::getType
IndexType getType(void) const
Get the type of indexes used in this buffer.
Definition: OgreHardwareIndexBuffer.h:68
Ogre::HardwareBufferLockGuard
Locking helper.
Definition: OgreHardwareBuffer.h:358

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.