OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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:
62  HardwareIndexBuffer(HardwareBufferManagerBase* mgr, IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage,
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 
IndexType getType(void) const
Get the type of indexes used in this buffer.
#define _OgreExport
Definition: OgrePlatform.h:255
Specialisation of HardwareBuffer for vertex index buffers, still abstract.
size_t getNumIndexes(void) const
Get the number of indexes in this buffer.
Shared pointer implementation used to share index buffers.
size_t getIndexSize(void) const
Get the size in bytes of each index.
HardwareBufferManagerBase * mMgr
Base definition of a hardware buffer manager.
Usage
Enums describing buffer usage; not mutually exclusive.
HardwareBufferLockGuard< HardwareIndexBufferSharedPtr > HardwareIndexBufferLockGuard
Locking helper.
HardwareBufferManagerBase * getManager() const
Return the manager of this buffer, if any.
Abstract class defining common features of hardware buffers.
Reference-counted shared pointer, used for objects where implicit destruction is required.