Function screenshot

framework/common/utils.cpp:45–185

}

void screenshot(vkb::rendering::RenderContextC &render_context, const std::string &filename)
{
	assert(render_context.get_format() == VK_FORMAT_R8G8B8A8_UNORM ||
	       render_context.get_format() == VK_FORMAT_B8G8R8A8_UNORM ||
	       render_context.get_format() == VK_FORMAT_R8G8B8A8_SRGB ||
	       render_context.get_format() == VK_FORMAT_B8G8R8A8_SRGB);

	// We want the last completed frame since we don't want to be reading from an incomplete framebuffer
	auto &frame = render_context.get_last_rendered_frame();
	assert(!frame.get_render_target().get_views().empty());
	auto &src_image_view = frame.get_render_target().get_views()[0];

	auto width    = render_context.get_surface_extent().width;
	auto height   = render_context.get_surface_extent().height;
	auto dst_size = width * height * 4;

	vkb::core::BufferC dst_buffer{render_context.get_device(),
	                              dst_size,
	                              VK_BUFFER_USAGE_TRANSFER_DST_BIT,
	                              VMA_MEMORY_USAGE_GPU_TO_CPU,
	                              VMA_ALLOCATION_CREATE_MAPPED_BIT};

	const auto &queue = render_context.get_device().get_queue_by_flags(VK_QUEUE_GRAPHICS_BIT, 0);

	auto cmd_buf = render_context.get_device().get_command_pool().request_command_buffer();

	cmd_buf->begin(VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT);

	// Enable destination buffer to be written to
	{
		BufferMemoryBarrier memory_barrier{};
		memory_barrier.src_access_mask = 0;
		memory_barrier.dst_access_mask = VK_ACCESS_TRANSFER_WRITE_BIT;
		memory_barrier.src_stage_mask  = VK_PIPELINE_STAGE_TRANSFER_BIT;
		memory_barrier.dst_stage_mask  = VK_PIPELINE_STAGE_TRANSFER_BIT;

		cmd_buf->buffer_memory_barrier(dst_buffer, 0, dst_size, memory_barrier);
	}

	// Enable framebuffer image view to be read from
	{
		ImageMemoryBarrier memory_barrier{};
		memory_barrier.old_layout     = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
		memory_barrier.new_layout     = VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL;
		memory_barrier.src_stage_mask = VK_PIPELINE_STAGE_TRANSFER_BIT;
		memory_barrier.dst_stage_mask = VK_PIPELINE_STAGE_TRANSFER_BIT;

		cmd_buf->image_memory_barrier(src_image_view, memory_barrier);
	}

	// Check if framebuffer images are in a BGR format
	auto bgr_formats = {VK_FORMAT_B8G8R8A8_SRGB, VK_FORMAT_B8G8R8A8_UNORM, VK_FORMAT_B8G8R8A8_SNORM};
	bool swizzle     = std::ranges::find(bgr_formats, src_image_view.get_format()) != bgr_formats.end();

	// Copy framebuffer image memory
	VkBufferImageCopy image_copy_region{};
	image_copy_region.bufferRowLength             = width;
	image_copy_region.bufferImageHeight           = height;