renderer_compositor_rd.h

/**************************************************************************/
/*  renderer_compositor_rd.h                                              */
/**************************************************************************/
/*                         This file is part of:                          */
/*                             GODOT ENGINE                               */
/*                        https://godotengine.org                         */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
/*                                                                        */
/* Permission is hereby granted, free of charge, to any person obtaining  */
/* a copy of this software and associated documentation files (the        */
/* "Software"), to deal in the Software without restriction, including    */
/* without limitation the rights to use, copy, modify, merge, publish,    */
/* distribute, sublicense, and/or sell copies of the Software, and to     */
/* permit persons to whom the Software is furnished to do so, subject to  */
/* the following conditions:                                              */
/*                                                                        */
/* The above copyright notice and this permission notice shall be         */
/* included in all copies or substantial portions of the Software.        */
/*                                                                        */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
/**************************************************************************/

#pragma once

#include "core/io/image.h"
#include "servers/rendering/renderer_compositor.h"
#include "servers/rendering/renderer_rd/environment/fog.h"
#include "servers/rendering/renderer_rd/framebuffer_cache_rd.h"
#include "servers/rendering/renderer_rd/renderer_canvas_render_rd.h"
#include "servers/rendering/renderer_rd/renderer_scene_render_rd.h"
#include "servers/rendering/renderer_rd/shaders/blit.glsl.gen.h"
#include "servers/rendering/renderer_rd/storage_rd/light_storage.h"
#include "servers/rendering/renderer_rd/storage_rd/material_storage.h"
#include "servers/rendering/renderer_rd/storage_rd/mesh_storage.h"
#include "servers/rendering/renderer_rd/storage_rd/particles_storage.h"
#include "servers/rendering/renderer_rd/storage_rd/texture_storage.h"
#include "servers/rendering/renderer_rd/storage_rd/utilities.h"
#include "servers/rendering/renderer_rd/uniform_set_cache_rd.h"

class RendererCompositorRD : public RendererCompositor {
protected:
	UniformSetCacheRD *uniform_set_cache = nullptr;
	FramebufferCacheRD *framebuffer_cache = nullptr;
	RendererCanvasRenderRD *canvas = nullptr;
	RendererRD::Utilities *utilities = nullptr;
	RendererRD::LightStorage *light_storage = nullptr;
	RendererRD::MaterialStorage *material_storage = nullptr;
	RendererRD::MeshStorage *mesh_storage = nullptr;
	RendererRD::ParticlesStorage *particles_storage = nullptr;
	RendererRD::TextureStorage *texture_storage = nullptr;
	RendererRD::Fog *fog = nullptr;
	RendererSceneRenderRD *scene = nullptr;

	enum BlitMode {
		BLIT_MODE_NORMAL,
		BLIT_MODE_USE_LAYER,
		BLIT_MODE_LENS,
		BLIT_MODE_NORMAL_ALPHA,
		BLIT_MODE_MAX
	};

	struct BlitPushConstant {
		float src_rect[4]; // 16 - 16
		float dst_rect[4]; // 16 - 32

		float rotation_sin; // 4 - 36
		float rotation_cos; // 4 - 40
		float eye_center[2]; // 8 - 48

		float k1; // 4 - 52
		float k2; // 4 - 56
		float upscale; // 4 - 60
		float aspect_ratio; // 4 - 64

		uint32_t layer; // 4 - 68
		uint32_t source_is_srgb; // 4 - 72
		uint32_t use_debanding; // 4 - 76
		uint32_t target_color_space; // 4 - 80

		float reference_multiplier; // 4 - 84
		float output_max_value; // 4 - 88
		uint32_t pad[2]; // 8 - 96 (padding to reach 16-byte boundary)
	};

	struct BlitPipelines {
		RID pipelines[BLIT_MODE_MAX];
	};

	struct Blit {
		BlitPushConstant push_constant;
		BlitShaderRD shader;
		RID shader_version;
		HashMap<RenderingDevice::FramebufferFormatID, BlitPipelines> pipelines_by_format;
		RID index_buffer;
		RID array;
		RID sampler;
	} blit;

	HashMap<RID, RID> render_target_descriptors;

	double time = 0.0;
	double delta = 0.0;

	static uint64_t frame;
	static RendererCompositorRD *singleton;

	BlitPipelines _get_blit_pipelines_for_format(RenderingDevice::FramebufferFormatID format);
	float _compute_reference_multiplier(RD::ColorSpace p_color_space, const float p_reference_luminance, const float p_linear_luminance_scale);

public:
	virtual RendererUtilities *get_utilities() override { return utilities; }
	virtual RendererLightStorage *get_light_storage() override { return light_storage; }
	virtual RendererMaterialStorage *get_material_storage() override { return material_storage; }
	virtual RendererMeshStorage *get_mesh_storage() override { return mesh_storage; }
	virtual RendererParticlesStorage *get_particles_storage() override { return particles_storage; }
	virtual RendererTextureStorage *get_texture_storage() override { return texture_storage; }
	virtual RendererGI *get_gi() override {
		ERR_FAIL_NULL_V(scene, nullptr);
		return scene->get_gi();
	}
	virtual RendererFog *get_fog() override { return fog; }
	virtual RendererCanvasRender *get_canvas() override { return canvas; }
	virtual RendererSceneRender *get_scene() override { return scene; }

	virtual void set_boot_image_with_stretch(const Ref<Image> &p_image, const Color &p_color, RenderingServer::SplashStretchMode p_stretch_mode, bool p_use_filter) override;

	virtual void initialize() override;
	virtual void begin_frame(double frame_step) override;
	virtual void blit_render_targets_to_screen(DisplayServer::WindowID p_screen, const BlitToScreen *p_render_targets, int p_amount) override;

	virtual bool is_opengl() override { return false; }
	virtual void gl_end_frame(bool p_swap_buffers) override {}
	virtual void end_frame(bool p_present) override;
	virtual void finalize() override;

	_ALWAYS_INLINE_ virtual uint64_t get_frame_number() const override { return frame; }
	_ALWAYS_INLINE_ virtual double get_frame_delta_time() const override { return delta; }
	_ALWAYS_INLINE_ virtual double get_total_time() const override { return time; }
	_ALWAYS_INLINE_ virtual bool can_create_resources_async() const override { return true; }

	virtual bool is_xr_enabled() const override { return RendererCompositor::is_xr_enabled(); }

	static Error is_viable() {
		return OK;
	}

	static RendererCompositor *_create_current() {
		return memnew(RendererCompositorRD);
	}

	static void make_current() {
		_create_func = _create_current;
		low_end = false;
	}

	static RendererCompositorRD *get_singleton() { return singleton; }
	RendererCompositorRD();
	~RendererCompositorRD();
};