2023-01-05 13:25:55 +01:00
/**************************************************************************/
/* tone_mapper.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
2022-04-27 05:42:50 +02:00
# include "tone_mapper.h"
# include "servers/rendering/renderer_rd/renderer_compositor_rd.h"
# include "servers/rendering/renderer_rd/storage_rd/material_storage.h"
# include "servers/rendering/renderer_rd/uniform_set_cache_rd.h"
using namespace RendererRD ;
ToneMapper : : ToneMapper ( ) {
{
// Initialize tonemapper
Vector < String > tonemap_modes ;
tonemap_modes . push_back ( " \n " ) ;
tonemap_modes . push_back ( " \n #define USE_GLOW_FILTER_BICUBIC \n " ) ;
tonemap_modes . push_back ( " \n #define USE_1D_LUT \n " ) ;
tonemap_modes . push_back ( " \n #define USE_GLOW_FILTER_BICUBIC \n #define USE_1D_LUT \n " ) ;
tonemap_modes . push_back ( " \n #define SUBPASS \n " ) ;
tonemap_modes . push_back ( " \n #define SUBPASS \n #define USE_1D_LUT \n " ) ;
// multiview versions of our shaders
tonemap_modes . push_back ( " \n #define MULTIVIEW \n " ) ;
tonemap_modes . push_back ( " \n #define MULTIVIEW \n #define USE_GLOW_FILTER_BICUBIC \n " ) ;
tonemap_modes . push_back ( " \n #define MULTIVIEW \n #define USE_1D_LUT \n " ) ;
tonemap_modes . push_back ( " \n #define MULTIVIEW \n #define USE_GLOW_FILTER_BICUBIC \n #define USE_1D_LUT \n " ) ;
tonemap_modes . push_back ( " \n #define MULTIVIEW \n #define SUBPASS \n " ) ;
tonemap_modes . push_back ( " \n #define MULTIVIEW \n #define SUBPASS \n #define USE_1D_LUT \n " ) ;
tonemap . shader . initialize ( tonemap_modes ) ;
2023-01-29 10:14:22 +01:00
if ( ! RendererCompositorRD : : get_singleton ( ) - > is_xr_enabled ( ) ) {
2022-04-27 05:42:50 +02:00
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_NORMAL_MULTIVIEW , false ) ;
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_BICUBIC_GLOW_FILTER_MULTIVIEW , false ) ;
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_1D_LUT_MULTIVIEW , false ) ;
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_BICUBIC_GLOW_FILTER_1D_LUT_MULTIVIEW , false ) ;
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_SUBPASS_MULTIVIEW , false ) ;
tonemap . shader . set_variant_enabled ( TONEMAP_MODE_SUBPASS_1D_LUT_MULTIVIEW , false ) ;
}
tonemap . shader_version = tonemap . shader . version_create ( ) ;
for ( int i = 0 ; i < TONEMAP_MODE_MAX ; i + + ) {
if ( tonemap . shader . is_variant_enabled ( i ) ) {
tonemap . pipelines [ i ] . setup ( tonemap . shader . version_get_shader ( tonemap . shader_version , i ) , RD : : RENDER_PRIMITIVE_TRIANGLES , RD : : PipelineRasterizationState ( ) , RD : : PipelineMultisampleState ( ) , RD : : PipelineDepthStencilState ( ) , RD : : PipelineColorBlendState : : create_disabled ( ) , 0 ) ;
} else {
tonemap . pipelines [ i ] . clear ( ) ;
}
}
}
}
ToneMapper : : ~ ToneMapper ( ) {
tonemap . shader . version_free ( tonemap . shader_version ) ;
}
void ToneMapper : : tonemapper ( RID p_source_color , RID p_dst_framebuffer , const TonemapSettings & p_settings ) {
UniformSetCacheRD * uniform_set_cache = UniformSetCacheRD : : get_singleton ( ) ;
ERR_FAIL_NULL ( uniform_set_cache ) ;
MaterialStorage * material_storage = MaterialStorage : : get_singleton ( ) ;
ERR_FAIL_NULL ( material_storage ) ;
memset ( & tonemap . push_constant , 0 , sizeof ( TonemapPushConstant ) ) ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_bcs ? TONEMAP_FLAG_USE_BCS : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . bcs [ 0 ] = p_settings . brightness ;
tonemap . push_constant . bcs [ 1 ] = p_settings . contrast ;
tonemap . push_constant . bcs [ 2 ] = p_settings . saturation ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_glow ? TONEMAP_FLAG_USE_GLOW : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . glow_intensity = p_settings . glow_intensity ;
tonemap . push_constant . glow_map_strength = p_settings . glow_map_strength ;
tonemap . push_constant . glow_levels [ 0 ] = p_settings . glow_levels [ 0 ] ; // clean this up to just pass by pointer or something
tonemap . push_constant . glow_levels [ 1 ] = p_settings . glow_levels [ 1 ] ;
tonemap . push_constant . glow_levels [ 2 ] = p_settings . glow_levels [ 2 ] ;
tonemap . push_constant . glow_levels [ 3 ] = p_settings . glow_levels [ 3 ] ;
tonemap . push_constant . glow_levels [ 4 ] = p_settings . glow_levels [ 4 ] ;
tonemap . push_constant . glow_levels [ 5 ] = p_settings . glow_levels [ 5 ] ;
tonemap . push_constant . glow_levels [ 6 ] = p_settings . glow_levels [ 6 ] ;
tonemap . push_constant . glow_texture_size [ 0 ] = p_settings . glow_texture_size . x ;
tonemap . push_constant . glow_texture_size [ 1 ] = p_settings . glow_texture_size . y ;
tonemap . push_constant . glow_mode = p_settings . glow_mode ;
int mode = p_settings . glow_use_bicubic_upscale ? TONEMAP_MODE_BICUBIC_GLOW_FILTER : TONEMAP_MODE_NORMAL ;
if ( p_settings . use_1d_color_correction ) {
mode + = 2 ;
}
tonemap . push_constant . tonemapper = p_settings . tonemap_mode ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_auto_exposure ? TONEMAP_FLAG_USE_AUTO_EXPOSURE : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . exposure = p_settings . exposure ;
tonemap . push_constant . white = p_settings . white ;
2022-08-01 01:20:24 +02:00
tonemap . push_constant . auto_exposure_scale = p_settings . auto_exposure_scale ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . luminance_multiplier = p_settings . luminance_multiplier ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_color_correction ? TONEMAP_FLAG_USE_COLOR_CORRECTION : 0 ;
2022-04-27 05:42:50 +02:00
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_fxaa ? TONEMAP_FLAG_USE_FXAA : 0 ;
tonemap . push_constant . flags | = p_settings . use_debanding ? TONEMAP_FLAG_USE_DEBANDING : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . pixel_size [ 0 ] = 1.0 / p_settings . texture_size . x ;
tonemap . push_constant . pixel_size [ 1 ] = 1.0 / p_settings . texture_size . y ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . convert_to_srgb ? TONEMAP_FLAG_CONVERT_TO_SRGB : 0 ;
2022-04-27 05:42:50 +02:00
if ( p_settings . view_count > 1 ) {
// Use MULTIVIEW versions
mode + = 6 ;
}
2022-05-01 06:30:08 +02:00
RID default_sampler = material_storage - > sampler_rd_get_default ( RS : : CANVAS_ITEM_TEXTURE_FILTER_LINEAR , RS : : CANVAS_ITEM_TEXTURE_REPEAT_DISABLED ) ;
RID default_mipmap_sampler = material_storage - > sampler_rd_get_default ( RS : : CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS , RS : : CANVAS_ITEM_TEXTURE_REPEAT_DISABLED ) ;
2022-04-27 05:42:50 +02:00
2022-04-29 09:10:54 +02:00
RD : : Uniform u_source_color ( RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE , 0 , Vector < RID > ( { default_sampler , p_source_color } ) ) ;
2022-04-27 05:42:50 +02:00
RD : : Uniform u_exposure_texture ;
u_exposure_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_exposure_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_exposure_texture . append_id ( default_sampler ) ;
2022-04-27 05:42:50 +02:00
u_exposure_texture . append_id ( p_settings . exposure_texture ) ;
RD : : Uniform u_glow_texture ;
u_glow_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_glow_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_glow_texture . append_id ( default_mipmap_sampler ) ;
2022-04-27 05:42:50 +02:00
u_glow_texture . append_id ( p_settings . glow_texture ) ;
RD : : Uniform u_glow_map ;
u_glow_map . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_glow_map . binding = 1 ;
2022-05-01 06:30:08 +02:00
u_glow_map . append_id ( default_mipmap_sampler ) ;
2022-04-27 05:42:50 +02:00
u_glow_map . append_id ( p_settings . glow_map ) ;
RD : : Uniform u_color_correction_texture ;
u_color_correction_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_color_correction_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_color_correction_texture . append_id ( default_sampler ) ;
2022-04-27 05:42:50 +02:00
u_color_correction_texture . append_id ( p_settings . color_correction_texture ) ;
RID shader = tonemap . shader . version_get_shader ( tonemap . shader_version , mode ) ;
ERR_FAIL_COND ( shader . is_null ( ) ) ;
RD : : DrawListID draw_list = RD : : get_singleton ( ) - > draw_list_begin ( p_dst_framebuffer , RD : : INITIAL_ACTION_DROP , RD : : FINAL_ACTION_READ , RD : : INITIAL_ACTION_DROP , RD : : FINAL_ACTION_DISCARD ) ;
RD : : get_singleton ( ) - > draw_list_bind_render_pipeline ( draw_list , tonemap . pipelines [ mode ] . get_render_pipeline ( RD : : INVALID_ID , RD : : get_singleton ( ) - > framebuffer_get_format ( p_dst_framebuffer ) , false , RD : : get_singleton ( ) - > draw_list_get_current_pass ( ) ) ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( draw_list , uniform_set_cache - > get_cache ( shader , 0 , u_source_color ) , 0 ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( draw_list , uniform_set_cache - > get_cache ( shader , 1 , u_exposure_texture ) , 1 ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( draw_list , uniform_set_cache - > get_cache ( shader , 2 , u_glow_texture , u_glow_map ) , 2 ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( draw_list , uniform_set_cache - > get_cache ( shader , 3 , u_color_correction_texture ) , 3 ) ;
RD : : get_singleton ( ) - > draw_list_set_push_constant ( draw_list , & tonemap . push_constant , sizeof ( TonemapPushConstant ) ) ;
2023-08-05 21:30:47 +02:00
RD : : get_singleton ( ) - > draw_list_draw ( draw_list , false , 1u , 3u ) ;
2022-04-27 05:42:50 +02:00
RD : : get_singleton ( ) - > draw_list_end ( ) ;
}
void ToneMapper : : tonemapper ( RD : : DrawListID p_subpass_draw_list , RID p_source_color , RD : : FramebufferFormatID p_dst_format_id , const TonemapSettings & p_settings ) {
UniformSetCacheRD * uniform_set_cache = UniformSetCacheRD : : get_singleton ( ) ;
ERR_FAIL_NULL ( uniform_set_cache ) ;
MaterialStorage * material_storage = MaterialStorage : : get_singleton ( ) ;
ERR_FAIL_NULL ( material_storage ) ;
memset ( & tonemap . push_constant , 0 , sizeof ( TonemapPushConstant ) ) ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_bcs ? TONEMAP_FLAG_USE_BCS : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . bcs [ 0 ] = p_settings . brightness ;
tonemap . push_constant . bcs [ 1 ] = p_settings . contrast ;
tonemap . push_constant . bcs [ 2 ] = p_settings . saturation ;
ERR_FAIL_COND_MSG ( p_settings . use_glow , " Glow is not supported when using subpasses. " ) ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_glow ? TONEMAP_FLAG_USE_GLOW : 0 ;
2022-04-27 05:42:50 +02:00
int mode = p_settings . use_1d_color_correction ? TONEMAP_MODE_SUBPASS_1D_LUT : TONEMAP_MODE_SUBPASS ;
if ( p_settings . view_count > 1 ) {
// Use MULTIVIEW versions
mode + = 6 ;
}
tonemap . push_constant . tonemapper = p_settings . tonemap_mode ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_auto_exposure ? TONEMAP_FLAG_USE_AUTO_EXPOSURE : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . exposure = p_settings . exposure ;
tonemap . push_constant . white = p_settings . white ;
2022-08-01 01:20:24 +02:00
tonemap . push_constant . auto_exposure_scale = p_settings . auto_exposure_scale ;
2022-04-27 05:42:50 +02:00
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_color_correction ? TONEMAP_FLAG_USE_COLOR_CORRECTION : 0 ;
2022-04-27 05:42:50 +02:00
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . use_debanding ? TONEMAP_FLAG_USE_DEBANDING : 0 ;
2022-04-27 05:42:50 +02:00
tonemap . push_constant . luminance_multiplier = p_settings . luminance_multiplier ;
2023-08-03 14:10:01 +02:00
tonemap . push_constant . flags | = p_settings . convert_to_srgb ? TONEMAP_FLAG_CONVERT_TO_SRGB : 0 ;
2022-05-01 06:30:08 +02:00
RID default_sampler = material_storage - > sampler_rd_get_default ( RS : : CANVAS_ITEM_TEXTURE_FILTER_LINEAR , RS : : CANVAS_ITEM_TEXTURE_REPEAT_DISABLED ) ;
RID default_mipmap_sampler = material_storage - > sampler_rd_get_default ( RS : : CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS , RS : : CANVAS_ITEM_TEXTURE_REPEAT_DISABLED ) ;
2022-04-27 05:42:50 +02:00
RD : : Uniform u_source_color ;
u_source_color . uniform_type = RD : : UNIFORM_TYPE_INPUT_ATTACHMENT ;
u_source_color . binding = 0 ;
u_source_color . append_id ( p_source_color ) ;
RD : : Uniform u_exposure_texture ;
u_exposure_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_exposure_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_exposure_texture . append_id ( default_sampler ) ;
2022-04-27 05:42:50 +02:00
u_exposure_texture . append_id ( p_settings . exposure_texture ) ;
RD : : Uniform u_glow_texture ;
u_glow_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_glow_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_glow_texture . append_id ( default_mipmap_sampler ) ;
2022-04-27 05:42:50 +02:00
u_glow_texture . append_id ( p_settings . glow_texture ) ;
RD : : Uniform u_glow_map ;
u_glow_map . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_glow_map . binding = 1 ;
2022-05-01 06:30:08 +02:00
u_glow_map . append_id ( default_mipmap_sampler ) ;
2022-04-27 05:42:50 +02:00
u_glow_map . append_id ( p_settings . glow_map ) ;
RD : : Uniform u_color_correction_texture ;
u_color_correction_texture . uniform_type = RD : : UNIFORM_TYPE_SAMPLER_WITH_TEXTURE ;
u_color_correction_texture . binding = 0 ;
2022-05-01 06:30:08 +02:00
u_color_correction_texture . append_id ( default_sampler ) ;
2022-04-27 05:42:50 +02:00
u_color_correction_texture . append_id ( p_settings . color_correction_texture ) ;
RID shader = tonemap . shader . version_get_shader ( tonemap . shader_version , mode ) ;
ERR_FAIL_COND ( shader . is_null ( ) ) ;
RD : : get_singleton ( ) - > draw_list_bind_render_pipeline ( p_subpass_draw_list , tonemap . pipelines [ mode ] . get_render_pipeline ( RD : : INVALID_ID , p_dst_format_id , false , RD : : get_singleton ( ) - > draw_list_get_current_pass ( ) ) ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( p_subpass_draw_list , uniform_set_cache - > get_cache ( shader , 0 , u_source_color ) , 0 ) ;
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( p_subpass_draw_list , uniform_set_cache - > get_cache ( shader , 1 , u_exposure_texture ) , 1 ) ; // should be set to a default texture, it's ignored
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( p_subpass_draw_list , uniform_set_cache - > get_cache ( shader , 2 , u_glow_texture , u_glow_map ) , 2 ) ; // should be set to a default texture, it's ignored
RD : : get_singleton ( ) - > draw_list_bind_uniform_set ( p_subpass_draw_list , uniform_set_cache - > get_cache ( shader , 3 , u_color_correction_texture ) , 3 ) ;
RD : : get_singleton ( ) - > draw_list_set_push_constant ( p_subpass_draw_list , & tonemap . push_constant , sizeof ( TonemapPushConstant ) ) ;
2023-08-05 21:30:47 +02:00
RD : : get_singleton ( ) - > draw_list_draw ( p_subpass_draw_list , false , 1u , 0u ) ;
2022-04-27 05:42:50 +02:00
}