File: IGfxDevice.h

package info (click to toggle)
jazz2-native 3.5.0-1
  • links: PTS, VCS
  • area: contrib
  • in suites:
  • size: 16,836 kB
  • sloc: cpp: 172,557; xml: 113; python: 36; makefile: 5; sh: 2
file content (277 lines) | stat: -rw-r--r-- 10,595 bytes parent folder | download | duplicates (3)
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
#pragma once

#include "../Primitives/Vector2.h"
#include "../Primitives/Rect.h"
#include "DisplayMode.h"
#include "../AppConfiguration.h"
#include "../../Main.h"

#include <Containers/SmallVector.h>

using namespace Death::Containers;

#if defined(DEATH_TARGET_EMSCRIPTEN)
class EmscriptenUiEvent;
class EmscriptenFullscreenChangeEvent;
class EmscriptenFocusEvent;
#endif

namespace nCine
{
	/// Represents the interface to the graphics device where everything is rendered
	class IGfxDevice
	{
		friend class Application;
#if defined(WITH_SDL)
		friend class MainApplication;
#endif

	public:
		static constexpr std::uint32_t MaxMonitors = 4;
#if defined(WITH_QT5)
		// Qt5 cannot query the list of supported video modes of a monitor
		static constexpr std::uint32_t MaxVideoModes = 1;
#elif defined(DEATH_TARGET_ANDROID)
		static constexpr std::uint32_t MaxVideoModes = 16;
#else
		static constexpr std::uint32_t MaxVideoModes = 128;
#endif

		/// A structure used to initialize window properties
		struct WindowMode
		{
			WindowMode()
				: width(0), height(0), windowPositionX(AppConfiguration::WindowPositionIgnore), windowPositionY(AppConfiguration::WindowPositionIgnore), isFullscreen(false), isResizable(false), hasWindowScaling(true) { }
			WindowMode(std::int32_t w, std::int32_t h, std::int32_t posX, std::int32_t posY, bool fullscreen, bool resizable, bool windowScaling)
				: width(w), height(h), windowPositionX(posX), windowPositionY(posY), isFullscreen(fullscreen), isResizable(resizable), hasWindowScaling(windowScaling) { }

			std::int32_t width;
			std::int32_t height;
			std::int32_t windowPositionX;
			std::int32_t windowPositionY;
			bool isFullscreen;
			bool isResizable;
			bool hasWindowScaling;
		};

		/// A structure representing a video mode supported by a monitor
		struct VideoMode
		{
			VideoMode()
				: width(0), height(0), refreshRate(0.0f), redBits(8), greenBits(8), blueBits(8) { }

			inline bool operator==(const VideoMode& mode) const
			{
				return (width == mode.width && height == mode.height && refreshRate == mode.refreshRate &&
						redBits == mode.redBits && greenBits == mode.greenBits && blueBits == mode.blueBits);
			}
			inline bool operator!=(const VideoMode& mode) const {
				return !operator==(mode);
			}

			std::uint32_t width;
			std::uint32_t height;
			float refreshRate;
			std::uint32_t redBits;
			std::uint32_t greenBits;
			std::uint32_t blueBits;
		};

		/// A structure representing a connected monitor
		struct Monitor
		{
			/// The monitor name
			const char* name;
			/// The position of the monitor's viewport on the virtual screen
			Vector2i position;
			/// The content scale factor
			Vector2f scale;

			/// The number of video modes in the array
			std::int32_t numVideoModes;
			/// The array of video modes supported by the monitor
			VideoMode videoModes[MaxVideoModes];
		};

		/// Contains the attributes to create an OpenGL context
		struct GLContextInfo
		{
			GLContextInfo()
				: majorVersion(0), minorVersion(0), coreProfile(false), forwardCompatible(false), debugContext(false) { }

			explicit GLContextInfo(const AppConfiguration& appCfg)
				: majorVersion(appCfg.glMajorVersion()), minorVersion(appCfg.glMinorVersion()),
				  coreProfile(appCfg.glCoreProfile()), forwardCompatible(appCfg.glForwardCompatible()),
				  debugContext(appCfg.withGlDebugContext) { }

			std::uint32_t majorVersion;
			std::uint32_t minorVersion;
			bool coreProfile;
			bool forwardCompatible;
			bool debugContext;
		};

		IGfxDevice(const WindowMode& windowMode, const GLContextInfo& glContextInfo, const DisplayMode& displayMode);
		virtual ~IGfxDevice() { }

		/// Sets the number of vertical blanks to occur before a buffer swap
		/*! An interval of `-1` will enable adaptive v-sync if available */
		virtual void setSwapInterval(int interval) = 0;

		/// Returns true if the device renders in full screen
		inline bool isFullscreen() const { return isFullscreen_; }
		/// Sets screen resolution with two integers
		virtual void setResolution(bool fullscreen, int width = 0, int height = 0) = 0;

		/// Sets the position of the application window with two integers
		virtual void setWindowPosition(int x, int y) = 0;
		/// Sets the position of the application window with a `Vector2<int>` object
		inline void setWindowPosition(Vector2i position) {
			setWindowPosition(position.X, position.Y);
		}
		/// Sets the application window title
		virtual void setWindowTitle(StringView windowTitle) = 0;
		/// Sets the application window icon
		virtual void setWindowIcon(StringView iconFilename) = 0;

