File: librocketrenderinterface.h

package info (click to toggle)
fife 0.4.2-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 25,204 kB
  • sloc: cpp: 42,642; xml: 18,881; python: 13,521; makefile: 23
file content (145 lines) | stat: -rw-r--r-- 5,271 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_GUI_LIBROCKETRENDERINTERFACE_H
#define FIFE_GUI_LIBROCKETRENDERINTERFACE_H

// Standard C++ library includes
#include <list>
#include <queue>
#include <vector>

// 3rd party library includes
#include <Rocket/Core/RenderInterface.h>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/singleton.h"
#include "util/resource/resource.h"
#include "util/structures/rect.h"
#include "util/structures/point.h"
#include "video/color.h"
#include "video/renderbackend.h"

namespace FIFE {
	
	class ImageManager;
	class RenderBackend;
	
	class LibRocketRenderInterface : public Rocket::Core::RenderInterface {
	public:
		
		/** Constructor.
		 */
		LibRocketRenderInterface();
		
		/** Destructor.
		 */
		virtual ~LibRocketRenderInterface();
		
		/** Called by Rocket when it wants to render geometry that it does not wish to optimise.
		 */
		virtual void RenderGeometry(Rocket::Core::Vertex* vertices, int num_vertices, int* indices, int num_indices, Rocket::Core::TextureHandle texture, const Rocket::Core::Vector2f& translation);

		/** Called by Rocket when it wants to compile geometry it believes will be static for the forseeable future.
		 */
		virtual Rocket::Core::CompiledGeometryHandle CompileGeometry(Rocket::Core::Vertex* vertices, int num_vertices, int* indices, int num_indices, Rocket::Core::TextureHandle texture);

		/** Called by Rocket when it wants to render application-compiled geometry.
		 */
		virtual void RenderCompiledGeometry(Rocket::Core::CompiledGeometryHandle geometry, const Rocket::Core::Vector2f& translation);
		
		/** Called by Rocket when it wants to release application-compiled geometry.
		 */
		virtual void ReleaseCompiledGeometry(Rocket::Core::CompiledGeometryHandle geometry);

		/** Called by Rocket when it wants to enable or disable scissoring to clip content.
		 */
		virtual void EnableScissorRegion(bool enable);
		
		/** Called by Rocket when it wants to change the scissor region.
		 */
		virtual void SetScissorRegion(int x, int y, int width, int height);

		/** Called by Rocket when a texture is required by the library.
		 */
		virtual bool LoadTexture(Rocket::Core::TextureHandle& texture_handle, Rocket::Core::Vector2i& texture_dimensions, const Rocket::Core::String& source);
		
		/** Called by Rocket when a texture is required to be built from an internally-generated sequence of pixels.
		 */
		virtual bool GenerateTexture(Rocket::Core::TextureHandle& texture_handle, const Rocket::Core::byte* source, const Rocket::Core::Vector2i& source_dimensions);
		
		/** Called by Rocket when a loaded texture is no longer required.
		 */
		virtual void ReleaseTexture(Rocket::Core::TextureHandle texture_handle);
		
		/**
		 * Renders librocket gui.
		 */
		void render();
		
		/**
		 * Frees all textures that are no longer needed by librocket.
		 */
		void freeTextures();
		
	private:
		
		RenderBackend* m_renderBackend;
		
		ImageManager* m_imageManager;
		
		class GeometryCallData {
		public:
			std::vector<GuiVertex> vertices;
			std::vector<int> indices;
			ResourceHandle textureHandle;
			DoublePoint translation;
		};
		
		typedef std::queue<GeometryCallData> GeometryCallDataChain;
		
		class GeometryCall {
		public:
			
			GeometryCall() 
			: 
			enableScissorTest(false),
			hasScissorArea(false)
		    {
			}
			
			GeometryCallDataChain callChain;
			Rect scissorArea;
			bool enableScissorTest;
			bool hasScissorArea;
		};
		
		std::queue<GeometryCall> m_geometryCalls;
		
		std::list<ResourceHandle> m_freedTextures;
	};
	
};

#endif // FIFE_GUI_LIBROCKETRENDERINTERFACE_H