2014-04-08 20:18:23 -07:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-16 21:38:14 -08:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-04-08 20:18:23 -07:00
|
|
|
// Refer to the license.txt file included.
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2014-04-08 20:18:23 -07:00
|
|
|
#pragma once
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2017-08-08 16:57:42 -07:00
|
|
|
#include <memory>
|
2015-06-21 06:02:11 -07:00
|
|
|
#include <tuple>
|
|
|
|
#include <utility>
|
2015-05-06 00:06:12 -07:00
|
|
|
#include "common/common_types.h"
|
2017-05-27 16:10:25 -07:00
|
|
|
#include "core/frontend/framebuffer_layout.h"
|
2015-06-21 06:02:11 -07:00
|
|
|
|
2018-08-11 17:20:19 -07:00
|
|
|
namespace Core::Frontend {
|
|
|
|
|
2020-04-01 22:32:58 -07:00
|
|
|
/// Information for the Graphics Backends signifying what type of screen pointer is in
|
|
|
|
/// WindowInformation
|
|
|
|
enum class WindowSystemType {
|
|
|
|
Headless,
|
|
|
|
Windows,
|
|
|
|
X11,
|
|
|
|
Wayland,
|
|
|
|
};
|
|
|
|
|
2019-01-11 20:06:34 -08:00
|
|
|
/**
|
2020-03-24 19:58:49 -07:00
|
|
|
* Represents a drawing context that supports graphics operations.
|
2019-01-11 20:06:34 -08:00
|
|
|
*/
|
|
|
|
class GraphicsContext {
|
|
|
|
public:
|
2019-05-03 22:47:16 -07:00
|
|
|
virtual ~GraphicsContext();
|
|
|
|
|
2020-03-24 19:58:49 -07:00
|
|
|
/// Inform the driver to swap the front/back buffers and present the current image
|
|
|
|
virtual void SwapBuffers() {}
|
|
|
|
|
2019-01-11 20:06:34 -08:00
|
|
|
/// Makes the graphics context current for the caller thread
|
2020-03-24 19:58:49 -07:00
|
|
|
virtual void MakeCurrent() {}
|
2019-01-11 20:06:34 -08:00
|
|
|
|
|
|
|
/// Releases (dunno if this is the "right" word) the context from the caller thread
|
2020-03-24 19:58:49 -07:00
|
|
|
virtual void DoneCurrent() {}
|
|
|
|
|
|
|
|
class Scoped {
|
|
|
|
public:
|
2020-08-02 17:17:42 -07:00
|
|
|
[[nodiscard]] explicit Scoped(GraphicsContext& context_) : context(context_) {
|
2020-03-24 19:58:49 -07:00
|
|
|
context.MakeCurrent();
|
|
|
|
}
|
|
|
|
~Scoped() {
|
|
|
|
context.DoneCurrent();
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
GraphicsContext& context;
|
|
|
|
};
|
|
|
|
|
|
|
|
/// Calls MakeCurrent on the context and calls DoneCurrent when the scope for the returned value
|
|
|
|
/// ends
|
2020-08-02 17:17:42 -07:00
|
|
|
[[nodiscard]] Scoped Acquire() {
|
2020-03-24 19:58:49 -07:00
|
|
|
return Scoped{*this};
|
|
|
|
}
|
2019-01-11 20:06:34 -08:00
|
|
|
};
|
|
|
|
|
2014-11-13 09:12:27 -08:00
|
|
|
/**
|
|
|
|
* Abstraction class used to provide an interface between emulation code and the frontend
|
|
|
|
* (e.g. SDL, QGLWidget, GLFW, etc...).
|
|
|
|
*
|
|
|
|
* Design notes on the interaction between EmuWindow and the emulation core:
|
|
|
|
* - Generally, decisions on anything visible to the user should be left up to the GUI.
|
|
|
|
* For example, the emulation core should not try to dictate some window title or size.
|
|
|
|
* This stuff is not the core's business and only causes problems with regards to thread-safety
|
|
|
|
* anyway.
|
|
|
|
* - Under certain circumstances, it may be desirable for the core to politely request the GUI
|
|
|
|
* to set e.g. a minimum window size. However, the GUI should always be free to ignore any
|
|
|
|
* such hints.
|
|
|
|
* - EmuWindow may expose some of its state as read-only to the emulation core, however care
|
|
|
|
* should be taken to make sure the provided information is self-consistent. This requires
|
|
|
|
* some sort of synchronization (most of this is still a TODO).
|
2014-11-13 11:45:37 -08:00
|
|
|
* - DO NOT TREAT THIS CLASS AS A GUI TOOLKIT ABSTRACTION LAYER. That's not what it is. Please
|
|
|
|
* re-read the upper points again and think about it if you don't see this.
|
2014-11-13 09:12:27 -08:00
|
|
|
*/
|
2020-03-24 19:58:49 -07:00
|
|
|
class EmuWindow {
|
2013-09-04 18:00:29 -07:00
|
|
|
public:
|
2014-11-13 09:12:27 -08:00
|
|
|
/// Data structure to store emuwindow configuration
|
2014-09-12 17:06:13 -07:00
|
|
|
struct WindowConfig {
|
2018-08-14 16:36:13 -07:00
|
|
|
bool fullscreen = false;
|
|
|
|
int res_width = 0;
|
|
|
|
int res_height = 0;
|
2021-04-23 08:17:33 -07:00
|
|
|
std::pair<u32, u32> min_client_area_size;
|
2013-09-04 18:00:29 -07:00
|
|
|
};
|
|
|
|
|
2020-04-01 22:32:58 -07:00
|
|
|
/// Data describing host window system information
|
|
|
|
struct WindowSystemInfo {
|
|
|
|
// Window system type. Determines which GL context or Vulkan WSI is used.
|
|
|
|
WindowSystemType type = WindowSystemType::Headless;
|
|
|
|
|
|
|
|
// Connection to a display server. This is used on X11 and Wayland platforms.
|
|
|
|
void* display_connection = nullptr;
|
|
|
|
|
|
|
|
// Render surface. This is a pointer to the native window handle, which depends
|
|
|
|
// on the platform. e.g. HWND for Windows, Window for X11. If the surface is
|
|
|
|
// set to nullptr, the video backend will run in headless mode.
|
|
|
|
void* render_surface = nullptr;
|
|
|
|
|
|
|
|
// Scale of the render surface. For hidpi systems, this will be >1.
|
|
|
|
float render_surface_scale = 1.0f;
|
|
|
|
};
|
|
|
|
|
Overhaul EmuWindow::PollEvents to fix yuzu-cmd calling SDL_PollEvents off main thread
EmuWindow::PollEvents was called from the GPU thread (or the CPU thread
in sync-GPU mode) when swapping buffers. It had three implementations:
- In GRenderWindow, it didn't actually poll events, just set a flag and
emit a signal to indicate that a frame was displayed.
- In EmuWindow_SDL2_Hide, it did nothing.
- In EmuWindow_SDL2, it did call SDL_PollEvents, but this is wrong
because SDL_PollEvents is supposed to be called on the thread that set
up video - in this case, the main thread, which was sleeping in a
busyloop (regardless of whether sync-GPU was enabled). On macOS this
causes a crash.
To fix this:
- Rename EmuWindow::PollEvents to OnFrameDisplayed, and give it a
default implementation that does nothing.
- In EmuWindow_SDL2, do not override OnFrameDisplayed, but instead have
the main thread call SDL_WaitEvent in a loop.
2020-11-22 13:05:18 -08:00
|
|
|
/// Called from GPU thread when a frame is displayed.
|
|
|
|
virtual void OnFrameDisplayed() {}
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2019-01-11 20:06:34 -08:00
|
|
|
/**
|
2020-03-24 19:58:49 -07:00
|
|
|
* Returns a GraphicsContext that the frontend provides to be used for rendering.
|
2019-01-11 20:06:34 -08:00
|
|
|
*/
|
2020-03-24 19:58:49 -07:00
|
|
|
virtual std::unique_ptr<GraphicsContext> CreateSharedContext() const = 0;
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2020-01-21 11:40:53 -08:00
|
|
|
/// Returns if window is shown (not minimized)
|
|
|
|
virtual bool IsShown() const = 0;
|
|
|
|
|
2015-03-07 23:13:26 -08:00
|
|
|
/**
|
|
|
|
* Signal that a touch pressed event has occurred (e.g. mouse click pressed)
|
|
|
|
* @param framebuffer_x Framebuffer x-coordinate that was pressed
|
|
|
|
* @param framebuffer_y Framebuffer y-coordinate that was pressed
|
2021-01-10 06:36:31 -08:00
|
|
|
* @param id Touch event ID
|
2015-03-07 23:13:26 -08:00
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
void TouchPressed(u32 framebuffer_x, u32 framebuffer_y, size_t id);
|
2015-03-07 23:13:26 -08:00
|
|
|
|
2021-01-10 06:36:31 -08:00
|
|
|
/**
|
|
|
|
* Signal that a touch released event has occurred (e.g. mouse click released)
|
|
|
|
* @param id Touch event ID
|
2021-01-02 20:04:50 -08:00
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
void TouchReleased(size_t id);
|
2015-03-07 23:13:26 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Signal that a touch movement event has occurred (e.g. mouse was moved over the emu window)
|
|
|
|
* @param framebuffer_x Framebuffer x-coordinate
|
|
|
|
* @param framebuffer_y Framebuffer y-coordinate
|
2021-01-10 06:36:31 -08:00
|
|
|
* @param id Touch event ID
|
2015-03-07 23:13:26 -08:00
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
void TouchMoved(u32 framebuffer_x, u32 framebuffer_y, size_t id);
|
2015-03-08 21:14:59 -07:00
|
|
|
|
2014-11-13 09:12:27 -08:00
|
|
|
/**
|
|
|
|
* Returns currently active configuration.
|
2016-09-17 17:38:01 -07:00
|
|
|
* @note Accesses to the returned object need not be consistent because it may be modified in
|
|
|
|
* another thread
|
2014-11-13 09:12:27 -08:00
|
|
|
*/
|
2014-10-12 13:46:33 -07:00
|
|
|
const WindowConfig& GetActiveConfig() const {
|
|
|
|
return active_config;
|
2014-04-08 20:18:23 -07:00
|
|
|
}
|
|
|
|
|
2014-11-13 09:12:27 -08:00
|
|
|
/**
|
2016-09-17 17:38:01 -07:00
|
|
|
* Requests the internal configuration to be replaced by the specified argument at some point in
|
|
|
|
* the future.
|
|
|
|
* @note This method is thread-safe, because it delays configuration changes to the GUI event
|
|
|
|
* loop. Hence there is no guarantee on when the requested configuration will be active.
|
2014-11-13 09:12:27 -08:00
|
|
|
*/
|
2014-09-12 17:06:13 -07:00
|
|
|
void SetConfig(const WindowConfig& val) {
|
2014-10-12 09:14:57 -07:00
|
|
|
config = val;
|
2014-04-08 20:18:23 -07:00
|
|
|
}
|
2014-08-29 22:23:12 -07:00
|
|
|
|
2020-04-01 22:32:58 -07:00
|
|
|
/**
|
|
|
|
* Returns system information about the drawing area.
|
|
|
|
*/
|
|
|
|
const WindowSystemInfo& GetWindowInfo() const {
|
|
|
|
return window_info;
|
|
|
|
}
|
|
|
|
|
2014-10-12 09:14:57 -07:00
|
|
|
/**
|
2018-01-09 19:36:07 -08:00
|
|
|
* Gets the framebuffer layout (width, height, and screen regions)
|
|
|
|
* @note This method is thread-safe
|
|
|
|
*/
|
2016-05-02 23:07:17 -07:00
|
|
|
const Layout::FramebufferLayout& GetFramebufferLayout() const {
|
2015-03-07 14:21:19 -08:00
|
|
|
return framebuffer_layout;
|
2014-04-08 20:18:23 -07:00
|
|
|
}
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2016-05-02 23:07:17 -07:00
|
|
|
/**
|
2016-11-05 01:58:11 -07:00
|
|
|
* Convenience method to update the current frame layout
|
2016-05-02 23:07:17 -07:00
|
|
|
* Read from the current settings to determine which layout to use.
|
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
void UpdateCurrentFramebufferLayout(u32 width, u32 height);
|
2016-05-02 23:07:17 -07:00
|
|
|
|
2013-09-04 18:00:29 -07:00
|
|
|
protected:
|
2020-04-01 22:32:58 -07:00
|
|
|
explicit EmuWindow();
|
2017-08-08 16:57:42 -07:00
|
|
|
virtual ~EmuWindow();
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2014-11-13 09:12:27 -08:00
|
|
|
/**
|
|
|
|
* Processes any pending configuration changes from the last SetConfig call.
|
2014-11-13 09:24:15 -08:00
|
|
|
* This method invokes OnMinimalClientAreaChangeRequest if the corresponding configuration
|
|
|
|
* field changed.
|
2014-11-13 09:12:27 -08:00
|
|
|
* @note Implementations will usually want to call this from the GUI thread.
|
2014-11-13 11:31:34 -08:00
|
|
|
* @todo Actually call this in existing implementations.
|
2014-11-13 09:12:27 -08:00
|
|
|
*/
|
|
|
|
void ProcessConfigurationChanges() {
|
|
|
|
// TODO: For proper thread safety, we should eventually implement a proper
|
|
|
|
// multiple-writer/single-reader queue...
|
|
|
|
|
|
|
|
if (config.min_client_area_size != active_config.min_client_area_size) {
|
|
|
|
OnMinimalClientAreaChangeRequest(config.min_client_area_size);
|
|
|
|
config.min_client_area_size = active_config.min_client_area_size;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-03-07 14:21:19 -08:00
|
|
|
* Update framebuffer layout with the given parameter.
|
2014-11-13 09:12:27 -08:00
|
|
|
* @note EmuWindow implementations will usually use this in window resize event handlers.
|
|
|
|
*/
|
2016-05-02 23:07:17 -07:00
|
|
|
void NotifyFramebufferLayoutChanged(const Layout::FramebufferLayout& layout) {
|
2015-03-07 14:21:19 -08:00
|
|
|
framebuffer_layout = layout;
|
2014-10-12 09:14:57 -07:00
|
|
|
}
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2014-11-13 09:12:27 -08:00
|
|
|
/**
|
|
|
|
* Update internal client area size with the given parameter.
|
|
|
|
* @note EmuWindow implementations will usually use this in window resize event handlers.
|
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
void NotifyClientAreaSizeChanged(std::pair<u32, u32> size) {
|
2014-10-12 09:14:57 -07:00
|
|
|
client_area_width = size.first;
|
|
|
|
client_area_height = size.second;
|
|
|
|
}
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2020-04-01 22:32:58 -07:00
|
|
|
WindowSystemInfo window_info;
|
|
|
|
|
2013-09-04 18:00:29 -07:00
|
|
|
private:
|
2014-11-13 09:24:15 -08:00
|
|
|
/**
|
|
|
|
* Handler called when the minimal client area was requested to be changed via SetConfig.
|
2016-09-17 17:38:01 -07:00
|
|
|
* For the request to be honored, EmuWindow implementations will usually reimplement this
|
|
|
|
* function.
|
2014-11-13 09:24:15 -08:00
|
|
|
*/
|
2021-04-23 08:17:33 -07:00
|
|
|
virtual void OnMinimalClientAreaChangeRequest(std::pair<u32, u32>) {
|
2014-11-13 09:24:15 -08:00
|
|
|
// By default, ignore this request and do nothing.
|
2014-10-12 13:46:33 -07:00
|
|
|
}
|
|
|
|
|
2021-04-23 08:17:33 -07:00
|
|
|
/**
|
|
|
|
* Clip the provided coordinates to be inside the touchscreen area.
|
|
|
|
*/
|
2021-04-23 08:21:00 -07:00
|
|
|
std::pair<u32, u32> ClipToTouchScreen(u32 new_x, u32 new_y) const;
|
2021-04-23 08:17:33 -07:00
|
|
|
|
2016-05-02 23:07:17 -07:00
|
|
|
Layout::FramebufferLayout framebuffer_layout; ///< Current framebuffer layout
|
2014-10-12 09:14:57 -07:00
|
|
|
|
2021-04-23 08:17:33 -07:00
|
|
|
u32 client_area_width; ///< Current client width, should be set by window impl.
|
|
|
|
u32 client_area_height; ///< Current client height, should be set by window impl.
|
2013-09-04 18:00:29 -07:00
|
|
|
|
2016-09-17 17:38:01 -07:00
|
|
|
WindowConfig config; ///< Internal configuration (changes pending for being applied in
|
|
|
|
/// ProcessConfigurationChanges)
|
|
|
|
WindowConfig active_config; ///< Internal active configuration
|
2015-03-07 23:13:26 -08:00
|
|
|
|
2017-08-08 16:57:42 -07:00
|
|
|
class TouchState;
|
|
|
|
std::shared_ptr<TouchState> touch_state;
|
2013-09-04 18:00:29 -07:00
|
|
|
};
|
2018-08-11 17:20:19 -07:00
|
|
|
|
|
|
|
} // namespace Core::Frontend
|