Crazy Eddie's GUI System  0.8.7
RendererModules/Direct3D11/GeometryBuffer.h
1 /***********************************************************************
2  created: Wed May 5 2010
3 *************************************************************************/
4 /***************************************************************************
5  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24  * OTHER DEALINGS IN THE SOFTWARE.
25  ***************************************************************************/
26 #ifndef _CEGUIDirect3D11GeometryBuffer_h_
27 #define _CEGUIDirect3D11GeometryBuffer_h_
28 
29 #include "../../GeometryBuffer.h"
30 #include "CEGUI/RendererModules/Direct3D11/Renderer.h"
31 #include "../../Rect.h"
32 #include "../../Quaternion.h"
33 
34 
35 
36 #if defined(_MSC_VER)
37 # pragma warning(push)
38 # pragma warning(disable : 4251)
39 #endif
40 
41 // Start of CEGUI namespace section
42 namespace CEGUI
43 {
44 class Direct3D11Texture;
45 
47 class D3D11_GUIRENDERER_API Direct3D11GeometryBuffer : public GeometryBuffer
48 {
49 public:
52 
55 
57  const D3DXMATRIX* getMatrix() const;
58 
59  // Implement GeometryBuffer interface.
60  void draw() const;
61  void setTranslation(const Vector3f& v);
62  void setRotation(const Quaternion& r);
63  void setPivot(const Vector3f& p);
64  void setClippingRegion(const Rectf& region);
65  void appendVertex(const Vertex& vertex);
66  void appendGeometry(const Vertex* const vbuff, uint vertex_count);
67  void setActiveTexture(Texture* texture);
68  void reset();
70  uint getVertexCount() const;
71  uint getBatchCount() const;
74  void setClippingActive(const bool active);
75  bool isClippingActive() const;
76 
77 protected:
79  void updateMatrix() const;
81  void syncHardwareBuffer() const;
83  void allocateVertexBuffer(const size_t count) const;
85  void cleanupVertexBuffer() const;
86 
88  struct D3DVertex
89  {
91  FLOAT x, y, z;
93  DWORD diffuse;
95  float tu, tv;
96  };
97 
99  struct BatchInfo
100  {
101  const ID3D11ShaderResourceView* texture;
102  uint vertexCount;
103  bool clip;
104  };
105 
106  // Direct3D11Renderer object that created and owns this GeometryBuffer.
107  Direct3D11Renderer& d_owner;
113  mutable ID3D11Buffer* d_vertexBuffer;
115  mutable UINT d_bufferSize;
117  mutable bool d_bufferSynched;
119  typedef std::vector<BatchInfo> BatchList;
123  typedef std::vector<D3DVertex> VertexList;
139  mutable D3DXMATRIX d_matrix;
141  mutable bool d_matrixValid;
142 };
143 
144 
145 } // End of CEGUI namespace section
146 
147 #if defined(_MSC_VER)
148 # pragma warning(pop)
149 #endif
150 
151 #endif // end of guard _CEGUIDirect3D11GeometryBuffer_h_
CEGUI::GeometryBuffer
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
IDevice11
Definition: RendererModules/Direct3D11/Renderer.h:67
CEGUI::Direct3D11GeometryBuffer::d_batches
BatchList d_batches
list of texture batches added to the geometry buffer
Definition: RendererModules/Direct3D11/GeometryBuffer.h:121
CEGUI::Direct3D11GeometryBuffer::~Direct3D11GeometryBuffer
~Direct3D11GeometryBuffer()
Destructor.
CEGUI::Direct3D11GeometryBuffer::getActiveTexture
Texture * getActiveTexture() const
Return a pointer to the currently active Texture object. This may return 0 if no texture is set.
CEGUI::Direct3D11GeometryBuffer::setClippingRegion
void setClippingRegion(const Rectf &region)
Set the clipping region to be used when rendering this buffer.
CEGUI::Direct3D11GeometryBuffer::d_pivot
Vector3f d_pivot
pivot point for rotation
Definition: RendererModules/Direct3D11/GeometryBuffer.h:135
CEGUI::Direct3D11GeometryBuffer::d_rotation
Quaternion d_rotation
rotation vector
Definition: RendererModules/Direct3D11/GeometryBuffer.h:133
CEGUI::Direct3D11GeometryBuffer::D3DVertex::x
FLOAT x
The transformed position for the vertex.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:91
CEGUI::Direct3D11GeometryBuffer::D3DVertex
internal Vertex structure used for Direct3D based geometry.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:89
CEGUI::Direct3D11GeometryBuffer::getVertexCount
uint getVertexCount() const
Return the total number of vertices currently held by this GeometryBuffer object.
CEGUI::Direct3D11GeometryBuffer::d_vertexBuffer
ID3D11Buffer * d_vertexBuffer
hardware buffer where vertices will be drawn from.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:113
CEGUI::Direct3D11GeometryBuffer::reset
void reset()
Clear all buffered data and reset the GeometryBuffer to the default state.
CEGUI::Direct3D11GeometryBuffer::VertexList
std::vector< D3DVertex > VertexList
type of container used to queue the geometry
Definition: RendererModules/Direct3D11/GeometryBuffer.h:123
CEGUI::Direct3D11GeometryBuffer::getRenderEffect
RenderEffect * getRenderEffect()
Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
CEGUI::Direct3D11GeometryBuffer::setRotation
void setRotation(const Quaternion &r)
Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::Direct3D11GeometryBuffer::d_vertices
VertexList d_vertices
container where added geometry is stored.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:125
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::Quaternion
Class to represent rotation, avoids Gimbal lock.
Definition: Quaternion.h:69
CEGUI::Direct3D11GeometryBuffer::setRenderEffect
void setRenderEffect(RenderEffect *effect)
Set the RenderEffect to be used by this GeometryBuffer.
CEGUI::Direct3D11GeometryBuffer::D3DVertex::diffuse
DWORD diffuse
colour of the vertex.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:93
CEGUI::Direct3D11GeometryBuffer::cleanupVertexBuffer
void cleanupVertexBuffer() const
cleanup the hardware vertex buffer.
CEGUI::Direct3D11GeometryBuffer::setTranslation
void setTranslation(const Vector3f &v)
Set the translation to be applied to the geometry in the buffer when it is subsequently rendered.
CEGUI::Direct3D11GeometryBuffer::syncHardwareBuffer
void syncHardwareBuffer() const
Synchronise data in the hardware buffer with what's been added.
CEGUI::Direct3D11GeometryBuffer::d_effect
RenderEffect * d_effect
RenderEffect that will be used by the GeometryBuffer.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:137
CEGUI::Vertex
structure that is used to hold details of a single vertex in 3D space.
Definition: Vertex.h:42
CEGUI::Direct3D11GeometryBuffer::appendGeometry
void appendGeometry(const Vertex *const vbuff, uint vertex_count)
Append a number of vertices from an array to the GeometryBuffer.
CEGUI::Direct3D11GeometryBuffer::d_clippingActive
bool d_clippingActive
whether clipping will be active for the current batch
Definition: RendererModules/Direct3D11/GeometryBuffer.h:129
CEGUI::Vector3< float >
CEGUI::Direct3D11GeometryBuffer::d_matrix
D3DXMATRIX d_matrix
model matrix cache
Definition: RendererModules/Direct3D11/GeometryBuffer.h:139
CEGUI::Direct3D11GeometryBuffer::updateMatrix
void updateMatrix() const
update cached matrix
CEGUI::Direct3D11GeometryBuffer::allocateVertexBuffer
void allocateVertexBuffer(const size_t count) const
allocate the hardware vertex buffer large enough for count vertices.
CEGUI::Direct3D11GeometryBuffer::d_translation
Vector3f d_translation
translation vector
Definition: RendererModules/Direct3D11/GeometryBuffer.h:131
CEGUI::Direct3D11GeometryBuffer::d_clipRect
Rectf d_clipRect
rectangular clip region
Definition: RendererModules/Direct3D11/GeometryBuffer.h:127
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::Direct3D11GeometryBuffer::Direct3D11GeometryBuffer
Direct3D11GeometryBuffer(Direct3D11Renderer &owner)
Constructor.
CEGUI::Direct3D11Renderer
Renderer implementation using Direct3D 10.
Definition: RendererModules/Direct3D11/Renderer.h:83
CEGUI::Direct3D11GeometryBuffer::d_bufferSynched
bool d_bufferSynched
whether the h/w buffer is in sync with the added geometry
Definition: RendererModules/Direct3D11/GeometryBuffer.h:117
CEGUI::Direct3D11GeometryBuffer::appendVertex
void appendVertex(const Vertex &vertex)
Append a single vertex to the buffer.
CEGUI::Direct3D11GeometryBuffer::draw
void draw() const
Draw the geometry buffered within this GeometryBuffer object.
CEGUI::Direct3D11GeometryBuffer::d_device
IDevice11 & d_device
The D3D Device.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:109
CEGUI::Direct3D11GeometryBuffer::getMatrix
const D3DXMATRIX * getMatrix() const
return pointer to D3DXMATRIX used by this GeometryBuffer
CEGUI::Direct3D11GeometryBuffer::D3DVertex::tu
float tu
texture coordinates.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:95
CEGUI::Direct3D11GeometryBuffer::getBatchCount
uint getBatchCount() const
Return the number of batches of geometry that this GeometryBuffer has split the vertices into.
CEGUI::Direct3D11GeometryBuffer::setActiveTexture
void setActiveTexture(Texture *texture)
Set the active texture to be used with all subsequently added vertices.
CEGUI::Direct3D11GeometryBuffer::BatchInfo
type to track info for per-texture sub batches of geometry
Definition: RendererModules/Direct3D11/GeometryBuffer.h:100
CEGUI::Direct3D11Texture
Texture implementation for the Direct3D11Renderer.
Definition: RendererModules/Direct3D11/Texture.h:50
CEGUI::Direct3D11GeometryBuffer::BatchList
std::vector< BatchInfo > BatchList
type of container that tracks BatchInfos.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:119
CEGUI::Direct3D11GeometryBuffer
Implementation of CEGUI::GeometryBuffer for the Direct3D 10 API.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:48
CEGUI::Rect< float >
CEGUI::Direct3D11GeometryBuffer::d_activeTexture
Direct3D11Texture * d_activeTexture
last texture that was set as active
Definition: RendererModules/Direct3D11/GeometryBuffer.h:111
CEGUI::Direct3D11GeometryBuffer::setClippingActive
void setClippingActive(const bool active)
Set whether clipping will be active for subsequently added vertices.
CEGUI::Direct3D11GeometryBuffer::setPivot
void setPivot(const Vector3f &p)
Set the pivot point to be used when applying the rotations.
CEGUI::RenderEffect
Interface for objects that hook into RenderingWindow to affect the rendering process,...
Definition: RenderEffect.h:42
CEGUI::Direct3D11GeometryBuffer::d_bufferSize
UINT d_bufferSize
Size of the currently allocated vertex buffer.
Definition: RendererModules/Direct3D11/GeometryBuffer.h:115
CEGUI::Direct3D11GeometryBuffer::d_matrixValid
bool d_matrixValid
true when d_matrix is valid and up to date
Definition: RendererModules/Direct3D11/GeometryBuffer.h:141