Torque3D Documentation / _generateds / gfxGLVertexBuffer.h

gfxGLVertexBuffer.h

Engine/source/gfx/gl/gfxGLVertexBuffer.h

More...

Classes:

class

This is a vertex buffer which uses GL_ARB_vertex_buffer_object.

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GFXGLVERTEXBUFFER_H_
25#define _GFXGLVERTEXBUFFER_H_
26
27#ifndef _GFXVERTEXBUFFER_H_
28#include "gfx/gfxVertexBuffer.h"
29#endif
30#include "gfx/gl/tGL/tGL.h"
31#include "gfx/gl/util/glFrameAllocatorLockableHelper.h"
32
33/// This is a vertex buffer which uses GL_ARB_vertex_buffer_object.
34class GFXGLVertexBuffer : public GFXVertexBuffer 
35{
36public:
37
38   GFXGLVertexBuffer(   GFXDevice *device, 
39                        U32 numVerts, 
40                        const GFXVertexFormat *vertexFormat, 
41                        U32 vertexSize, 
42                        GFXBufferType bufferType );
43
44   ~GFXGLVertexBuffer();
45
46   virtual void lock(U32 vertexStart, U32 vertexEnd, void **vertexPtr); ///< Only write lock are supported. 
47   virtual void unlock(); ///<
48   virtual void prepare(); ///< Do nothing. Use void prepare(U32 stream, U32 divisor).
49   virtual void finish(); ///< Do nothing.
50
51   void prepare(U32 stream, U32 divisor);
52
53   GLvoid* getBuffer(); ///< returns NULL
54
55   // GFXResource interface
56   virtual void zombify();
57   virtual void resurrect();
58
59private:
60   friend class GFXGLDevice;
61   /// GL buffer handle
62   GLuint mBuffer;
63
64    /// bytes offset in buffer 
65   U32 mBufferOffset;
66
67   /// start vertex offset in buffer
68   U32 mBufferVertexOffset;
69   U8* mZombieCache;
70
71   FrameAllocatorLockableHelper mFrameAllocator;
72};
73
74#endif
75