How to toggle fullscreen from code?

Question

I'm trying to implement a button in my menu which toggles fullscreen on and off.

Basically, I want clicks of the button to toggle the fullscreen property from Project Settings > Display > Window , but I can't figure out how to reference it.

I tried ProjectSettings.get_setting("size/fullscreen"), but it wasn't a correct reference.

I also notice that there's an OS.window_fullscreen, but I'm not sure if that's the same as the property listed in Project Settings.

I want to work with this property from Project Settings rather than get and set resolutions of the screen and viewport directly.

Any advice?

Answer 1

As of Godot 3.0, you can just set OS.window_fullscreen to true in any script to enable fullscreen – no need to deal with the project settings manually. It will behave the same way as the project setting does.

Tip: If you want to toggle fullscreen, you can avoid using an if condition by setting OS.window_fullscreen to its inverted value:

if event.is_action_pressed("toggle_fullscreen"):
    OS.window_fullscreen = !OS.window_fullscreen

Comments

Thanks. That inversion trick is very cool. Didn't know about it.

---

Thank You, this is a great answer!
I had to change it to the following, however:

if Input.is_action_just_pressed("toggle_fullscreen"):
    OS.window_fullscreen = !OS.window_fullscreen

The godot version I use is 3.0.2

All the best

---

In godot 3.2, you must use

OS.set_window_fullscreen(!OS.window_fullscreen)

as OS.window_fullscreen is read-only

cheers

---

OS.window_fullscreen = !OS.window_fullscreen works in v3.3.2.stable.official for me

---

Literally none of these solutions are working for me in version 3.4.3.stable, I have absolutely no idea what I could be doing wrong :/

This is just inside my Player script as I wasn't sure where else to put it. Other keybindings work fine in other functions within this script. I have the button set as the F key in Project settings just like the other keybindings.

func _ready(): 
    animationTree.active = true 
    swordHitbox.knockback_vector = Vector2.DOWN 
    stats.connect("current_health_zero", self, "queue_free")
    OS.window_fullscreen = true
    if Input.is_action_just_pressed("toggle_fullscreen"):
        OS.window_fullscreen = !OS.window_fullscreen

What in the world am I doing wrong?? I've tried it without the OS.window fullscreen = true line, I've tried it with the Fullscreen checkbox checked and unchecked in the project settings, I've tried using different keybindings, and I've tried all of the above solutions.

---

_ready() is only called once, when the node enters the scene tree and is therefore not suitable for checking input events.

Answer 2

In Godot 4.x things seem to have changed slightly again, these functions have moved to the DisplayServer singleton. This worked for me:

func swap_fullscreen_mode():
    if DisplayServer.window_get_mode() == DisplayServer.WINDOW_MODE_MAXIMIZED:
        DisplayServer.window_set_mode(DisplayServer.WINDOW_MODE_WINDOWED)
    else:
        DisplayServer.window_set_mode(DisplayServer.WINDOW_MODE_MAXIMIZED)

See:

• DisplayServer docs
• window_set_mode(...) docs
• WINDOW_MODE_... enum values docs

Comments

thank you for sharing this

---

@jeroenheijmans That isn't exactly a solution for true toggling though :/ I'm looking for a toggle loop that can store what the display mode was before toggling. This will allow players to set their display mode to whatever they want and if they hit the fullscreen button it will remember what to switch back to.

Update!!!
I've got it. This code (4.0.3 stable) will allow you to switch between exclusive fullscreen (value 4) and whatever was viewed previously to exclusive fullscreen. If the game started in exclusive fullscreen, there's a loop in there too for switching it to maximized (value 2):

#top of script
@onready var previous_window = DisplayServer.window_get_mode()
@onready var current_window = DisplayServer.window_get_mode()

#body of script
func _input(event):
    if Input.is_action_just_pressed("toggle_fullscreen"):
        current_window = DisplayServer.window_get_mode()
        if current_window != 4:
            previous_window = current_window
            DisplayServer.window_set_mode(4)
        else:
            if previous_window == 4:
                previous_window = 2
            DisplayServer.window_set_mode(previous_window)