OGRE  1.9.0
OgreRenderToVertexBuffer.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-2014 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 __RenderToVertexBuffer_H__
29#define __RenderToVertexBuffer_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreMaterial.h"
33#include "OgreRenderOperation.h"
34
35namespace Ogre {
52 {
53 public:
58
66
70 unsigned int getMaxVertexCount() const { return mMaxVertexCount; }
71
75 void setMaxVertexCount(unsigned int maxVertexCount) { mMaxVertexCount = maxVertexCount; }
76
81
85 void setOperationType(RenderOperation::OperationType operationType) { mOperationType = operationType; }
86
90 void setResetsEveryUpdate(bool resetsEveryUpdate) { mResetsEveryUpdate = resetsEveryUpdate; }
91
96
100 virtual void getRenderOperation(RenderOperation& op) = 0;
101
105 virtual void update(SceneManager* sceneMgr) = 0;
106
111 virtual void reset() { mResetRequested = true; }
112
119
124
130
135 void setRenderToBufferMaterialName(const String& materialName);
136 protected:
143 unsigned int mMaxVertexCount;
144 };
145
149}
150
151#endif
#define _OgreExport
'New' rendering operation using vertex buffers.
OperationType
The rendering operation type to perform.
void setSourceRenderable(Renderable *source)
Set the source renderable of this object.
void setRenderToBufferMaterialName(const String &materialName)
Set the material name which is used to render the geometry into the vertex buffer.
virtual void reset()
Reset the vertex buffer to the initial state.
void setMaxVertexCount(unsigned int maxVertexCount)
Set the maximum number of vertices that the buffer will hold.
virtual void getRenderOperation(RenderOperation &op)=0
Get the render operation for this buffer.
void setOperationType(RenderOperation::OperationType operationType)
Set the type of primitives that this object generates.
RenderOperation::OperationType getOperationType() const
What type of primitives does this object generate?
unsigned int getMaxVertexCount() const
Get the maximum number of vertices that the buffer will hold.
virtual ~RenderToVertexBuffer()
D'tor.
bool getResetsEveryUpdate() const
Does this object reset its buffer each time it updates?
void setResetsEveryUpdate(bool resetsEveryUpdate)
Set whether this object resets its buffers each time it updates.
RenderOperation::OperationType mOperationType
const Renderable * getSourceRenderable() const
Get the source renderable of this object.
virtual void update(SceneManager *sceneMgr)=0
Update the contents of this vertex buffer by rendering.
const MaterialPtr & getRenderToBufferMaterial()
Get the material which is used to render the geometry into the vertex buffer.
VertexDeclaration * getVertexDeclaration()
Abstract class defining the interface all renderable objects must implement.
Manages the organisation and rendering of a 'scene' i.e.
Reference-counted shared pointer, used for objects where implicit destruction is required.
Summary class collecting together vertex source information.
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
SharedPtr< RenderToVertexBuffer > RenderToVertexBufferSharedPtr
SharedPtr< Material > MaterialPtr
_StringBase String