Screenshot procedure changed/broken in 4.3?

davek · March 19, 2024, 10:30pm

Godot Version

4.3dev5

Question

Anyone able to take screenshots in 4.3? If so, did something change?

For example, this code works in 4.2, but not 4.3:

naturally-intelligent/chore-4/blob/f7151c23161baa181e2dfbcf0a3ccff30e4b3cf1/engine/util.gd#L504


      
          	return t
          
          # https://github.com/godotengine/godot/issues/14562
          func create_import_files_for_export(texture_dir):
          	var file_list = list_files_in_directory(texture_dir)
          	for file in file_list:
          		if file.ends_with(".import"):
          			var file_name = file.replace(".import", "")
          			return load(texture_dir + file_name)
          
          # SCREENSHOT (F5)
          func screenshot(scene: Node, scale:=Vector2.ZERO, logo:='', savedir:="screenshots"):
          	debug.print('Screenshot...')
          	# setup
          	var viewport: Viewport = scene.get_viewport()
          	var tree: SceneTree = scene.get_tree()
          	
          	# clear next frame
          	RenderingServer.viewport_set_clear_mode(viewport, RenderingServer.VIEWPORT_CLEAR_ONLY_NEXT_FRAME)
          
          	# hide cursor?

The code is not really anything different than what other people are doing, but thought I would include it.

I just get blank PNGs now

Calinou · June 7, 2024, 4:51pm

When the editor takes a screenshot, this is all it does:

github.com

godotengine/godot/blob/e96ad5af98547df71b50c4c4695ac348638113e0/editor/editor_node.cpp#L3189-L3200


      
          void EditorNode::_save_screenshot(NodePath p_path) {
          	Control *editor_main_screen = EditorInterface::get_singleton()->get_editor_main_screen();
          	ERR_FAIL_NULL_MSG(editor_main_screen, "Cannot get the editor main screen control.");
          	Viewport *viewport = editor_main_screen->get_viewport();
          	ERR_FAIL_NULL_MSG(viewport, "Cannot get a viewport from the editor main screen.");
          	Ref<ViewportTexture> texture = viewport->get_texture();
          	ERR_FAIL_COND_MSG(texture.is_null(), "Cannot get a viewport texture from the editor main screen.");
          	Ref<Image> img = texture->get_image();
          	ERR_FAIL_COND_MSG(img.is_null(), "Cannot get an image from a viewport texture of the editor main screen.");
          	Error error = img->save_png(p_path);
          	ERR_FAIL_COND_MSG(error != OK, "Cannot save screenshot to file '" + p_path + "'.");
          }

You don’t need to vertically flip the image before saving the image in Godot 4, as viewports are no longer vertically flipped by default.

For me, using this script in godot-demo-projects/viewport/screen_capture at master · godotengine/godot-demo-projects · GitHub works in 4.3.beta1 (replace the demo’s script with the contents below):

extends Node

@onready var captured_image: TextureRect = $CapturedImage
@onready var capture_button: Button = $CaptureButton


func _ready() -> void:
	# Focus button for keyboard/gamepad-friendly navigation.
	capture_button.grab_focus()


func _on_capture_button_pressed() -> void:
	# Retrieve the captured image.
	var img := get_viewport().get_texture().get_image()

	# Create a texture for it.
	var tex := ImageTexture.create_from_image(img)
	
	img.save_png("user://screenshot.png")
	OS.shell_open(ProjectSettings.globalize_path("user://screenshot.png"))

	# Set the texture to the captured image node.
	captured_image.set_texture(tex)

	# Colorize the button with a random color, so you can see which button belongs to which capture.
	capture_button.modulate = Color.from_hsv(randf(), randf_range(0.2, 0.8), 1.0)

davek · June 12, 2024, 3:40pm

Thanks for taking a look at this thread Calinou

The demo project does work for me in 4.3 and so does the Chore 4 demo project’s screenshot in 4.3 and 4.2 (the code I posted).

However inside my game the same code no longer works (my games use Chore as a framework). I can run the game in 4.2 and have screenshots, but running the game in any 4.3 gives blank PNGs, sometimes if I fiddle enough I will get a black PNG instead. Maybe it has to do with my game being more complex than these demo projects, or a change in how viewports are found, or something else, but something changed with 4.3 and I can’t figure out what.