3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <IrrlichtDevice.h>
23 #include "fontengine.h"
26 #include "util/numeric.h"
27 #include "guiscalingfilter.h"
28 #include "localplayer.h"
29 #include "client/hud.h"
32 #include "clientmap.h"
33 #include "renderingengine.h"
34 #include "render/core.h"
35 #include "render/factory.h"
36 #include "inputhandler.h"
38 #include "../gui/guiSkin.h"
40 #if !defined(_WIN32) && !defined(__APPLE__) && !defined(__ANDROID__) && \
41 !defined(SERVER) && !defined(__HAIKU__)
46 #include <X11/Xutil.h>
47 #include <X11/Xatom.h>
59 RenderingEngine *RenderingEngine::s_singleton = nullptr;
62 static gui::GUISkin *createSkin(gui::IGUIEnvironment *environment,
63 gui::EGUI_SKIN_TYPE type, video::IVideoDriver *driver)
65 gui::GUISkin *skin = new gui::GUISkin(type, driver);
67 gui::IGUIFont *builtinfont = environment->getBuiltInFont();
68 gui::IGUIFontBitmap *bitfont = nullptr;
69 if (builtinfont && builtinfont->getType() == gui::EGFT_BITMAP)
70 bitfont = (gui::IGUIFontBitmap*)builtinfont;
72 gui::IGUISpriteBank *bank = 0;
73 skin->setFont(builtinfont);
76 bank = bitfont->getSpriteBank();
78 skin->setSpriteBank(bank);
84 RenderingEngine::RenderingEngine(IEventReceiver *receiver)
86 sanity_check(!s_singleton);
88 // Resolution selection
89 bool fullscreen = g_settings->getBool("fullscreen");
90 u16 screen_w = g_settings->getU16("screen_w");
91 u16 screen_h = g_settings->getU16("screen_h");
94 bool vsync = g_settings->getBool("vsync");
95 u16 bits = g_settings->getU16("fullscreen_bpp");
96 u16 fsaa = g_settings->getU16("fsaa");
98 // stereo buffer required for pageflip stereo
99 bool stereo_buffer = g_settings->get("3d_mode") == "pageflip";
102 video::E_DRIVER_TYPE driverType = video::EDT_OPENGL;
103 const std::string &driverstring = g_settings->get("video_driver");
104 std::vector<video::E_DRIVER_TYPE> drivers =
105 RenderingEngine::getSupportedVideoDrivers();
107 for (i = 0; i != drivers.size(); i++) {
108 if (!strcasecmp(driverstring.c_str(),
109 RenderingEngine::getVideoDriverName(drivers[i]))) {
110 driverType = drivers[i];
114 if (i == drivers.size()) {
115 errorstream << "Invalid video_driver specified; "
116 "defaulting to opengl"
120 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
121 params.DriverType = driverType;
122 params.WindowSize = core::dimension2d<u32>(screen_w, screen_h);
124 params.AntiAlias = fsaa;
125 params.Fullscreen = fullscreen;
126 params.Stencilbuffer = false;
127 params.Stereobuffer = stereo_buffer;
128 params.Vsync = vsync;
129 params.EventReceiver = receiver;
130 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
131 params.ZBufferBits = 24;
133 params.PrivateData = porting::app_global;
136 // there is no standardized path for these on desktop
137 std::string rel_path = std::string("client") + DIR_DELIM
138 + "shaders" + DIR_DELIM + "Irrlicht";
139 params.OGLES2ShaderPath = (porting::path_share + DIR_DELIM + rel_path + DIR_DELIM).c_str();
142 m_device = createDeviceEx(params);
143 driver = m_device->getVideoDriver();
147 auto skin = createSkin(m_device->getGUIEnvironment(),
148 gui::EGST_WINDOWS_METALLIC, driver);
149 m_device->getGUIEnvironment()->setSkin(skin);
153 RenderingEngine::~RenderingEngine()
156 m_device->closeDevice();
157 s_singleton = nullptr;
160 v2u32 RenderingEngine::getWindowSize() const
163 return core->getVirtualSize();
164 return m_device->getVideoDriver()->getScreenSize();
167 void RenderingEngine::setResizable(bool resize)
169 m_device->setResizable(resize);
172 bool RenderingEngine::print_video_modes()
174 IrrlichtDevice *nulldevice;
176 bool vsync = g_settings->getBool("vsync");
177 u16 fsaa = g_settings->getU16("fsaa");
178 MyEventReceiver *receiver = new MyEventReceiver();
180 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
181 params.DriverType = video::EDT_NULL;
182 params.WindowSize = core::dimension2d<u32>(640, 480);
184 params.AntiAlias = fsaa;
185 params.Fullscreen = false;
186 params.Stencilbuffer = false;
187 params.Vsync = vsync;
188 params.EventReceiver = receiver;
189 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
191 nulldevice = createDeviceEx(params);
198 std::cout << _("Available video modes (WxHxD):") << std::endl;
200 video::IVideoModeList *videomode_list = nulldevice->getVideoModeList();
202 if (videomode_list != NULL) {
203 s32 videomode_count = videomode_list->getVideoModeCount();
204 core::dimension2d<u32> videomode_res;
206 for (s32 i = 0; i < videomode_count; ++i) {
207 videomode_res = videomode_list->getVideoModeResolution(i);
208 videomode_depth = videomode_list->getVideoModeDepth(i);
209 std::cout << videomode_res.Width << "x" << videomode_res.Height
210 << "x" << videomode_depth << std::endl;
213 std::cout << _("Active video mode (WxHxD):") << std::endl;
214 videomode_res = videomode_list->getDesktopResolution();
215 videomode_depth = videomode_list->getDesktopDepth();
216 std::cout << videomode_res.Width << "x" << videomode_res.Height << "x"
217 << videomode_depth << std::endl;
223 return videomode_list != NULL;
226 bool RenderingEngine::setupTopLevelWindow(const std::string &name)
228 // FIXME: It would make more sense for there to be a switch of some
229 // sort here that would call the correct toplevel setup methods for
230 // the environment Minetest is running in.
232 /* Setting Xorg properties for the top level window */
233 setupTopLevelXorgWindow(name);
235 /* Setting general properties for the top level window */
236 verbosestream << "Client: Configuring general top level"
237 << " window properties"
239 bool result = setWindowIcon();
244 void RenderingEngine::setupTopLevelXorgWindow(const std::string &name)
247 const video::SExposedVideoData exposedData = driver->getExposedVideoData();
249 Display *x11_dpl = reinterpret_cast<Display *>(exposedData.OpenGLLinux.X11Display);
250 if (x11_dpl == NULL) {
251 warningstream << "Client: Could not find X11 Display in ExposedVideoData"
256 verbosestream << "Client: Configuring X11-specific top level"
257 << " window properties"
261 Window x11_win = reinterpret_cast<Window>(exposedData.OpenGLLinux.X11Window);
263 // Set application name and class hints. For now name and class are the same.
264 XClassHint *classhint = XAllocClassHint();
265 classhint->res_name = const_cast<char *>(name.c_str());
266 classhint->res_class = const_cast<char *>(name.c_str());
268 XSetClassHint(x11_dpl, x11_win, classhint);
271 // FIXME: In the future WMNormalHints should be set ... e.g see the
272 // gtk/gdk code (gdk/x11/gdksurface-x11.c) for the setup_top_level
273 // method. But for now (as it would require some significant changes)
274 // leave the code as is.
276 // The following is borrowed from the above gdk source for setting top
277 // level windows. The source indicates and the Xlib docs suggest that
278 // this will set the WM_CLIENT_MACHINE and WM_LOCAL_NAME. This will not
279 // set the WM_CLIENT_MACHINE to a Fully Qualified Domain Name (FQDN) which is
280 // required by the Extended Window Manager Hints (EWMH) spec when setting
281 // the _NET_WM_PID (see further down) but running Minetest in an env
282 // where the window manager is on another machine from Minetest (therefore
283 // making the PID useless) is not expected to be a problem. Further
284 // more, using gtk/gdk as the model it would seem that not using a FQDN is
285 // not an issue for modern Xorg window managers.
287 verbosestream << "Client: Setting Xorg window manager Properties"
290 XSetWMProperties (x11_dpl, x11_win, NULL, NULL, NULL, 0, NULL, NULL, NULL);
292 // Set the _NET_WM_PID window property according to the EWMH spec. _NET_WM_PID
293 // (in conjunction with WM_CLIENT_MACHINE) can be used by window managers to
294 // force a shutdown of an application if it doesn't respond to the destroy
297 verbosestream << "Client: Setting Xorg _NET_WM_PID extened window manager property"
300 Atom NET_WM_PID = XInternAtom(x11_dpl, "_NET_WM_PID", false);
302 pid_t pid = getpid();
304 XChangeProperty(x11_dpl, x11_win, NET_WM_PID,
305 XA_CARDINAL, 32, PropModeReplace,
306 reinterpret_cast<unsigned char *>(&pid),1);
308 // Set the WM_CLIENT_LEADER window property here. Minetest has only one
309 // window and that window will always be the leader.
311 verbosestream << "Client: Setting Xorg WM_CLIENT_LEADER property"
314 Atom WM_CLIENT_LEADER = XInternAtom(x11_dpl, "WM_CLIENT_LEADER", false);
316 XChangeProperty (x11_dpl, x11_win, WM_CLIENT_LEADER,
317 XA_WINDOW, 32, PropModeReplace,
318 reinterpret_cast<unsigned char *>(&x11_win), 1);
323 static bool getWindowHandle(irr::video::IVideoDriver *driver, HWND &hWnd)
325 const video::SExposedVideoData exposedData = driver->getExposedVideoData();
327 switch (driver->getDriverType()) {
328 #if IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 9
329 case video::EDT_DIRECT3D8:
330 hWnd = reinterpret_cast<HWND>(exposedData.D3D8.HWnd);
333 case video::EDT_DIRECT3D9:
334 hWnd = reinterpret_cast<HWND>(exposedData.D3D9.HWnd);
336 case video::EDT_OPENGL:
337 hWnd = reinterpret_cast<HWND>(exposedData.OpenGLWin32.HWnd);
347 bool RenderingEngine::setWindowIcon()
349 #if defined(XORG_USED)
351 return setXorgWindowIconFromPath(
352 porting::path_share + "/misc/" PROJECT_NAME "-xorg-icon-128.png");
354 // We have semi-support for reading in-place data if we are
355 // compiled with RUN_IN_PLACE. Don't break with this and
356 // also try the path_share location.
357 return setXorgWindowIconFromPath(
358 ICON_DIR "/hicolor/128x128/apps/" PROJECT_NAME ".png") ||
359 setXorgWindowIconFromPath(porting::path_share + "/misc/" PROJECT_NAME
360 "-xorg-icon-128.png");
362 #elif defined(_WIN32)
363 HWND hWnd; // Window handle
364 if (!getWindowHandle(driver, hWnd))
367 // Load the ICON from resource file
368 const HICON hicon = LoadIcon(GetModuleHandle(NULL),
369 MAKEINTRESOURCE(130) // The ID of the ICON defined in
374 SendMessage(hWnd, WM_SETICON, ICON_BIG, reinterpret_cast<LPARAM>(hicon));
375 SendMessage(hWnd, WM_SETICON, ICON_SMALL,
376 reinterpret_cast<LPARAM>(hicon));
385 bool RenderingEngine::setXorgWindowIconFromPath(const std::string &icon_file)
389 video::IImageLoader *image_loader = NULL;
390 u32 cnt = driver->getImageLoaderCount();
391 for (u32 i = 0; i < cnt; i++) {
392 if (driver->getImageLoader(i)->isALoadableFileExtension(
393 icon_file.c_str())) {
394 image_loader = driver->getImageLoader(i);
400 warningstream << "Could not find image loader for file '" << icon_file
405 io::IReadFile *icon_f =
406 m_device->getFileSystem()->createAndOpenFile(icon_file.c_str());
409 warningstream << "Could not load icon file '" << icon_file << "'"
414 video::IImage *img = image_loader->loadImage(icon_f);
417 warningstream << "Could not load icon file '" << icon_file << "'"
423 u32 height = img->getDimension().Height;
424 u32 width = img->getDimension().Width;
426 size_t icon_buffer_len = 2 + height * width;
427 long *icon_buffer = new long[icon_buffer_len];
429 icon_buffer[0] = width;
430 icon_buffer[1] = height;
432 for (u32 x = 0; x < width; x++) {
433 for (u32 y = 0; y < height; y++) {
434 video::SColor col = img->getPixel(x, y);
436 pixel_val |= (u8)col.getAlpha() << 24;
437 pixel_val |= (u8)col.getRed() << 16;
438 pixel_val |= (u8)col.getGreen() << 8;
439 pixel_val |= (u8)col.getBlue();
440 icon_buffer[2 + x + y * width] = pixel_val;
447 const video::SExposedVideoData &video_data = driver->getExposedVideoData();
449 Display *x11_dpl = (Display *)video_data.OpenGLLinux.X11Display;
451 if (x11_dpl == NULL) {
452 warningstream << "Could not find x11 display for setting its icon."
454 delete[] icon_buffer;
458 Window x11_win = (Window)video_data.OpenGLLinux.X11Window;
460 Atom net_wm_icon = XInternAtom(x11_dpl, "_NET_WM_ICON", False);
461 Atom cardinal = XInternAtom(x11_dpl, "CARDINAL", False);
462 XChangeProperty(x11_dpl, x11_win, net_wm_icon, cardinal, 32, PropModeReplace,
463 (const unsigned char *)icon_buffer, icon_buffer_len);
465 delete[] icon_buffer;
472 Draws a screen with a single text on it.
473 Text will be removed when the screen is drawn the next time.
474 Additionally, a progressbar can be drawn when percent is set between 0 and 100.
476 void RenderingEngine::_draw_load_screen(const std::wstring &text,
477 gui::IGUIEnvironment *guienv, ITextureSource *tsrc, float dtime,
478 int percent, bool clouds)
480 v2u32 screensize = RenderingEngine::get_instance()->getWindowSize();
482 v2s32 textsize(g_fontengine->getTextWidth(text), g_fontengine->getLineHeight());
483 v2s32 center(screensize.X / 2, screensize.Y / 2);
484 core::rect<s32> textrect(center - textsize / 2, center + textsize / 2);
486 gui::IGUIStaticText *guitext =
487 guienv->addStaticText(text.c_str(), textrect, false, false);
488 guitext->setTextAlignment(gui::EGUIA_CENTER, gui::EGUIA_UPPERLEFT);
490 bool cloud_menu_background = clouds && g_settings->getBool("menu_clouds");
491 if (cloud_menu_background) {
492 g_menuclouds->step(dtime * 3);
493 g_menuclouds->render();
494 get_video_driver()->beginScene(
495 true, true, video::SColor(255, 140, 186, 250));
496 g_menucloudsmgr->drawAll();
498 get_video_driver()->beginScene(true, true, video::SColor(255, 0, 0, 0));
501 if ((percent >= 0) && (percent <= 100)) {
502 video::ITexture *progress_img = tsrc->getTexture("progress_bar.png");
503 video::ITexture *progress_img_bg =
504 tsrc->getTexture("progress_bar_bg.png");
506 if (progress_img && progress_img_bg) {
508 const core::dimension2d<u32> &img_size =
509 progress_img_bg->getSize();
510 u32 imgW = rangelim(img_size.Width, 200, 600);
511 u32 imgH = rangelim(img_size.Height, 24, 72);
513 const core::dimension2d<u32> img_size(256, 48);
514 float imgRatio = (float)img_size.Height / img_size.Width;
515 u32 imgW = screensize.X / 2.2f;
516 u32 imgH = floor(imgW * imgRatio);
518 v2s32 img_pos((screensize.X - imgW) / 2,
519 (screensize.Y - imgH) / 2);
521 draw2DImageFilterScaled(get_video_driver(), progress_img_bg,
522 core::rect<s32>(img_pos.X, img_pos.Y,
525 core::rect<s32>(0, 0, img_size.Width,
529 draw2DImageFilterScaled(get_video_driver(), progress_img,
530 core::rect<s32>(img_pos.X, img_pos.Y,
531 img_pos.X + (percent * imgW) / 100,
533 core::rect<s32>(0, 0,
534 (percent * img_size.Width) / 100,
541 get_video_driver()->endScene();
546 Draws the menu scene including (optional) cloud background.
548 void RenderingEngine::_draw_menu_scene(gui::IGUIEnvironment *guienv,
549 float dtime, bool clouds)
551 bool cloud_menu_background = clouds && g_settings->getBool("menu_clouds");
552 if (cloud_menu_background) {
553 g_menuclouds->step(dtime * 3);
554 g_menuclouds->render();
555 get_video_driver()->beginScene(
556 true, true, video::SColor(255, 140, 186, 250));
557 g_menucloudsmgr->drawAll();
559 get_video_driver()->beginScene(true, true, video::SColor(255, 0, 0, 0));
562 get_video_driver()->endScene();
565 std::vector<core::vector3d<u32>> RenderingEngine::getSupportedVideoModes()
567 IrrlichtDevice *nulldevice = createDevice(video::EDT_NULL);
568 sanity_check(nulldevice);
570 std::vector<core::vector3d<u32>> mlist;
571 video::IVideoModeList *modelist = nulldevice->getVideoModeList();
573 s32 num_modes = modelist->getVideoModeCount();
574 for (s32 i = 0; i != num_modes; i++) {
575 core::dimension2d<u32> mode_res = modelist->getVideoModeResolution(i);
576 u32 mode_depth = (u32)modelist->getVideoModeDepth(i);
577 mlist.emplace_back(mode_res.Width, mode_res.Height, mode_depth);
584 std::vector<irr::video::E_DRIVER_TYPE> RenderingEngine::getSupportedVideoDrivers()
586 std::vector<irr::video::E_DRIVER_TYPE> drivers;
588 for (int i = 0; i != irr::video::EDT_COUNT; i++) {
589 if (irr::IrrlichtDevice::isDriverSupported((irr::video::E_DRIVER_TYPE)i))
590 drivers.push_back((irr::video::E_DRIVER_TYPE)i);
596 void RenderingEngine::_initialize(Client *client, Hud *hud)
598 const std::string &draw_mode = g_settings->get("3d_mode");
599 core.reset(createRenderingCore(draw_mode, m_device, client, hud));
603 void RenderingEngine::_finalize()
608 void RenderingEngine::_draw_scene(video::SColor skycolor, bool show_hud,
609 bool show_minimap, bool draw_wield_tool, bool draw_crosshair)
611 core->draw(skycolor, show_hud, show_minimap, draw_wield_tool, draw_crosshair);
614 const char *RenderingEngine::getVideoDriverName(irr::video::E_DRIVER_TYPE type)
616 static const char *driver_ids[] = {
627 return driver_ids[type];
630 const char *RenderingEngine::getVideoDriverFriendlyName(irr::video::E_DRIVER_TYPE type)
632 static const char *driver_names[] = {
643 return driver_names[type];
647 #if defined(XORG_USED)
649 static float calcDisplayDensity()
651 const char *current_display = getenv("DISPLAY");
653 if (current_display != NULL) {
654 Display *x11display = XOpenDisplay(current_display);
656 if (x11display != NULL) {
658 int dh = DisplayHeight(x11display, 0);
659 int dw = DisplayWidth(x11display, 0);
660 int dh_mm = DisplayHeightMM(x11display, 0);
661 int dw_mm = DisplayWidthMM(x11display, 0);
662 XCloseDisplay(x11display);
664 if (dh_mm != 0 && dw_mm != 0) {
665 float dpi_height = floor(dh / (dh_mm * 0.039370) + 0.5);
666 float dpi_width = floor(dw / (dw_mm * 0.039370) + 0.5);
667 return std::max(dpi_height, dpi_width) / 96.0;
672 /* return manually specified dpi */
673 return g_settings->getFloat("screen_dpi") / 96.0;
676 float RenderingEngine::getDisplayDensity()
678 static float cached_display_density = calcDisplayDensity();
679 return cached_display_density;
682 #elif defined(_WIN32)
685 static float calcDisplayDensity(irr::video::IVideoDriver *driver)
688 if (getWindowHandle(driver, hWnd)) {
689 HDC hdc = GetDC(hWnd);
690 float dpi = GetDeviceCaps(hdc, LOGPIXELSX);
691 ReleaseDC(hWnd, hdc);
695 /* return manually specified dpi */
696 return g_settings->getFloat("screen_dpi") / 96.0f;
699 float RenderingEngine::getDisplayDensity()
701 static bool cached = false;
702 static float display_density;
704 display_density = calcDisplayDensity(get_video_driver());
707 return display_density;
712 float RenderingEngine::getDisplayDensity()
714 return g_settings->getFloat("screen_dpi") / 96.0;
719 v2u32 RenderingEngine::getDisplaySize()
721 IrrlichtDevice *nulldevice = createDevice(video::EDT_NULL);
723 core::dimension2d<u32> deskres =
724 nulldevice->getVideoModeList()->getDesktopResolution();
731 float RenderingEngine::getDisplayDensity()
733 return porting::getDisplayDensity();
736 v2u32 RenderingEngine::getDisplaySize()
738 return porting::getDisplaySize();
740 #endif // __ANDROID__