OgreHardwareIndexBuffer.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE 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
36namespace Ogre {
37 class HardwareBufferManagerBase;
38
47 {
48 public:
49 enum IndexType {
51 IT_32BIT
52 };
53
54 protected:
58 size_t mIndexSize;
59
60 public:
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
#define _OgreExport
Base definition of a hardware buffer manager.
Abstract class defining common features of hardware buffers.
Usage
Enums describing buffer usage; not mutually exclusive.
Shared pointer implementation used to share index buffers.
HardwareIndexBufferSharedPtr(HardwareIndexBuffer *buf)
Specialisation of HardwareBuffer for vertex index buffers, still abstract.
size_t getIndexSize(void) const
Get the size in bytes of each index.
HardwareIndexBuffer(HardwareBufferManagerBase *mgr, IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
Should be called by HardwareBufferManager.
size_t getNumIndexes(void) const
Get the number of indexes in this buffer.
HardwareBufferManagerBase * getManager() const
Return the manager of this buffer, if any.
IndexType getType(void) const
Get the type of indexes used in this buffer.
HardwareBufferManagerBase * mMgr
Reference-counted shared pointer, used for objects where implicit destruction is required.
HardwareBufferLockGuard< HardwareIndexBufferSharedPtr > HardwareIndexBufferLockGuard
Locking helper.

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