Toggle fullscreen mode when pressing Alt + Enter by default #39708

Calinou · 2020-06-20T13:31:11Z

Note: Technically cherry-pickable to 3.x, but existing projects may already have implemented a fullscreen toggle on their own. I think it's better not to cherry-pick this PR to avoid trouble.

Alt + Enter is a widely followed convention to toggle fullscreen. This adds support for it both in the editor and projects, as long as the window is configured to be resizable.

The rationale for providing this feature in all projects is that many developers don't bother about adding a fullscreen toggle, especially for smaller/gamejam games. Yet, this convention is followed by many popular games out there, including AAA games.

The shortcut can be modified or disabled by editing the Input Map in the Project Settings.

This closes godotengine/godot-proposals#1983. See discussion in godotengine/godot-proposals#1087.

aaronfranke · 2020-06-21T03:35:57Z

In my experience, F11 is a more common keyboard shortcut for this (ex: web browsers, Minecraft). If this feature is added, F11 should also be a keybind to do this.

dalexeev · 2020-06-21T05:02:09Z

scene/main/viewport.cpp

@@ -2295,6 +2279,20 @@ void Viewport::_gui_input_event(Ref<InputEvent> p_event) {
 	}

 	if (mm.is_null() && mb.is_null() && p_event->is_action_type()) {
+		const bool resize_allowed = !DisplayServer::get_singleton()->window_get_flag(DisplayServer::WINDOW_FLAG_RESIZE_DISABLED);
+
+		if (p_event->is_pressed() && p_event->is_action_pressed("toggle_fullscreen") && resize_allowed) {


Perhaps the check && resize_allowed is superfluous? Some people turn off window resizing but allow fullscreen mode.
And if someone doesn’t need either, then they can simply delete all events from the toogle_fullscreen action.

Some people turn off window resizing but allow fullscreen mode.

That doesn't really make sense to me. If your window is set to be non-resizable, it's usually because your game isn't designed for multiple resolutions. Otherwise, there's no reason not to allow it 🙂

If your window is set to be non-resizable, it's usually because your game isn't designed for multiple resolutions.

Absolutely true, but the game can still work in fullscreen. The resolution does not change, the picture simply stretches (viewport mode). This is usually for pixel games.

[display] window/size/width=320 window/size/height=180 window/size/resizable=false window/size/test_width=640 window/size/test_height=360 window/stretch/mode="viewport" window/stretch/aspect="keep"

core/input/input_map.cpp

Calinou · 2020-06-21T11:51:39Z

@aaronfranke It makes sense to bind F11 as well, but it's more likely to conflict with a key already used in the project. That said, since it can easily be removed, it should be safe to do.

KoBeWi · 2020-06-24T23:00:20Z

@aaronfranke F11 is more common in applications (browsers, text editors etc.). Most games use Alt + Enter.

akien-mga · 2020-11-16T12:54:52Z

Needs rebase.

aaronfranke

When testing this, it seems that there is a naming mismatch between toggle_fullscreen and ui_toggle_fullscreen. In the project settings input map, it says toggle_fullscreen, but then when pressing the key, this error appears:

E 0:00:04:0057   event_get_action_status: Request for nonexistent InputMap action 'ui_toggle_fullscreen'.
  <C++ Error>    Condition "!E" is true. Returning: false
  <C++ Source>   core/input/input_map.cpp:194 @ event_get_action_status()

Also, it would be nice to get F11 bound:

aaronfranke · 2020-11-20T23:28:08Z

core/input/input_map.cpp

+	key.instance();
+	key->set_keycode(KEY_ENTER);
+	key->set_alt(true);
+	action_add_event("ui_toggle_fullscreen", key);


Suggested change

action_add_event("ui_toggle_fullscreen", key);

action_add_event("ui_toggle_fullscreen", key);

key.instance();

key->set_keycode(KEY_F11);

action_add_event("ui_toggle_fullscreen", key);

aaronfranke · 2020-11-20T23:34:24Z

core/config/project_settings.cpp

+	key.instance();
+	key->set_keycode(KEY_ENTER);
+	key->set_alt(true);
+	events.push_back(key);


Suggested change

events.push_back(key);

events.push_back(key);

key.instance();

key->set_keycode(KEY_F11);

events.push_back(key);

You can use the new InputEventKey::create_instance( KEY_MASK_ALT | KEY_ENTER) here to keep it succinct.

Calinou · 2020-11-21T00:10:52Z

@aaronfranke The issue with adding F11 as a shortcut is that it conflicts with the editor's distraction-free toggle, which defaults to Ctrl + Shift + F11. It no longer works if I add F11 as a key for ui_toggle_fullscreen.

Anyway, I fixed the issue with the ui_ prefix not being present for the default automatically-created input map.

aaronfranke · 2020-11-21T01:05:15Z

For F11: Understandable, if there's a reason to not have it then that's fine.

Tested this again. When exiting fullscreen on Linux, the window's title bar is gone.

This might be unrelated to this PR though, since this is just binding a key.

dalexeev · 2020-11-21T08:29:17Z

scene/main/viewport.cpp

+		const bool resize_allowed = !DisplayServer::get_singleton()->window_get_flag(DisplayServer::WINDOW_FLAG_RESIZE_DISABLED);
+
+		if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {


Suggested change

const bool resize_allowed = !DisplayServer::get_singleton()->window_get_flag(DisplayServer::WINDOW_FLAG_RESIZE_DISABLED);

if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {

if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen")) {

See previous discussion. Let's not create artificial restrictions. If a person has window_resizable == false and they don't need fullscreen, then they can simply remove all events from the ui_toggle_fullscreen action.

If the window is not resizable, then we should not allow toggling fullscreen to not break expectations (since making it fullscreen is almost guaranteed to resize it in one way or another).

If you really want to make a non-resizable window fullscreen, you can use a window manager that allows ignoring geometry restrictions like KWin. Either way, this is very much an edge case.

I agree with @Calinou here, if resizing a window isn't allowed, it shouldn't be resized, whatever keys you press.

Calinou · 2020-11-21T13:42:12Z

Tested this again. When exiting fullscreen on Linux, the window's title bar is gone.

I can reproduce this on Linux too. It's most likely a regression from DisplayServer.

iwanPlays · 2020-12-14T13:01:57Z

Absolutely do not use F11 for full screen toggle of games.

Definitely do use ALT+Enter for full screen toggle of games.

Or use both for the sake of people who learned gaming with minecraft or Roblox (Shift+F11) but ALT+Enter should be the priority for the sake of any other gamer.

If I'm not mistaken, there is conversation about having the same key combo for Godot editor and games made in Godot? If that is correct: Both F11 and ALT+Enter do nothing in Unity editor, neither should be expected to do anything. Full-screening a game and a game editor are entirely different things - like full-screening a video to watch, vs full-screening a video editor application.

If there is some need to fullscreen toggle godot editor, I'd suggest to use F11 (based on most applications that have fullscreen mode).

Calinou · 2020-12-14T13:12:05Z

@iwanPlays The Godot editor already provides Shift + F11 to toggle fullscreen. We could perhaps change this to just F11 in a future pull request.

dalexeev · 2020-12-14T13:22:30Z

Absolutely do not use F11 for full screen toggle of games.

@iwanPlays I think both should be enabled by default. Personally, I learned about the Alt + Enter combination much later than about the F11 key.

aaronfranke · 2021-08-16T19:09:05Z

@Calinou Now that we have exact matching for input events (#44355), can we add F11 as a shortcut?

groud · 2021-09-01T07:31:33Z

I think the feature and the implementation look good, but the PR needs a rebase.

KoBeWi · 2021-12-22T12:09:45Z

scene/main/viewport.cpp

@@ -2355,6 +2341,20 @@ void Viewport::_gui_input_event(Ref<InputEvent> p_event) {
 	}

 	if (mm.is_null() && mb.is_null() && p_event->is_action_type()) {
+		const bool resize_allowed = !DisplayServer::get_singleton()->window_get_flag(DisplayServer::WINDOW_FLAG_RESIZE_DISABLED);
+
+		if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {


Suggested change

if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {

if (resize_allowed && p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen")) {

This way we can skip parsing input if resize is disabled.

KoBeWi

Needs rebase.

reduz · 2022-07-28T14:05:52Z

Not necessarily against this, but you should check that the window is resizable/borderless before making this happen.
Also I do not think the implementation is good. The aciton is OK, but you should check/do/this at Window level and make this a Window property (disabled by default, and the one in root set by SceneTree by checking a project setting, which I guess its ok if its on by default).

Calinou · 2023-05-12T01:48:16Z

Rebased against master and reimplemented, but not functional yet.

The aciton is OK, but you should check/do/this at Window level and make this a Window property (disabled by default, and the one in root set by SceneTree by checking a project setting, which I guess its ok if its on by default).

I've looked into adding a flag to Window (also tried adding a property), but I don't know how I can avoid having to add code to the set_flag() override in each DisplayServer implementation. The shortcut does not need OS-specific handling after all.

Alt + Enter is a widely followed convention to toggle fullscreen. This adds support for it both in the editor and projects, as long as the window is configured to be resizable. The rationale for providing this feature in all projects is that many developers don't bother about adding a fullscreen toggle, especially for smaller/gamejam games. Yet, this convention is followed by many popular games out there, including AAA games. The shortcut can be modified or disabled by editing the Input Map in the Project Settings.

m4gr3d · 2023-05-12T01:55:53Z

I'm guessing this is a no-op on Android?

Calinou · 2023-05-12T02:22:05Z

I'm guessing this is a no-op on Android?

It could work if you have a hardware keyboard connected and floating windows are used, but otherwise I generally expect it to be a no-op on mobile platforms.

Calinou added enhancement topic:core topic:editor usability labels Jun 20, 2020

Calinou added this to the 4.0 milestone Jun 20, 2020

dalexeev reviewed Jun 21, 2020

View reviewed changes

core/input/input_map.cpp Outdated Show resolved Hide resolved

dalexeev mentioned this pull request Jun 21, 2020

Add 'hide when idle' mouse mode godotengine/godot-proposals#1099

Open

Calinou force-pushed the add-builtin-fullscreen-toggle branch 2 times, most recently from d7896f8 to a4cf4eb Compare November 20, 2020 23:22

aaronfranke requested changes Nov 20, 2020

View reviewed changes

Calinou force-pushed the add-builtin-fullscreen-toggle branch from a4cf4eb to 592a5e7 Compare November 21, 2020 00:11

dalexeev reviewed Nov 21, 2020

View reviewed changes

Calinou mentioned this pull request Dec 14, 2020

By default, bind Alt + Enter to switch between fullscreen and windowed mode godotengine/godot-proposals#1983

Open

YuriSizov requested a review from a team August 24, 2021 23:20

KoBeWi reviewed Dec 22, 2021

View reviewed changes

KoBeWi approved these changes Dec 22, 2021

View reviewed changes

YuriSizov modified the milestones: 4.0, 4.x Feb 10, 2023

YuriSizov added the needs work label Feb 10, 2023

Calinou force-pushed the add-builtin-fullscreen-toggle branch from 592a5e7 to 24e441c Compare May 12, 2023 01:48

Calinou requested review from a team as code owners May 12, 2023 01:48

Calinou marked this pull request as draft May 12, 2023 01:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Toggle fullscreen mode when pressing Alt + Enter by default #39708

Toggle fullscreen mode when pressing Alt + Enter by default #39708

Calinou commented Jun 20, 2020 •

edited

Loading

aaronfranke commented Jun 21, 2020

dalexeev Jun 21, 2020

Calinou Jun 23, 2020

dalexeev Jun 23, 2020 •

edited

Loading

Calinou commented Jun 21, 2020 •

edited

Loading

KoBeWi commented Jun 24, 2020

akien-mga commented Nov 16, 2020

aaronfranke left a comment

aaronfranke Nov 20, 2020

aaronfranke Nov 20, 2020

EricEzaM Sep 4, 2021

Calinou commented Nov 21, 2020 •

edited

Loading

aaronfranke commented Nov 21, 2020

dalexeev Nov 21, 2020

Calinou Nov 21, 2020 •

edited

Loading

groud Sep 1, 2021

Calinou commented Nov 21, 2020 •

edited

Loading

iwanPlays commented Dec 14, 2020 •

edited

Loading

Calinou commented Dec 14, 2020 •

edited

Loading

dalexeev commented Dec 14, 2020

aaronfranke commented Aug 16, 2021

groud commented Sep 1, 2021

KoBeWi Dec 22, 2021

KoBeWi left a comment

reduz commented Jul 28, 2022

Calinou commented May 12, 2023 •

edited

Loading

m4gr3d commented May 12, 2023

Calinou commented May 12, 2023 •

edited

Loading

		const bool resize_allowed = !DisplayServer::get_singleton()->window_get_flag(DisplayServer::WINDOW_FLAG_RESIZE_DISABLED);

		if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {

	if (p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen") && resize_allowed) {
	if (resize_allowed && p_event->is_pressed() && p_event->is_action_pressed("ui_toggle_fullscreen")) {

Toggle fullscreen mode when pressing Alt + Enter by default #39708

Are you sure you want to change the base?

Toggle fullscreen mode when pressing Alt + Enter by default #39708

Conversation

Calinou commented Jun 20, 2020 • edited Loading

aaronfranke commented Jun 21, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dalexeev Jun 23, 2020 • edited Loading

Choose a reason for hiding this comment

Calinou commented Jun 21, 2020 • edited Loading

KoBeWi commented Jun 24, 2020

akien-mga commented Nov 16, 2020

aaronfranke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Calinou commented Nov 21, 2020 • edited Loading

aaronfranke commented Nov 21, 2020

Choose a reason for hiding this comment

Calinou Nov 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Calinou commented Nov 21, 2020 • edited Loading

iwanPlays commented Dec 14, 2020 • edited Loading

Calinou commented Dec 14, 2020 • edited Loading

dalexeev commented Dec 14, 2020

aaronfranke commented Aug 16, 2021

groud commented Sep 1, 2021

Choose a reason for hiding this comment

KoBeWi left a comment

Choose a reason for hiding this comment

reduz commented Jul 28, 2022

Calinou commented May 12, 2023 • edited Loading

m4gr3d commented May 12, 2023

Calinou commented May 12, 2023 • edited Loading

Calinou commented Jun 20, 2020 •

edited

Loading

dalexeev Jun 23, 2020 •

edited

Loading

Calinou commented Jun 21, 2020 •

edited

Loading

Calinou commented Nov 21, 2020 •

edited

Loading

Calinou Nov 21, 2020 •

edited

Loading

Calinou commented Nov 21, 2020 •

edited

Loading

iwanPlays commented Dec 14, 2020 •

edited

Loading

Calinou commented Dec 14, 2020 •

edited

Loading

Calinou commented May 12, 2023 •

edited

Loading

Calinou commented May 12, 2023 •

edited

Loading