		/// Returns the window or video mode width in screen coordinates
		inline int width() const { return width_; }
		/// Returns the window or video mode height in screen coordinates
		inline int height() const { return height_; }
		/// Returns the window or video mode resolution in screen coordinates as a `Vector2i` object
		inline Vector2i resolution() const { return Vector2i(width_, height_); }
		/// Returns the window or video mode resolution in screen coordinates as a `Rectf` object
		inline Rectf screenRect() const { return Rectf(0.0f, 0.0f, static_cast<float>(width_), static_cast<float>(height_)); }
		/// Returns the window or video mode resolution aspect ratio
		inline float aspect() const { return width_ / static_cast<float>(height_); }
		/// Sets the window size with two integers
		/*! \note If the application is in full screen this method will have no effect. */
		virtual void setWindowSize(int width, int height) = 0;

		/// Returns window position as a `Vector2i` object
		inline virtual const Vector2i windowPosition() const { return Vector2i(0, 0); }

		/// Returns the window width in pixels
		/*! It may differs from `width()` on HiDPI screens */
		inline int drawableWidth() const { return drawableWidth_; }
		/// Returns the window height in pixels
		/*! It may differs from `height()` on HiDPI screens */
		inline int drawableHeight() const { return drawableHeight_; }
		/// Returns the window resolution in pixels as a `Vector2i` object
		inline Vector2i drawableResolution() const { return Vector2i(drawableWidth_, drawableHeight_); }
		/// Returns the window resolution in pixels as a `Rectf` object
		inline Rectf drawableScreenRect() const { return Rectf(0.0f, 0.0f, static_cast<float>(drawableWidth_), static_cast<float>(drawableHeight_)); }
		/// Returns the window drawable resolution aspect ratio
		inline float drawableAspect() const { return drawableWidth_ / static_cast<float>(drawableHeight_); }

		/// Highlights the application window to notify the user
		inline virtual void flashWindow() const { }

		/// Returns the OpenGL context creation attributes
		inline const GLContextInfo& glContextInfo() const { return glContextInfo_; }
		/// Returns display mode
		inline const DisplayMode& displayMode() const { return displayMode_; }

		/// Returns the number of connected monitors
		unsigned int numMonitors() const;
		/// Returns the array index of the primary monitor
		inline virtual unsigned int primaryMonitorIndex() const { return 0; }
		/// Returns the array index of the monitor associated with the window
		inline virtual unsigned int windowMonitorIndex() const { return 0; }
		/// Returns the specified monitor
		const Monitor &monitor(unsigned int index) const;
		/// Returns the monitor that hosts the window
		inline const Monitor& monitor() const { return monitor(windowMonitorIndex()); }

		/// Returns the current video mode for the specified monitor
		virtual const VideoMode& currentVideoMode(unsigned int monitorIndex) const = 0;
		/// Returns the current video mode for the monitor that hosts the window
		inline const VideoMode& currentVideoMode() const { return currentVideoMode(windowMonitorIndex()); }
		/// Sets the video mode that will be used in full screen by the monitor that hosts the window
		/*! \note Call this method <b>before</b> enabling full screen */
		inline virtual bool setVideoMode(unsigned int modeIndex) { return false; }

		/// Returns the scaling factor for application window
		float windowScalingFactor() const;

	protected:
		static constexpr float DefaultDPI = 96.0f;

#ifndef DOXYGEN_GENERATING_OUTPUT
		/// Window width in screen coordinates
		std::int32_t width_;
		/// Window height in screen coordinates
		std::int32_t height_;
		/// Window width in pixels (for HiDPI screens)
		std::int32_t drawableWidth_;
		/// Window height in pixels (for HiDPI screens)
		std::int32_t drawableHeight_;
		/// Whether rendering occurs in full screen
		bool isFullscreen_;
		/// OpenGL context creation attributes
		GLContextInfo glContextInfo_;
		/// Display properties
		DisplayMode displayMode_;

		Monitor monitors_[MaxMonitors];
		std::uint32_t numMonitors_;
		/// Used as a cache to avoid searching the current video mode in a monitor's array
		mutable VideoMode currentVideoMode_;
#endif

		/// Inits the OpenGL viewport based on the drawable resolution
		void initGLViewport();

		/// Updates the array of connected monitors
		inline virtual void updateMonitors() { }

		virtual void setResolutionInternal(int width, int height) = 0;

	private:
		/// Sets up the initial OpenGL state for the scenegraph
		virtual void setupGL();

		/// Updates the screen swapping back and front buffers
		virtual void update() = 0;

#if defined(DEATH_TARGET_EMSCRIPTEN)
		static bool emscriptenHandleResize(int eventType, const EmscriptenUiEvent* event, void* userData);
		static bool emscriptenHandleFullscreen(int eventType, const EmscriptenFullscreenChangeEvent* event, void* userData);

#	if defined(WITH_GLFW)
		static bool emscriptenHandleFocus(int eventType, const EmscriptenFocusEvent* event, void* userData);
#	endif
#endif
	};

#ifndef DOXYGEN_GENERATING_OUTPUT
	/// A fake graphics device which doesn't render anything
	class NullGfxDevice : public IGfxDevice
	{
	public:
		NullGfxDevice()
			: IGfxDevice(WindowMode{}, GLContextInfo{}, DisplayMode{}) {}

		void setSwapInterval(int interval) override {}

		void setResolution(bool fullscreen, int width = 0, int height = 0) override {}

		void setWindowPosition(int x, int y) override {}
		void setWindowTitle(StringView windowTitle) override {}
		void setWindowIcon(StringView iconFilename) override {}

		void setWindowSize(int width, int height) override {}

		void flashWindow() const override {}

		const VideoMode& currentVideoMode(unsigned int monitorIndex) const override { return currentVideoMode_; }

	protected:
		void setResolutionInternal(int width, int height) override {}

	private:
		void setupGL() override {}
		void update() override {}
	};
#endif
}