2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* rasterizer.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
2020-01-01 10:16:22 +00:00
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* 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. */
/*************************************************************************/
2018-01-04 23:50:27 +00:00
2014-02-10 01:10:30 +00:00
# ifndef RASTERIZER_H
# define RASTERIZER_H
2018-09-11 16:13:45 +00:00
# include "core/math/camera_matrix.h"
2019-07-21 14:31:30 +00:00
# include "core/pair.h"
2018-09-11 16:13:45 +00:00
# include "core/self_list.h"
2020-07-01 12:18:13 +00:00
# include "servers/rendering_server.h"
2016-10-19 14:14:41 +00:00
class RasterizerScene {
public :
2016-11-10 02:55:06 +00:00
/* SHADOW ATLAS API */
2017-03-05 15:44:50 +00:00
virtual RID shadow_atlas_create ( ) = 0 ;
virtual void shadow_atlas_set_size ( RID p_atlas , int p_size ) = 0 ;
virtual void shadow_atlas_set_quadrant_subdivision ( RID p_atlas , int p_quadrant , int p_subdivision ) = 0 ;
virtual bool shadow_atlas_update_light ( RID p_atlas , RID p_light_intance , float p_coverage , uint64_t p_light_version ) = 0 ;
2016-11-10 02:55:06 +00:00
2019-09-07 01:51:27 +00:00
virtual void directional_shadow_atlas_set_size ( int p_size ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual int get_directional_light_shadow_size ( RID p_light_intance ) = 0 ;
virtual void set_directional_shadow_count ( int p_count ) = 0 ;
2016-11-10 02:55:06 +00:00
2020-06-25 13:33:28 +00:00
/* SDFGI UPDATE */
struct InstanceBase ;
virtual void sdfgi_update ( RID p_render_buffers , RID p_environment , const Vector3 & p_world_position ) = 0 ;
virtual int sdfgi_get_pending_region_count ( RID p_render_buffers ) const = 0 ;
virtual AABB sdfgi_get_pending_region_bounds ( RID p_render_buffers , int p_region ) const = 0 ;
virtual uint32_t sdfgi_get_pending_region_cascade ( RID p_render_buffers , int p_region ) const = 0 ;
virtual void sdfgi_update_probes ( RID p_render_buffers , RID p_environment , const RID * p_directional_light_instances , uint32_t p_directional_light_count , const RID * p_positional_light_instances , uint32_t p_positional_light_count ) = 0 ;
2019-08-26 20:43:58 +00:00
/* SKY API */
virtual RID sky_create ( ) = 0 ;
virtual void sky_set_radiance_size ( RID p_sky , int p_radiance_size ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void sky_set_mode ( RID p_sky , RS : : SkyMode p_samples ) = 0 ;
2020-03-20 00:32:19 +00:00
virtual void sky_set_material ( RID p_sky , RID p_material ) = 0 ;
2020-05-01 12:34:23 +00:00
virtual Ref < Image > sky_bake_panorama ( RID p_sky , float p_energy , bool p_bake_irradiance , const Size2i & p_size ) = 0 ;
2019-08-26 20:43:58 +00:00
2016-10-21 10:27:13 +00:00
/* ENVIRONMENT API */
2017-03-05 15:44:50 +00:00
virtual RID environment_create ( ) = 0 ;
2016-10-21 10:27:13 +00:00
2020-03-27 18:21:27 +00:00
virtual void environment_set_background ( RID p_env , RS : : EnvironmentBG p_bg ) = 0 ;
2017-05-25 16:53:59 +00:00
virtual void environment_set_sky ( RID p_env , RID p_sky ) = 0 ;
2017-09-29 21:56:05 +00:00
virtual void environment_set_sky_custom_fov ( RID p_env , float p_scale ) = 0 ;
2018-12-15 05:27:03 +00:00
virtual void environment_set_sky_orientation ( RID p_env , const Basis & p_orientation ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void environment_set_bg_color ( RID p_env , const Color & p_color ) = 0 ;
virtual void environment_set_bg_energy ( RID p_env , float p_energy ) = 0 ;
virtual void environment_set_canvas_max_layer ( RID p_env , int p_max_layer ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void environment_set_ambient_light ( RID p_env , const Color & p_color , RS : : EnvironmentAmbientSource p_ambient = RS : : ENV_AMBIENT_SOURCE_BG , float p_energy = 1.0 , float p_sky_contribution = 0.0 , RS : : EnvironmentReflectionSource p_reflection_source = RS : : ENV_REFLECTION_SOURCE_BG , const Color & p_ao_color = Color ( ) ) = 0 ;
2019-06-11 18:43:37 +00:00
// FIXME: Disabled during Vulkan refactoring, should be ported.
#if 0
2017-08-20 14:17:24 +00:00
virtual void environment_set_camera_feed_id ( RID p_env , int p_camera_feed_id ) = 0 ;
2019-06-11 18:43:37 +00:00
# endif
2016-10-21 10:27:13 +00:00
2020-09-19 22:02:32 +00:00
virtual void environment_set_glow ( RID p_env , bool p_enable , Vector < float > p_levels , float p_intensity , float p_strength , float p_mix , float p_bloom_threshold , RS : : EnvironmentGlowBlendMode p_blend_mode , float p_hdr_bleed_threshold , float p_hdr_bleed_scale , float p_hdr_luminance_cap ) = 0 ;
2020-03-30 13:46:03 +00:00
virtual void environment_glow_set_use_bicubic_upscale ( bool p_enable ) = 0 ;
2020-09-01 06:04:45 +00:00
virtual void environment_glow_set_use_high_quality ( bool p_enable ) = 0 ;
2016-10-21 10:27:13 +00:00
2020-09-05 08:46:56 +00:00
virtual void environment_set_volumetric_fog ( RID p_env , bool p_enable , float p_density , const Color & p_light , float p_light_energy , float p_length , float p_detail_spread , float p_gi_inject , RS : : EnvVolumetricFogShadowFilter p_shadow_filter ) = 0 ;
2020-08-13 01:21:01 +00:00
virtual void environment_set_volumetric_fog_volume_size ( int p_size , int p_depth ) = 0 ;
virtual void environment_set_volumetric_fog_filter_active ( bool p_enable ) = 0 ;
virtual void environment_set_volumetric_fog_directional_shadow_shrink_size ( int p_shrink_size ) = 0 ;
virtual void environment_set_volumetric_fog_positional_shadow_shrink_size ( int p_shrink_size ) = 0 ;
2020-04-02 02:24:52 +00:00
virtual void environment_set_ssr ( RID p_env , bool p_enable , int p_max_steps , float p_fade_int , float p_fade_out , float p_depth_tolerance ) = 0 ;
virtual void environment_set_ssr_roughness_quality ( RS : : EnvironmentSSRRoughnessQuality p_quality ) = 0 ;
2020-10-18 22:27:51 +00:00
virtual void environment_set_ssao ( RID p_env , bool p_enable , float p_radius , float p_intensity , float p_bias , float p_light_affect , float p_ao_channel_affect , RS : : EnvironmentSSAOBlur p_blur , float p_bilateral_sharpness ) = 0 ;
2020-01-25 10:18:55 +00:00
2020-10-18 22:27:51 +00:00
virtual void environment_set_ssao_quality ( RS : : EnvironmentSSAOQuality p_quality , bool p_half_size ) = 0 ;
2016-11-29 22:55:12 +00:00
2020-07-01 12:18:13 +00:00
virtual void environment_set_sdfgi ( RID p_env , bool p_enable , RS : : EnvironmentSDFGICascades p_cascades , float p_min_cell_size , RS : : EnvironmentSDFGIYScale p_y_scale , bool p_use_occlusion , bool p_use_multibounce , bool p_read_sky , float p_energy , float p_normal_bias , float p_probe_bias ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual void environment_set_sdfgi_ray_count ( RS : : EnvironmentSDFGIRayCount p_ray_count ) = 0 ;
virtual void environment_set_sdfgi_frames_to_converge ( RS : : EnvironmentSDFGIFramesToConverge p_frames ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void environment_set_tonemap ( RID p_env , RS : : EnvironmentToneMapper p_tone_mapper , float p_exposure , float p_white , bool p_auto_exposure , float p_min_luminance , float p_max_luminance , float p_auto_exp_speed , float p_auto_exp_scale ) = 0 ;
2016-12-07 20:49:52 +00:00
2017-03-05 15:44:50 +00:00
virtual void environment_set_adjustment ( RID p_env , bool p_enable , float p_brightness , float p_contrast , float p_saturation , RID p_ramp ) = 0 ;
2016-10-19 14:14:41 +00:00
2020-08-21 05:48:04 +00:00
virtual void environment_set_fog ( RID p_env , bool p_enable , const Color & p_light_color , float p_light_energy , float p_sun_scatter , float p_density , float p_height , float p_height_density , float p_aerial_perspective ) = 0 ;
2017-06-07 02:16:17 +00:00
2020-05-01 12:34:23 +00:00
virtual Ref < Image > environment_bake_panorama ( RID p_env , bool p_bake_irradiance , const Size2i & p_size ) = 0 ;
2019-08-26 20:43:58 +00:00
virtual bool is_environment ( RID p_env ) const = 0 ;
2020-03-27 18:21:27 +00:00
virtual RS : : EnvironmentBG environment_get_background ( RID p_env ) const = 0 ;
2019-08-26 20:43:58 +00:00
virtual int environment_get_canvas_max_layer ( RID p_env ) const = 0 ;
2017-06-24 11:58:27 +00:00
2020-01-13 18:37:24 +00:00
virtual RID camera_effects_create ( ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void camera_effects_set_dof_blur_quality ( RS : : DOFBlurQuality p_quality , bool p_use_jitter ) = 0 ;
virtual void camera_effects_set_dof_blur_bokeh_shape ( RS : : DOFBokehShape p_shape ) = 0 ;
2020-01-16 00:23:21 +00:00
virtual void camera_effects_set_dof_blur ( RID p_camera_effects , bool p_far_enable , float p_far_distance , float p_far_transition , bool p_near_enable , float p_near_distance , float p_near_transition , float p_amount ) = 0 ;
2020-01-13 18:37:24 +00:00
virtual void camera_effects_set_custom_exposure ( RID p_camera_effects , bool p_enable , float p_exposure ) = 0 ;
2020-04-10 09:30:36 +00:00
virtual void shadows_quality_set ( RS : : ShadowQuality p_quality ) = 0 ;
virtual void directional_shadow_quality_set ( RS : : ShadowQuality p_quality ) = 0 ;
2020-04-08 01:51:52 +00:00
2019-07-21 14:31:30 +00:00
struct InstanceDependency {
void instance_notify_changed ( bool p_aabb , bool p_dependencies ) ;
void instance_notify_deleted ( RID p_deleted ) ;
~ InstanceDependency ( ) ;
private :
2020-02-12 08:47:16 +00:00
friend struct InstanceBase ;
2019-07-21 14:31:30 +00:00
Map < InstanceBase * , uint32_t > instances ;
} ;
2019-06-10 15:38:51 +00:00
struct InstanceBase {
2020-03-27 18:21:27 +00:00
RS : : InstanceType base_type ;
2016-10-19 14:14:41 +00:00
RID base ;
RID skeleton ;
RID material_override ;
2019-08-18 22:40:52 +00:00
RID instance_data ;
2016-10-19 14:14:41 +00:00
Transform transform ;
int depth_layer ;
2016-11-11 15:27:52 +00:00
uint32_t layer_mask ;
2019-07-21 14:31:30 +00:00
uint32_t instance_version ;
2016-10-19 14:14:41 +00:00
//RID sampled_light;
Vector < RID > materials ;
Vector < RID > light_instances ;
2016-11-19 16:23:37 +00:00
Vector < RID > reflection_probe_instances ;
2016-12-20 03:21:07 +00:00
Vector < RID > gi_probe_instances ;
2016-10-19 14:14:41 +00:00
2017-01-12 11:34:00 +00:00
Vector < float > blend_values ;
2016-10-19 14:14:41 +00:00
2020-03-27 18:21:27 +00:00
RS : : ShadowCastingSetting cast_shadows ;
2016-10-19 14:14:41 +00:00
2018-07-23 15:28:15 +00:00
//fit in 32 bits
2017-03-05 15:44:50 +00:00
bool mirror : 8 ;
2016-10-19 14:14:41 +00:00
bool receive_shadows : 8 ;
2017-01-04 04:16:14 +00:00
bool visible : 8 ;
2019-10-11 02:14:56 +00:00
bool baked_light : 2 ; //this flag is only to know if it actually did use baked light
bool dynamic_gi : 2 ; //this flag is only to know if it actually did use baked light
2018-07-23 15:28:15 +00:00
bool redraw_if_visible : 4 ;
2016-10-19 14:14:41 +00:00
2016-10-27 14:50:26 +00:00
float depth ; //used for sorting
2016-10-19 14:14:41 +00:00
SelfList < InstanceBase > dependency_item ;
2020-05-01 12:34:23 +00:00
InstanceBase * lightmap ;
Rect2 lightmap_uv_scale ;
int lightmap_slice_index ;
uint32_t lightmap_cull_index ;
Vector < Color > lightmap_sh ; //spherical harmonic
2017-12-14 11:59:46 +00:00
2019-10-11 02:14:56 +00:00
AABB aabb ;
AABB transformed_aabb ;
2020-04-17 02:52:00 +00:00
struct InstanceShaderParameter {
int32_t index = - 1 ;
Variant value ;
Variant default_value ;
PropertyInfo info ;
} ;
Map < StringName , InstanceShaderParameter > instance_shader_parameters ;
bool instance_allocated_shader_parameters = false ;
int32_t instance_allocated_shader_parameters_offset = - 1 ;
2020-05-01 12:34:23 +00:00
virtual void dependency_deleted ( RID p_dependency ) { }
virtual void dependency_changed ( bool p_aabb , bool p_dependencies ) { }
2019-07-21 14:31:30 +00:00
Set < InstanceDependency * > dependencies ;
void instance_increase_version ( ) {
instance_version + + ;
}
void update_dependency ( InstanceDependency * p_dependency ) {
dependencies . insert ( p_dependency ) ;
p_dependency - > instances [ this ] = instance_version ;
}
void clean_up_dependencies ( ) {
2020-03-17 06:33:00 +00:00
List < Pair < InstanceDependency * , Map < InstanceBase * , uint32_t > : : Element * > > to_clean_up ;
2019-07-21 14:31:30 +00:00
for ( Set < InstanceDependency * > : : Element * E = dependencies . front ( ) ; E ; E = E - > next ( ) ) {
InstanceDependency * dep = E - > get ( ) ;
Map < InstanceBase * , uint32_t > : : Element * F = dep - > instances . find ( this ) ;
ERR_CONTINUE ( ! F ) ;
if ( F - > get ( ) ! = instance_version ) {
Pair < InstanceDependency * , Map < InstanceBase * , uint32_t > : : Element * > p ;
p . first = dep ;
p . second = F ;
to_clean_up . push_back ( p ) ;
}
}
while ( to_clean_up . size ( ) ) {
to_clean_up . front ( ) - > get ( ) . first - > instances . erase ( to_clean_up . front ( ) - > get ( ) . second ) ;
to_clean_up . pop_front ( ) ;
}
}
void clear_dependencies ( ) {
for ( Set < InstanceDependency * > : : Element * E = dependencies . front ( ) ; E ; E = E - > next ( ) ) {
InstanceDependency * dep = E - > get ( ) ;
dep - > instances . erase ( this ) ;
}
dependencies . clear ( ) ;
}
2017-12-06 20:36:34 +00:00
InstanceBase ( ) :
dependency_item ( this ) {
2020-03-27 18:21:27 +00:00
base_type = RS : : INSTANCE_NONE ;
cast_shadows = RS : : SHADOW_CASTING_SETTING_ON ;
2017-03-05 15:44:50 +00:00
receive_shadows = true ;
visible = true ;
depth_layer = 0 ;
layer_mask = 1 ;
2019-07-21 14:31:30 +00:00
instance_version = 0 ;
2017-07-16 02:24:37 +00:00
baked_light = false ;
2019-10-11 02:14:56 +00:00
dynamic_gi = false ;
2018-07-23 15:28:15 +00:00
redraw_if_visible = false ;
2020-05-01 12:34:23 +00:00
lightmap_slice_index = 0 ;
lightmap = nullptr ;
lightmap_cull_index = 0 ;
2016-10-19 14:14:41 +00:00
}
2019-07-21 14:31:30 +00:00
virtual ~ InstanceBase ( ) {
clear_dependencies ( ) ;
}
2016-10-19 14:14:41 +00:00
} ;
2017-03-05 15:44:50 +00:00
virtual RID light_instance_create ( RID p_light ) = 0 ;
virtual void light_instance_set_transform ( RID p_light_instance , const Transform & p_transform ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual void light_instance_set_aabb ( RID p_light_instance , const AABB & p_aabb ) = 0 ;
2020-04-09 18:11:15 +00:00
virtual void light_instance_set_shadow_transform ( RID p_light_instance , const CameraMatrix & p_projection , const Transform & p_transform , float p_far , float p_split , int p_pass , float p_shadow_texel_size , float p_bias_scale = 1.0 , float p_range_begin = 0 , const Vector2 & p_uv_scale = Vector2 ( ) ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void light_instance_mark_visible ( RID p_light_instance ) = 0 ;
2020-04-02 02:24:52 +00:00
virtual bool light_instances_can_render_shadow_cube ( ) const {
return true ;
}
2016-10-31 11:47:46 +00:00
2019-09-09 20:50:51 +00:00
virtual RID reflection_atlas_create ( ) = 0 ;
virtual void reflection_atlas_set_size ( RID p_ref_atlas , int p_reflection_size , int p_reflection_count ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual RID reflection_probe_instance_create ( RID p_probe ) = 0 ;
virtual void reflection_probe_instance_set_transform ( RID p_instance , const Transform & p_transform ) = 0 ;
2019-09-09 20:50:51 +00:00
virtual void reflection_probe_release_atlas_index ( RID p_instance ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual bool reflection_probe_instance_needs_redraw ( RID p_instance ) = 0 ;
2019-09-09 20:50:51 +00:00
virtual bool reflection_probe_instance_has_reflection ( RID p_instance ) = 0 ;
virtual bool reflection_probe_instance_begin_render ( RID p_instance , RID p_reflection_atlas ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual bool reflection_probe_instance_postprocess_step ( RID p_instance ) = 0 ;
2016-11-19 16:23:37 +00:00
2020-04-14 03:05:21 +00:00
virtual RID decal_instance_create ( RID p_decal ) = 0 ;
virtual void decal_instance_set_transform ( RID p_decal , const Transform & p_transform ) = 0 ;
2019-10-03 20:39:08 +00:00
virtual RID gi_probe_instance_create ( RID p_gi_probe ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void gi_probe_instance_set_transform_to_data ( RID p_probe , const Transform & p_xform ) = 0 ;
2019-10-03 20:39:08 +00:00
virtual bool gi_probe_needs_update ( RID p_probe ) const = 0 ;
2019-10-11 02:14:56 +00:00
virtual void gi_probe_update ( RID p_probe , bool p_update_light_instances , const Vector < RID > & p_light_instances , int p_dynamic_object_count , InstanceBase * * p_dynamic_objects ) = 0 ;
2019-10-03 20:39:08 +00:00
2020-06-25 13:33:28 +00:00
virtual void gi_probe_set_quality ( RS : : GIProbeQuality ) = 0 ;
2020-05-01 12:34:23 +00:00
virtual void render_scene ( RID p_render_buffers , const Transform & p_cam_transform , const CameraMatrix & p_cam_projection , bool p_cam_ortogonal , InstanceBase * * p_cull_result , int p_cull_count , RID * p_light_cull_result , int p_light_cull_count , RID * p_reflection_probe_cull_result , int p_reflection_probe_cull_count , RID * p_gi_probe_cull_result , int p_gi_probe_cull_count , RID * p_decal_cull_result , int p_decal_cull_count , InstanceBase * * p_lightmap_cull_result , int p_lightmap_cull_count , RID p_environment , RID p_camera_effects , RID p_shadow_atlas , RID p_reflection_atlas , RID p_reflection_probe , int p_reflection_probe_pass ) = 0 ;
2016-12-20 03:21:07 +00:00
2017-03-05 15:44:50 +00:00
virtual void render_shadow ( RID p_light , RID p_shadow_atlas , int p_pass , InstanceBase * * p_cull_result , int p_cull_count ) = 0 ;
2019-10-11 02:14:56 +00:00
virtual void render_material ( const Transform & p_cam_transform , const CameraMatrix & p_cam_projection , bool p_cam_ortogonal , InstanceBase * * p_cull_result , int p_cull_count , RID p_framebuffer , const Rect2i & p_region ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual void render_sdfgi ( RID p_render_buffers , int p_region , InstanceBase * * p_cull_result , int p_cull_count ) = 0 ;
virtual void render_sdfgi_static_lights ( RID p_render_buffers , uint32_t p_cascade_count , const uint32_t * p_cascade_indices , const RID * * p_positional_light_cull_result , const uint32_t * p_positional_light_cull_count ) = 0 ;
2020-10-08 00:29:49 +00:00
virtual void render_particle_collider_heightfield ( RID p_collider , const Transform & p_transform , InstanceBase * * p_cull_result , int p_cull_count ) = 0 ;
2016-10-19 14:14:41 +00:00
2017-03-05 15:44:50 +00:00
virtual void set_scene_pass ( uint64_t p_pass ) = 0 ;
2020-01-12 01:26:52 +00:00
virtual void set_time ( double p_time , double p_step ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void set_debug_draw_mode ( RS : : ViewportDebugDraw p_debug_draw ) = 0 ;
2016-10-31 11:47:46 +00:00
2019-08-18 22:40:52 +00:00
virtual RID render_buffers_create ( ) = 0 ;
2020-04-20 21:34:47 +00:00
virtual void render_buffers_configure ( RID p_render_buffers , RID p_render_target , int p_width , int p_height , RS : : ViewportMSAA p_msaa , RS : : ViewportScreenSpaceAA p_screen_space_aa , bool p_use_debanding ) = 0 ;
2019-08-18 22:40:52 +00:00
2020-06-25 13:33:28 +00:00
virtual void screen_space_roughness_limiter_set_active ( bool p_enable , float p_amount , float p_limit ) = 0 ;
2020-01-26 23:09:40 +00:00
virtual bool screen_space_roughness_limiter_is_active ( ) const = 0 ;
2020-04-04 02:42:26 +00:00
virtual void sub_surface_scattering_set_quality ( RS : : SubSurfaceScatteringQuality p_quality ) = 0 ;
virtual void sub_surface_scattering_set_scale ( float p_scale , float p_depth_scale ) = 0 ;
2020-05-01 12:34:23 +00:00
virtual TypedArray < Image > bake_render_uv2 ( RID p_base , const Vector < RID > & p_material_overrides , const Size2i & p_image_size ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual bool free ( RID p_rid ) = 0 ;
2016-10-19 14:14:41 +00:00
2020-06-25 13:33:28 +00:00
virtual void sdfgi_set_debug_probe_select ( const Vector3 & p_position , const Vector3 & p_dir ) = 0 ;
2019-08-26 20:43:58 +00:00
virtual void update ( ) = 0 ;
2016-10-19 14:14:41 +00:00
virtual ~ RasterizerScene ( ) { }
} ;
2016-10-03 19:33:42 +00:00
class RasterizerStorage {
2019-09-09 20:50:51 +00:00
Color default_clear_color ;
2016-10-03 19:33:42 +00:00
public :
/* TEXTURE API */
2019-06-11 18:43:37 +00:00
virtual RID texture_2d_create ( const Ref < Image > & p_image ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual RID texture_2d_layered_create ( const Vector < Ref < Image > > & p_layers , RS : : TextureLayeredType p_layered_type ) = 0 ;
2020-09-09 15:40:51 +00:00
virtual RID texture_3d_create ( Image : : Format , int p_width , int p_height , int p_depth , bool p_mipmaps , const Vector < Ref < Image > > & p_data ) = 0 ;
2019-06-24 19:13:06 +00:00
virtual RID texture_proxy_create ( RID p_base ) = 0 ; //all slices, then all the mipmaps, must be coherent
2019-06-11 18:43:37 +00:00
virtual void texture_2d_update_immediate ( RID p_texture , const Ref < Image > & p_image , int p_layer = 0 ) = 0 ; //mostly used for video and streaming
virtual void texture_2d_update ( RID p_texture , const Ref < Image > & p_image , int p_layer = 0 ) = 0 ;
2020-09-09 15:40:51 +00:00
virtual void texture_3d_update ( RID p_texture , const Vector < Ref < Image > > & p_data ) = 0 ;
2019-06-24 19:13:06 +00:00
virtual void texture_proxy_update ( RID p_proxy , RID p_base ) = 0 ;
2019-06-11 18:43:37 +00:00
//these two APIs can be used together or in combination with the others.
virtual RID texture_2d_placeholder_create ( ) = 0 ;
2020-05-01 12:34:23 +00:00
virtual RID texture_2d_layered_placeholder_create ( RenderingServer : : TextureLayeredType p_layered_type ) = 0 ;
2019-06-11 18:43:37 +00:00
virtual RID texture_3d_placeholder_create ( ) = 0 ;
virtual Ref < Image > texture_2d_get ( RID p_texture ) const = 0 ;
virtual Ref < Image > texture_2d_layer_get ( RID p_texture , int p_layer ) const = 0 ;
2020-09-09 15:40:51 +00:00
virtual Vector < Ref < Image > > texture_3d_get ( RID p_texture ) const = 0 ;
2019-06-11 18:43:37 +00:00
virtual void texture_replace ( RID p_texture , RID p_by_texture ) = 0 ;
virtual void texture_set_size_override ( RID p_texture , int p_width , int p_height ) = 0 ;
// FIXME: Disabled during Vulkan refactoring, should be ported.
#if 0
2017-08-20 14:17:24 +00:00
virtual void texture_bind ( RID p_texture , uint32_t p_texture_no ) = 0 ;
2019-06-11 18:43:37 +00:00
# endif
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void texture_set_path ( RID p_texture , const String & p_path ) = 0 ;
virtual String texture_get_path ( RID p_texture ) const = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void texture_set_detect_3d_callback ( RID p_texture , RS : : TextureDetectCallback p_callback , void * p_userdata ) = 0 ;
virtual void texture_set_detect_normal_callback ( RID p_texture , RS : : TextureDetectCallback p_callback , void * p_userdata ) = 0 ;
virtual void texture_set_detect_roughness_callback ( RID p_texture , RS : : TextureDetectRoughnessCallback p_callback , void * p_userdata ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void texture_debug_usage ( List < RS : : TextureInfo > * r_info ) = 0 ;
2016-10-03 19:33:42 +00:00
2018-07-16 14:43:26 +00:00
virtual void texture_set_force_redraw_if_visible ( RID p_texture , bool p_enable ) = 0 ;
2017-12-04 18:55:20 +00:00
2019-06-24 19:13:06 +00:00
virtual Size2 texture_size_with_proxy ( RID p_proxy ) = 0 ;
2019-06-11 18:43:37 +00:00
2020-04-14 20:05:45 +00:00
virtual void texture_add_to_decal_atlas ( RID p_texture , bool p_panorama_to_dp = false ) = 0 ;
virtual void texture_remove_from_decal_atlas ( RID p_texture , bool p_panorama_to_dp = false ) = 0 ;
2020-04-14 03:05:21 +00:00
2016-10-03 19:33:42 +00:00
/* SHADER API */
2017-04-07 02:36:37 +00:00
virtual RID shader_create ( ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void shader_set_code ( RID p_shader , const String & p_code ) = 0 ;
virtual String shader_get_code ( RID p_shader ) const = 0 ;
virtual void shader_get_param_list ( RID p_shader , List < PropertyInfo > * p_param_list ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void shader_set_default_texture_param ( RID p_shader , const StringName & p_name , RID p_texture ) = 0 ;
virtual RID shader_get_default_texture_param ( RID p_shader , const StringName & p_name ) const = 0 ;
2019-07-12 13:12:48 +00:00
virtual Variant shader_get_param_default ( RID p_material , const StringName & p_param ) const = 0 ;
2016-10-03 19:33:42 +00:00
/* COMMON MATERIAL API */
2017-03-05 15:44:50 +00:00
virtual RID material_create ( ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-09-01 15:56:52 +00:00
virtual void material_set_render_priority ( RID p_material , int priority ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void material_set_shader ( RID p_shader_material , RID p_shader ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void material_set_param ( RID p_material , const StringName & p_param , const Variant & p_value ) = 0 ;
virtual Variant material_get_param ( RID p_material , const StringName & p_param ) const = 0 ;
2016-10-29 23:48:09 +00:00
2017-07-08 15:34:05 +00:00
virtual void material_set_next_pass ( RID p_material , RID p_next_material ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual bool material_is_animated ( RID p_material ) = 0 ;
virtual bool material_casts_shadows ( RID p_material ) = 0 ;
2016-11-10 02:55:06 +00:00
2020-04-17 02:52:00 +00:00
struct InstanceShaderParam {
PropertyInfo info ;
int index ;
Variant default_value ;
} ;
virtual void material_get_instance_shader_parameters ( RID p_material , List < InstanceShaderParam > * r_parameters ) = 0 ;
2019-07-21 14:31:30 +00:00
virtual void material_update_dependency ( RID p_material , RasterizerScene : : InstanceBase * p_instance ) = 0 ;
2016-11-10 02:55:06 +00:00
2016-10-03 19:33:42 +00:00
/* MESH API */
2017-03-05 15:44:50 +00:00
virtual RID mesh_create ( ) = 0 ;
2016-10-03 19:33:42 +00:00
2019-08-18 22:40:52 +00:00
/// Returns stride
2020-03-27 18:21:27 +00:00
virtual void mesh_add_surface ( RID p_mesh , const RS : : SurfaceData & p_surface ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual int mesh_get_blend_shape_count ( RID p_mesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void mesh_set_blend_shape_mode ( RID p_mesh , RS : : BlendShapeMode p_mode ) = 0 ;
virtual RS : : BlendShapeMode mesh_get_blend_shape_mode ( RID p_mesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2020-02-17 21:06:54 +00:00
virtual void mesh_surface_update_region ( RID p_mesh , int p_surface , int p_offset , const Vector < uint8_t > & p_data ) = 0 ;
2017-11-14 20:25:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void mesh_surface_set_material ( RID p_mesh , int p_surface , RID p_material ) = 0 ;
virtual RID mesh_surface_get_material ( RID p_mesh , int p_surface ) const = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual RS : : SurfaceData mesh_get_surface ( RID p_mesh , int p_surface ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual int mesh_get_surface_count ( RID p_mesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-11-17 02:09:00 +00:00
virtual void mesh_set_custom_aabb ( RID p_mesh , const AABB & p_aabb ) = 0 ;
virtual AABB mesh_get_custom_aabb ( RID p_mesh ) const = 0 ;
2016-11-10 02:55:06 +00:00
2019-08-18 22:40:52 +00:00
virtual AABB mesh_get_aabb ( RID p_mesh , RID p_skeleton = RID ( ) ) = 0 ;
2017-11-21 00:26:37 +00:00
2017-03-05 15:44:50 +00:00
virtual void mesh_clear ( RID p_mesh ) = 0 ;
2016-10-03 19:33:42 +00:00
/* MULTIMESH API */
2017-03-05 15:44:50 +00:00
virtual RID multimesh_create ( ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void multimesh_allocate ( RID p_multimesh , int p_instances , RS : : MultimeshTransformFormat p_transform_format , bool p_use_colors = false , bool p_use_custom_data = false ) = 0 ;
2019-09-14 03:37:42 +00:00
2017-03-05 15:44:50 +00:00
virtual int multimesh_get_instance_count ( RID p_multimesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void multimesh_set_mesh ( RID p_multimesh , RID p_mesh ) = 0 ;
virtual void multimesh_instance_set_transform ( RID p_multimesh , int p_index , const Transform & p_transform ) = 0 ;
virtual void multimesh_instance_set_transform_2d ( RID p_multimesh , int p_index , const Transform2D & p_transform ) = 0 ;
virtual void multimesh_instance_set_color ( RID p_multimesh , int p_index , const Color & p_color ) = 0 ;
2018-07-06 23:21:13 +00:00
virtual void multimesh_instance_set_custom_data ( RID p_multimesh , int p_index , const Color & p_color ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual RID multimesh_get_mesh ( RID p_multimesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual Transform multimesh_instance_get_transform ( RID p_multimesh , int p_index ) const = 0 ;
virtual Transform2D multimesh_instance_get_transform_2d ( RID p_multimesh , int p_index ) const = 0 ;
virtual Color multimesh_instance_get_color ( RID p_multimesh , int p_index ) const = 0 ;
2018-07-06 23:21:13 +00:00
virtual Color multimesh_instance_get_custom_data ( RID p_multimesh , int p_index ) const = 0 ;
2020-02-17 21:06:54 +00:00
virtual void multimesh_set_buffer ( RID p_multimesh , const Vector < float > & p_buffer ) = 0 ;
virtual Vector < float > multimesh_get_buffer ( RID p_multimesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void multimesh_set_visible_instances ( RID p_multimesh , int p_visible ) = 0 ;
virtual int multimesh_get_visible_instances ( RID p_multimesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-11-17 02:09:00 +00:00
virtual AABB multimesh_get_aabb ( RID p_multimesh ) const = 0 ;
2016-10-03 19:33:42 +00:00
/* IMMEDIATE API */
2017-03-05 15:44:50 +00:00
virtual RID immediate_create ( ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void immediate_begin ( RID p_immediate , RS : : PrimitiveType p_rimitive , RID p_texture = RID ( ) ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void immediate_vertex ( RID p_immediate , const Vector3 & p_vertex ) = 0 ;
virtual void immediate_normal ( RID p_immediate , const Vector3 & p_normal ) = 0 ;
virtual void immediate_tangent ( RID p_immediate , const Plane & p_tangent ) = 0 ;
virtual void immediate_color ( RID p_immediate , const Color & p_color ) = 0 ;
virtual void immediate_uv ( RID p_immediate , const Vector2 & tex_uv ) = 0 ;
virtual void immediate_uv2 ( RID p_immediate , const Vector2 & tex_uv ) = 0 ;
virtual void immediate_end ( RID p_immediate ) = 0 ;
virtual void immediate_clear ( RID p_immediate ) = 0 ;
virtual void immediate_set_material ( RID p_immediate , RID p_material ) = 0 ;
virtual RID immediate_get_material ( RID p_immediate ) const = 0 ;
2017-11-17 02:09:00 +00:00
virtual AABB immediate_get_aabb ( RID p_immediate ) const = 0 ;
2016-10-03 19:33:42 +00:00
/* SKELETON API */
2017-03-05 15:44:50 +00:00
virtual RID skeleton_create ( ) = 0 ;
virtual void skeleton_allocate ( RID p_skeleton , int p_bones , bool p_2d_skeleton = false ) = 0 ;
virtual int skeleton_get_bone_count ( RID p_skeleton ) const = 0 ;
virtual void skeleton_bone_set_transform ( RID p_skeleton , int p_bone , const Transform & p_transform ) = 0 ;
virtual Transform skeleton_bone_get_transform ( RID p_skeleton , int p_bone ) const = 0 ;
virtual void skeleton_bone_set_transform_2d ( RID p_skeleton , int p_bone , const Transform2D & p_transform ) = 0 ;
virtual Transform2D skeleton_bone_get_transform_2d ( RID p_skeleton , int p_bone ) const = 0 ;
2018-05-03 20:29:15 +00:00
virtual void skeleton_set_base_transform_2d ( RID p_skeleton , const Transform2D & p_base_transform ) = 0 ;
2016-10-03 19:33:42 +00:00
/* Light API */
2020-03-27 18:21:27 +00:00
virtual RID light_create ( RS : : LightType p_type ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
RID directional_light_create ( ) { return light_create ( RS : : LIGHT_DIRECTIONAL ) ; }
RID omni_light_create ( ) { return light_create ( RS : : LIGHT_OMNI ) ; }
RID spot_light_create ( ) { return light_create ( RS : : LIGHT_SPOT ) ; }
2017-11-10 02:34:01 +00:00
2017-03-05 15:44:50 +00:00
virtual void light_set_color ( RID p_light , const Color & p_color ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void light_set_param ( RID p_light , RS : : LightParam p_param , float p_value ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void light_set_shadow ( RID p_light , bool p_enabled ) = 0 ;
virtual void light_set_shadow_color ( RID p_light , const Color & p_color ) = 0 ;
virtual void light_set_projector ( RID p_light , RID p_texture ) = 0 ;
virtual void light_set_negative ( RID p_light , bool p_enable ) = 0 ;
virtual void light_set_cull_mask ( RID p_light , uint32_t p_mask ) = 0 ;
2017-08-19 23:06:40 +00:00
virtual void light_set_reverse_cull_face_mode ( RID p_light , bool p_enabled ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual void light_set_bake_mode ( RID p_light , RS : : LightBakeMode p_bake_mode ) = 0 ;
virtual void light_set_max_sdfgi_cascade ( RID p_light , uint32_t p_cascade ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void light_omni_set_shadow_mode ( RID p_light , RS : : LightOmniShadowMode p_mode ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual void light_directional_set_shadow_mode ( RID p_light , RS : : LightDirectionalShadowMode p_mode ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void light_directional_set_blend_splits ( RID p_light , bool p_enable ) = 0 ;
virtual bool light_directional_get_blend_splits ( RID p_light ) const = 0 ;
2020-03-27 18:21:27 +00:00
virtual void light_directional_set_shadow_depth_range_mode ( RID p_light , RS : : LightDirectionalShadowDepthRangeMode p_range_mode ) = 0 ;
virtual RS : : LightDirectionalShadowDepthRangeMode light_directional_get_shadow_depth_range_mode ( RID p_light ) const = 0 ;
2017-09-07 21:00:47 +00:00
2020-03-27 18:21:27 +00:00
virtual RS : : LightDirectionalShadowMode light_directional_get_shadow_mode ( RID p_light ) = 0 ;
virtual RS : : LightOmniShadowMode light_omni_get_shadow_mode ( RID p_light ) = 0 ;
2016-11-10 02:55:06 +00:00
2017-03-05 15:44:50 +00:00
virtual bool light_has_shadow ( RID p_light ) const = 0 ;
2016-11-10 02:55:06 +00:00
2020-03-27 18:21:27 +00:00
virtual RS : : LightType light_get_type ( RID p_light ) const = 0 ;
2017-11-17 02:09:00 +00:00
virtual AABB light_get_aabb ( RID p_light ) const = 0 ;
2020-03-27 18:21:27 +00:00
virtual float light_get_param ( RID p_light , RS : : LightParam p_param ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual Color light_get_color ( RID p_light ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual RS : : LightBakeMode light_get_bake_mode ( RID p_light ) = 0 ;
virtual uint32_t light_get_max_sdfgi_cascade ( RID p_light ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual uint64_t light_get_version ( RID p_light ) const = 0 ;
2016-10-19 14:14:41 +00:00
2016-10-03 19:33:42 +00:00
/* PROBE API */
2017-03-05 15:44:50 +00:00
virtual RID reflection_probe_create ( ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void reflection_probe_set_update_mode ( RID p_probe , RS : : ReflectionProbeUpdateMode p_mode ) = 0 ;
2018-09-28 19:40:20 +00:00
virtual void reflection_probe_set_resolution ( RID p_probe , int p_resolution ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void reflection_probe_set_intensity ( RID p_probe , float p_intensity ) = 0 ;
2020-06-25 13:33:28 +00:00
virtual void reflection_probe_set_ambient_mode ( RID p_probe , RS : : ReflectionProbeAmbientMode p_mode ) = 0 ;
virtual void reflection_probe_set_ambient_color ( RID p_probe , const Color & p_color ) = 0 ;
virtual void reflection_probe_set_ambient_energy ( RID p_probe , float p_energy ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void reflection_probe_set_max_distance ( RID p_probe , float p_distance ) = 0 ;
virtual void reflection_probe_set_extents ( RID p_probe , const Vector3 & p_extents ) = 0 ;
virtual void reflection_probe_set_origin_offset ( RID p_probe , const Vector3 & p_offset ) = 0 ;
virtual void reflection_probe_set_as_interior ( RID p_probe , bool p_enable ) = 0 ;
virtual void reflection_probe_set_enable_box_projection ( RID p_probe , bool p_enable ) = 0 ;
virtual void reflection_probe_set_enable_shadows ( RID p_probe , bool p_enable ) = 0 ;
virtual void reflection_probe_set_cull_mask ( RID p_probe , uint32_t p_layers ) = 0 ;
2017-11-17 02:09:00 +00:00
virtual AABB reflection_probe_get_aabb ( RID p_probe ) const = 0 ;
2020-03-27 18:21:27 +00:00
virtual RS : : ReflectionProbeUpdateMode reflection_probe_get_update_mode ( RID p_probe ) const = 0 ;
2017-03-05 15:44:50 +00:00
virtual uint32_t reflection_probe_get_cull_mask ( RID p_probe ) const = 0 ;
virtual Vector3 reflection_probe_get_extents ( RID p_probe ) const = 0 ;
virtual Vector3 reflection_probe_get_origin_offset ( RID p_probe ) const = 0 ;
virtual float reflection_probe_get_origin_max_distance ( RID p_probe ) const = 0 ;
virtual bool reflection_probe_renders_shadows ( RID p_probe ) const = 0 ;
2016-10-03 19:33:42 +00:00
2019-07-21 14:31:30 +00:00
virtual void base_update_dependency ( RID p_base , RasterizerScene : : InstanceBase * p_instance ) = 0 ;
virtual void skeleton_update_dependency ( RID p_base , RasterizerScene : : InstanceBase * p_instance ) = 0 ;
2016-10-19 14:14:41 +00:00
2020-04-14 03:05:21 +00:00
/* DECAL API */
virtual RID decal_create ( ) = 0 ;
virtual void decal_set_extents ( RID p_decal , const Vector3 & p_extents ) = 0 ;
virtual void decal_set_texture ( RID p_decal , RS : : DecalTexture p_type , RID p_texture ) = 0 ;
virtual void decal_set_emission_energy ( RID p_decal , float p_energy ) = 0 ;
virtual void decal_set_albedo_mix ( RID p_decal , float p_mix ) = 0 ;
virtual void decal_set_modulate ( RID p_decal , const Color & p_modulate ) = 0 ;
virtual void decal_set_cull_mask ( RID p_decal , uint32_t p_layers ) = 0 ;
virtual void decal_set_distance_fade ( RID p_decal , bool p_enabled , float p_begin , float p_length ) = 0 ;
virtual void decal_set_fade ( RID p_decal , float p_above , float p_below ) = 0 ;
virtual void decal_set_normal_fade ( RID p_decal , float p_fade ) = 0 ;
virtual AABB decal_get_aabb ( RID p_decal ) const = 0 ;
2016-12-20 03:21:07 +00:00
/* GI PROBE API */
2017-03-05 15:44:50 +00:00
virtual RID gi_probe_create ( ) = 0 ;
2016-12-20 03:21:07 +00:00
2020-02-17 21:06:54 +00:00
virtual void gi_probe_allocate ( RID p_gi_probe , const Transform & p_to_cell_xform , const AABB & p_aabb , const Vector3i & p_octree_size , const Vector < uint8_t > & p_octree_cells , const Vector < uint8_t > & p_data_cells , const Vector < uint8_t > & p_distance_field , const Vector < int > & p_level_counts ) = 0 ;
2016-12-20 03:21:07 +00:00
2019-10-03 20:39:08 +00:00
virtual AABB gi_probe_get_bounds ( RID p_gi_probe ) const = 0 ;
virtual Vector3i gi_probe_get_octree_size ( RID p_gi_probe ) const = 0 ;
2020-02-17 21:06:54 +00:00
virtual Vector < uint8_t > gi_probe_get_octree_cells ( RID p_gi_probe ) const = 0 ;
virtual Vector < uint8_t > gi_probe_get_data_cells ( RID p_gi_probe ) const = 0 ;
virtual Vector < uint8_t > gi_probe_get_distance_field ( RID p_gi_probe ) const = 0 ;
2019-10-13 00:24:03 +00:00
2020-02-17 21:06:54 +00:00
virtual Vector < int > gi_probe_get_level_counts ( RID p_gi_probe ) const = 0 ;
2019-10-03 20:39:08 +00:00
virtual Transform gi_probe_get_to_cell_xform ( RID p_gi_probe ) const = 0 ;
2016-12-20 03:21:07 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_dynamic_range ( RID p_gi_probe , float p_range ) = 0 ;
virtual float gi_probe_get_dynamic_range ( RID p_gi_probe ) const = 0 ;
2016-12-20 03:21:07 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_propagation ( RID p_gi_probe , float p_range ) = 0 ;
virtual float gi_probe_get_propagation ( RID p_gi_probe ) const = 0 ;
2016-12-20 03:21:07 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_energy ( RID p_gi_probe , float p_energy ) = 0 ;
virtual float gi_probe_get_energy ( RID p_gi_probe ) const = 0 ;
2016-12-22 13:00:15 +00:00
2019-10-14 06:45:44 +00:00
virtual void gi_probe_set_ao ( RID p_gi_probe , float p_ao ) = 0 ;
virtual float gi_probe_get_ao ( RID p_gi_probe ) const = 0 ;
2019-11-04 21:17:53 +00:00
virtual void gi_probe_set_ao_size ( RID p_gi_probe , float p_strength ) = 0 ;
virtual float gi_probe_get_ao_size ( RID p_gi_probe ) const = 0 ;
2019-10-14 06:45:44 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_bias ( RID p_gi_probe , float p_bias ) = 0 ;
virtual float gi_probe_get_bias ( RID p_gi_probe ) const = 0 ;
2017-02-16 11:55:11 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_normal_bias ( RID p_gi_probe , float p_range ) = 0 ;
virtual float gi_probe_get_normal_bias ( RID p_gi_probe ) const = 0 ;
2017-07-16 02:24:37 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_interior ( RID p_gi_probe , bool p_enable ) = 0 ;
virtual bool gi_probe_is_interior ( RID p_gi_probe ) const = 0 ;
2017-02-06 08:12:15 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_use_two_bounces ( RID p_gi_probe , bool p_enable ) = 0 ;
virtual bool gi_probe_is_using_two_bounces ( RID p_gi_probe ) const = 0 ;
2016-12-20 03:21:07 +00:00
2019-10-03 20:39:08 +00:00
virtual void gi_probe_set_anisotropy_strength ( RID p_gi_probe , float p_strength ) = 0 ;
virtual float gi_probe_get_anisotropy_strength ( RID p_gi_probe ) const = 0 ;
2016-12-31 13:53:29 +00:00
2017-03-05 15:44:50 +00:00
virtual uint32_t gi_probe_get_version ( RID p_probe ) = 0 ;
2016-12-20 03:21:07 +00:00
2017-12-14 11:59:46 +00:00
/* LIGHTMAP CAPTURE */
2020-05-01 12:34:23 +00:00
virtual RID lightmap_create ( ) = 0 ;
virtual void lightmap_set_textures ( RID p_lightmap , RID p_light , bool p_uses_spherical_haromics ) = 0 ;
virtual void lightmap_set_probe_bounds ( RID p_lightmap , const AABB & p_bounds ) = 0 ;
virtual void lightmap_set_probe_interior ( RID p_lightmap , bool p_interior ) = 0 ;
virtual void lightmap_set_probe_capture_data ( RID p_lightmap , const PackedVector3Array & p_points , const PackedColorArray & p_point_sh , const PackedInt32Array & p_tetrahedra , const PackedInt32Array & p_bsp_tree ) = 0 ;
virtual PackedVector3Array lightmap_get_probe_capture_points ( RID p_lightmap ) const = 0 ;
virtual PackedColorArray lightmap_get_probe_capture_sh ( RID p_lightmap ) const = 0 ;
virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra ( RID p_lightmap ) const = 0 ;
virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree ( RID p_lightmap ) const = 0 ;
virtual AABB lightmap_get_aabb ( RID p_lightmap ) const = 0 ;
virtual void lightmap_tap_sh_light ( RID p_lightmap , const Vector3 & p_point , Color * r_sh ) = 0 ;
virtual bool lightmap_is_interior ( RID p_lightmap ) const = 0 ;
virtual void lightmap_set_probe_capture_update_speed ( float p_speed ) = 0 ;
virtual float lightmap_get_probe_capture_update_speed ( ) const = 0 ;
2017-12-14 11:59:46 +00:00
2016-12-30 11:35:54 +00:00
/* PARTICLES */
2017-03-05 15:44:50 +00:00
virtual RID particles_create ( ) = 0 ;
2016-12-30 11:35:54 +00:00
2017-03-05 15:44:50 +00:00
virtual void particles_set_emitting ( RID p_particles , bool p_emitting ) = 0 ;
2017-12-23 04:08:50 +00:00
virtual bool particles_get_emitting ( RID p_particles ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void particles_set_amount ( RID p_particles , int p_amount ) = 0 ;
virtual void particles_set_lifetime ( RID p_particles , float p_lifetime ) = 0 ;
2017-06-25 11:01:15 +00:00
virtual void particles_set_one_shot ( RID p_particles , bool p_one_shot ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void particles_set_pre_process_time ( RID p_particles , float p_time ) = 0 ;
virtual void particles_set_explosiveness_ratio ( RID p_particles , float p_ratio ) = 0 ;
virtual void particles_set_randomness_ratio ( RID p_particles , float p_ratio ) = 0 ;
2017-11-17 02:09:00 +00:00
virtual void particles_set_custom_aabb ( RID p_particles , const AABB & p_aabb ) = 0 ;
2017-04-09 01:38:11 +00:00
virtual void particles_set_speed_scale ( RID p_particles , float p_scale ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void particles_set_use_local_coordinates ( RID p_particles , bool p_enable ) = 0 ;
virtual void particles_set_process_material ( RID p_particles , RID p_material ) = 0 ;
2017-04-07 02:36:37 +00:00
virtual void particles_set_fixed_fps ( RID p_particles , int p_fps ) = 0 ;
virtual void particles_set_fractional_delta ( RID p_particles , bool p_enable ) = 0 ;
2020-10-08 00:29:49 +00:00
virtual void particles_set_collision_base_size ( RID p_particles , float p_size ) = 0 ;
2017-06-25 11:01:15 +00:00
virtual void particles_restart ( RID p_particles ) = 0 ;
2020-09-06 12:18:10 +00:00
virtual void particles_emit ( RID p_particles , const Transform & p_transform , const Vector3 & p_velocity , const Color & p_color , const Color & p_custom , uint32_t p_emit_flags ) = 0 ;
virtual void particles_set_subemitter ( RID p_particles , RID p_subemitter_particles ) = 0 ;
2016-12-30 11:35:54 +00:00
2018-11-19 23:34:29 +00:00
virtual bool particles_is_inactive ( RID p_particles ) const = 0 ;
2020-03-27 18:21:27 +00:00
virtual void particles_set_draw_order ( RID p_particles , RS : : ParticlesDrawOrder p_order ) = 0 ;
2016-12-20 03:21:07 +00:00
2017-03-05 15:44:50 +00:00
virtual void particles_set_draw_passes ( RID p_particles , int p_count ) = 0 ;
virtual void particles_set_draw_pass_mesh ( RID p_particles , int p_pass , RID p_mesh ) = 0 ;
2016-12-25 11:05:23 +00:00
2017-04-07 02:36:37 +00:00
virtual void particles_request_process ( RID p_particles ) = 0 ;
2017-11-17 02:09:00 +00:00
virtual AABB particles_get_current_aabb ( RID p_particles ) = 0 ;
virtual AABB particles_get_aabb ( RID p_particles ) const = 0 ;
2017-04-07 02:36:37 +00:00
virtual void particles_set_emission_transform ( RID p_particles , const Transform & p_transform ) = 0 ;
2016-12-25 11:05:23 +00:00
2017-06-17 10:32:49 +00:00
virtual int particles_get_draw_passes ( RID p_particles ) const = 0 ;
virtual RID particles_get_draw_pass_mesh ( RID p_particles , int p_pass ) const = 0 ;
2020-08-19 13:38:24 +00:00
virtual void particles_set_view_axis ( RID p_particles , const Vector3 & p_axis ) = 0 ;
2020-10-08 00:29:49 +00:00
virtual void particles_add_collision ( RID p_particles , RasterizerScene : : InstanceBase * p_instance ) = 0 ;
virtual void particles_remove_collision ( RID p_particles , RasterizerScene : : InstanceBase * p_instance ) = 0 ;
virtual void update_particles ( ) = 0 ;
/* PARTICLES COLLISION */
virtual RID particles_collision_create ( ) = 0 ;
virtual void particles_collision_set_collision_type ( RID p_particles_collision , RS : : ParticlesCollisionType p_type ) = 0 ;
virtual void particles_collision_set_cull_mask ( RID p_particles_collision , uint32_t p_cull_mask ) = 0 ;
virtual void particles_collision_set_sphere_radius ( RID p_particles_collision , float p_radius ) = 0 ; //for spheres
virtual void particles_collision_set_box_extents ( RID p_particles_collision , const Vector3 & p_extents ) = 0 ; //for non-spheres
virtual void particles_collision_set_attractor_strength ( RID p_particles_collision , float p_strength ) = 0 ;
virtual void particles_collision_set_attractor_directionality ( RID p_particles_collision , float p_directionality ) = 0 ;
virtual void particles_collision_set_attractor_attenuation ( RID p_particles_collision , float p_curve ) = 0 ;
virtual void particles_collision_set_field_texture ( RID p_particles_collision , RID p_texture ) = 0 ; //for SDF and vector field, heightfield is dynamic
virtual void particles_collision_height_field_update ( RID p_particles_collision ) = 0 ; //for SDF and vector field
virtual void particles_collision_set_height_field_resolution ( RID p_particles_collision , RS : : ParticlesCollisionHeightfieldResolution p_resolution ) = 0 ; //for SDF and vector field
virtual AABB particles_collision_get_aabb ( RID p_particles_collision ) const = 0 ;
virtual bool particles_collision_is_heightfield ( RID p_particles_collision ) const = 0 ;
virtual RID particles_collision_get_heightfield_framebuffer ( RID p_particles_collision ) const = 0 ;
2020-04-17 02:52:00 +00:00
/* GLOBAL VARIABLES */
virtual void global_variable_add ( const StringName & p_name , RS : : GlobalVariableType p_type , const Variant & p_value ) = 0 ;
virtual void global_variable_remove ( const StringName & p_name ) = 0 ;
virtual Vector < StringName > global_variable_get_list ( ) const = 0 ;
virtual void global_variable_set ( const StringName & p_name , const Variant & p_value ) = 0 ;
virtual void global_variable_set_override ( const StringName & p_name , const Variant & p_value ) = 0 ;
virtual Variant global_variable_get ( const StringName & p_name ) const = 0 ;
virtual RS : : GlobalVariableType global_variable_get_type ( const StringName & p_name ) const = 0 ;
virtual void global_variables_load_settings ( bool p_load_textures = true ) = 0 ;
virtual void global_variables_clear ( ) = 0 ;
virtual int32_t global_variables_instance_allocate ( RID p_instance ) = 0 ;
virtual void global_variables_instance_free ( RID p_instance ) = 0 ;
virtual void global_variables_instance_update ( RID p_instance , int p_index , const Variant & p_value ) = 0 ;
2016-10-03 19:33:42 +00:00
/* RENDER TARGET */
enum RenderTargetFlags {
RENDER_TARGET_TRANSPARENT ,
2019-05-08 18:25:34 +00:00
RENDER_TARGET_DIRECT_TO_SCREEN ,
2016-10-03 19:33:42 +00:00
RENDER_TARGET_FLAG_MAX
} ;
2017-03-05 15:44:50 +00:00
virtual RID render_target_create ( ) = 0 ;
2019-05-08 18:25:34 +00:00
virtual void render_target_set_position ( RID p_render_target , int p_x , int p_y ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void render_target_set_size ( RID p_render_target , int p_width , int p_height ) = 0 ;
2019-06-16 02:45:24 +00:00
virtual RID render_target_get_texture ( RID p_render_target ) = 0 ;
2019-03-30 13:03:49 +00:00
virtual void render_target_set_external_texture ( RID p_render_target , unsigned int p_texture_id ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void render_target_set_flag ( RID p_render_target , RenderTargetFlags p_flag , bool p_value ) = 0 ;
2017-06-17 11:58:57 +00:00
virtual bool render_target_was_used ( RID p_render_target ) = 0 ;
2019-06-24 19:13:06 +00:00
virtual void render_target_set_as_unused ( RID p_render_target ) = 0 ;
virtual void render_target_request_clear ( RID p_render_target , const Color & p_clear_color ) = 0 ;
virtual bool render_target_is_clear_requested ( RID p_render_target ) = 0 ;
virtual Color render_target_get_clear_request_color ( RID p_render_target ) = 0 ;
virtual void render_target_disable_clear_request ( RID p_render_target ) = 0 ;
2019-06-25 01:24:07 +00:00
virtual void render_target_do_clear_request ( RID p_render_target ) = 0 ;
2016-10-03 19:33:42 +00:00
2020-03-27 18:21:27 +00:00
virtual RS : : InstanceType get_base_type ( RID p_rid ) const = 0 ;
2017-03-05 15:44:50 +00:00
virtual bool free ( RID p_rid ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual bool has_os_feature ( const String & p_feature ) const = 0 ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
virtual void update_dirty_resources ( ) = 0 ;
2017-02-16 11:55:11 +00:00
2017-06-11 18:52:03 +00:00
virtual void set_debug_generate_wireframes ( bool p_generate ) = 0 ;
2017-06-11 21:13:04 +00:00
virtual void render_info_begin_capture ( ) = 0 ;
virtual void render_info_end_capture ( ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual int get_captured_render_info ( RS : : RenderInfo p_info ) = 0 ;
2017-06-11 21:13:04 +00:00
2020-03-27 18:21:27 +00:00
virtual int get_render_info ( RS : : RenderInfo p_info ) = 0 ;
2019-09-13 18:08:05 +00:00
virtual String get_video_adapter_name ( ) const = 0 ;
virtual String get_video_adapter_vendor ( ) const = 0 ;
2017-06-11 21:13:04 +00:00
2017-05-29 06:08:16 +00:00
static RasterizerStorage * base_singleton ;
2019-07-21 14:31:30 +00:00
2019-09-09 20:50:51 +00:00
void set_default_clear_color ( const Color & p_color ) {
default_clear_color = p_color ;
}
Color get_default_clear_color ( ) const {
return default_clear_color ;
}
2020-05-10 10:56:01 +00:00
# define TIMESTAMP_BEGIN() \
{ \
if ( RSG : : storage - > capturing_timestamps ) \
RSG : : storage - > capture_timestamps_begin ( ) ; \
2019-10-03 23:15:38 +00:00
}
2020-05-10 10:56:01 +00:00
# define RENDER_TIMESTAMP(m_text) \
{ \
if ( RSG : : storage - > capturing_timestamps ) \
RSG : : storage - > capture_timestamp ( m_text ) ; \
2019-09-20 20:58:06 +00:00
}
bool capturing_timestamps = false ;
virtual void capture_timestamps_begin ( ) = 0 ;
virtual void capture_timestamp ( const String & p_name ) = 0 ;
virtual uint32_t get_captured_timestamps_count ( ) const = 0 ;
virtual uint64_t get_captured_timestamps_frame ( ) const = 0 ;
virtual uint64_t get_captured_timestamp_gpu_time ( uint32_t p_index ) const = 0 ;
virtual uint64_t get_captured_timestamp_cpu_time ( uint32_t p_index ) const = 0 ;
virtual String get_captured_timestamp_name ( uint32_t p_index ) const = 0 ;
2019-09-09 20:50:51 +00:00
2016-10-03 19:33:42 +00:00
RasterizerStorage ( ) ;
virtual ~ RasterizerStorage ( ) { }
} ;
class RasterizerCanvas {
public :
2019-06-16 02:45:24 +00:00
static RasterizerCanvas * singleton ;
2016-10-03 19:33:42 +00:00
enum CanvasRectFlags {
2017-03-05 15:44:50 +00:00
CANVAS_RECT_REGION = 1 ,
CANVAS_RECT_TILE = 2 ,
CANVAS_RECT_FLIP_H = 4 ,
CANVAS_RECT_FLIP_V = 8 ,
2017-06-19 01:55:02 +00:00
CANVAS_RECT_TRANSPOSE = 16 ,
CANVAS_RECT_CLIP_UV = 32
2016-10-03 19:33:42 +00:00
} ;
2019-06-10 15:38:51 +00:00
struct Light {
2016-10-03 19:33:42 +00:00
bool enabled ;
Color color ;
2017-01-11 03:52:51 +00:00
Transform2D xform ;
2016-10-03 19:33:42 +00:00
float height ;
float energy ;
float scale ;
int z_min ;
int z_max ;
int layer_min ;
int layer_max ;
int item_mask ;
int item_shadow_mask ;
2020-03-27 18:21:27 +00:00
RS : : CanvasLightMode mode ;
2016-10-03 19:33:42 +00:00
RID texture ;
Vector2 texture_offset ;
RID canvas ;
2019-07-05 01:54:32 +00:00
bool use_shadow ;
2016-10-03 19:33:42 +00:00
int shadow_buffer_size ;
2020-03-27 18:21:27 +00:00
RS : : CanvasLightShadowFilter shadow_filter ;
2016-10-03 19:33:42 +00:00
Color shadow_color ;
2017-06-13 04:23:04 +00:00
float shadow_smooth ;
2016-10-03 19:33:42 +00:00
2019-07-05 01:54:32 +00:00
//void *texture_cache; // implementation dependent
2016-10-03 19:33:42 +00:00
Rect2 rect_cache ;
2017-01-11 03:52:51 +00:00
Transform2D xform_cache ;
2016-10-03 19:33:42 +00:00
float radius_cache ; //used for shadow far plane
2019-07-05 01:54:32 +00:00
//CameraMatrix shadow_matrix_cache;
2016-10-03 19:33:42 +00:00
2017-01-11 03:52:51 +00:00
Transform2D light_shader_xform ;
2019-07-05 01:54:32 +00:00
//Vector2 light_shader_pos;
2016-10-03 19:33:42 +00:00
Light * shadows_next_ptr ;
Light * filter_next_ptr ;
Light * next_ptr ;
Light * mask_next_ptr ;
RID light_internal ;
2019-07-10 20:44:55 +00:00
uint64_t version ;
2016-10-03 19:33:42 +00:00
2019-07-05 01:54:32 +00:00
int32_t render_index_cache ;
2016-10-03 19:33:42 +00:00
Light ( ) {
2019-07-10 20:44:55 +00:00
version = 0 ;
2017-03-05 15:44:50 +00:00
enabled = true ;
color = Color ( 1 , 1 , 1 ) ;
shadow_color = Color ( 0 , 0 , 0 , 0 ) ;
height = 0 ;
z_min = - 1024 ;
z_max = 1024 ;
layer_min = 0 ;
layer_max = 0 ;
item_mask = 1 ;
scale = 1.0 ;
energy = 1.0 ;
2020-05-30 08:05:33 +00:00
item_shadow_mask = 1 ;
2020-03-27 18:21:27 +00:00
mode = RS : : CANVAS_LIGHT_MODE_ADD ;
2020-04-01 23:20:12 +00:00
// texture_cache = nullptr;
next_ptr = nullptr ;
mask_next_ptr = nullptr ;
filter_next_ptr = nullptr ;
2019-07-05 01:54:32 +00:00
use_shadow = false ;
2019-01-17 13:40:36 +00:00
shadow_buffer_size = 2048 ;
2020-03-27 18:21:27 +00:00
shadow_filter = RS : : CANVAS_LIGHT_FILTER_NONE ;
2017-06-13 04:23:04 +00:00
shadow_smooth = 0.0 ;
2019-07-05 01:54:32 +00:00
render_index_cache = - 1 ;
2016-10-03 19:33:42 +00:00
}
} ;
2019-06-16 02:45:24 +00:00
typedef uint64_t TextureBindingID ;
2020-03-27 18:21:27 +00:00
virtual TextureBindingID request_texture_binding ( RID p_texture , RID p_normalmap , RID p_specular , RS : : CanvasItemTextureFilter p_filter , RS : : CanvasItemTextureRepeat p_repeat , RID p_multimesh ) = 0 ;
2019-06-16 02:45:24 +00:00
virtual void free_texture_binding ( TextureBindingID p_binding ) = 0 ;
//easier wrap to avoid mistakes
struct Item ;
struct TextureBinding {
TextureBindingID binding_id ;
2020-03-27 18:21:27 +00:00
_FORCE_INLINE_ void create ( RS : : CanvasItemTextureFilter p_item_filter , RS : : CanvasItemTextureRepeat p_item_repeat , RID p_texture , RID p_normalmap , RID p_specular , RS : : CanvasItemTextureFilter p_filter , RS : : CanvasItemTextureRepeat p_repeat , RID p_multimesh ) {
if ( p_filter = = RS : : CANVAS_ITEM_TEXTURE_FILTER_DEFAULT ) {
2019-06-16 02:45:24 +00:00
p_filter = p_item_filter ;
}
2020-03-27 18:21:27 +00:00
if ( p_repeat = = RS : : CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT ) {
2019-06-16 02:45:24 +00:00
p_repeat = p_item_repeat ;
}
2020-03-27 18:21:27 +00:00
if ( p_texture ! = RID ( ) | | p_normalmap ! = RID ( ) | | p_specular ! = RID ( ) | | p_filter ! = RS : : CANVAS_ITEM_TEXTURE_FILTER_DEFAULT | | p_repeat ! = RS : : CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT | | p_multimesh . is_valid ( ) ) {
2019-06-16 02:45:24 +00:00
ERR_FAIL_COND ( binding_id ! = 0 ) ;
binding_id = singleton - > request_texture_binding ( p_texture , p_normalmap , p_specular , p_filter , p_repeat , p_multimesh ) ;
}
}
_FORCE_INLINE_ TextureBinding ( ) { binding_id = 0 ; }
_FORCE_INLINE_ ~ TextureBinding ( ) {
2020-05-14 14:41:43 +00:00
if ( binding_id ) {
2020-05-10 10:56:01 +00:00
singleton - > free_texture_binding ( binding_id ) ;
2020-05-14 14:41:43 +00:00
}
2019-06-16 02:45:24 +00:00
}
} ;
2019-06-24 19:13:06 +00:00
typedef uint64_t PolygonID ;
virtual PolygonID request_polygon ( const Vector < int > & p_indices , const Vector < Point2 > & p_points , const Vector < Color > & p_colors , const Vector < Point2 > & p_uvs = Vector < Point2 > ( ) , const Vector < int > & p_bones = Vector < int > ( ) , const Vector < float > & p_weights = Vector < float > ( ) ) = 0 ;
virtual void free_polygon ( PolygonID p_polygon ) = 0 ;
//also easier to wrap to avoid mistakes
struct Polygon {
PolygonID polygon_id ;
Rect2 rect_cache ;
_FORCE_INLINE_ void create ( const Vector < int > & p_indices , const Vector < Point2 > & p_points , const Vector < Color > & p_colors , const Vector < Point2 > & p_uvs = Vector < Point2 > ( ) , const Vector < int > & p_bones = Vector < int > ( ) , const Vector < float > & p_weights = Vector < float > ( ) ) {
ERR_FAIL_COND ( polygon_id ! = 0 ) ;
{
uint32_t pc = p_points . size ( ) ;
const Vector2 * v2 = p_points . ptr ( ) ;
rect_cache . position = * v2 ;
for ( uint32_t i = 1 ; i < pc ; i + + ) {
rect_cache . expand_to ( v2 [ i ] ) ;
}
}
polygon_id = singleton - > request_polygon ( p_indices , p_points , p_colors , p_uvs , p_bones , p_weights ) ;
}
_FORCE_INLINE_ Polygon ( ) { polygon_id = 0 ; }
_FORCE_INLINE_ ~ Polygon ( ) {
2020-05-14 14:41:43 +00:00
if ( polygon_id ) {
2020-05-10 10:56:01 +00:00
singleton - > free_polygon ( polygon_id ) ;
2020-05-14 14:41:43 +00:00
}
2019-06-24 19:13:06 +00:00
}
} ;
//item
2019-06-10 15:38:51 +00:00
struct Item {
2019-06-26 22:48:05 +00:00
//commands are allocated in blocks of 4k to improve performance
//and cache coherence.
//blocks always grow but never shrink.
struct CommandBlock {
enum {
MAX_SIZE = 4096
} ;
uint32_t usage ;
uint8_t * memory ;
} ;
2016-10-03 19:33:42 +00:00
struct Command {
enum Type {
TYPE_RECT ,
TYPE_NINEPATCH ,
TYPE_POLYGON ,
2019-06-24 19:13:06 +00:00
TYPE_PRIMITIVE ,
2016-10-03 19:33:42 +00:00
TYPE_MESH ,
TYPE_MULTIMESH ,
2017-06-21 19:25:45 +00:00
TYPE_PARTICLES ,
2016-10-03 19:33:42 +00:00
TYPE_TRANSFORM ,
TYPE_CLIP_IGNORE ,
} ;
2019-06-26 22:48:05 +00:00
Command * next ;
2016-10-03 19:33:42 +00:00
Type type ;
2017-03-05 15:44:50 +00:00
virtual ~ Command ( ) { }
2016-10-03 19:33:42 +00:00
} ;
struct CommandRect : public Command {
Rect2 rect ;
Color modulate ;
Rect2 source ;
uint8_t flags ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2016-10-03 19:33:42 +00:00
2017-03-05 15:44:50 +00:00
CommandRect ( ) {
flags = 0 ;
type = TYPE_RECT ;
}
2016-10-03 19:33:42 +00:00
} ;
struct CommandNinePatch : public Command {
Rect2 rect ;
Rect2 source ;
float margin [ 4 ] ;
bool draw_center ;
Color color ;
2020-03-27 18:21:27 +00:00
RS : : NinePatchAxisMode axis_x ;
RS : : NinePatchAxisMode axis_y ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2017-03-05 15:44:50 +00:00
CommandNinePatch ( ) {
draw_center = true ;
type = TYPE_NINEPATCH ;
}
2016-10-03 19:33:42 +00:00
} ;
2019-06-24 19:13:06 +00:00
struct CommandPolygon : public Command {
2020-03-27 18:21:27 +00:00
RS : : PrimitiveType primitive ;
2019-06-24 19:13:06 +00:00
Polygon polygon ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2019-06-24 19:13:06 +00:00
CommandPolygon ( ) {
type = TYPE_POLYGON ;
2017-03-05 15:44:50 +00:00
}
2016-10-03 19:33:42 +00:00
} ;
2019-06-24 19:13:06 +00:00
struct CommandPrimitive : public Command {
uint32_t point_count ;
Vector2 points [ 4 ] ;
Vector2 uvs [ 4 ] ;
Color colors [ 4 ] ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2019-06-24 19:13:06 +00:00
CommandPrimitive ( ) {
type = TYPE_PRIMITIVE ;
2017-03-05 15:44:50 +00:00
}
2016-10-03 19:33:42 +00:00
} ;
struct CommandMesh : public Command {
RID mesh ;
2019-04-19 18:54:33 +00:00
Transform2D transform ;
Color modulate ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2017-03-05 15:44:50 +00:00
CommandMesh ( ) { type = TYPE_MESH ; }
2016-10-03 19:33:42 +00:00
} ;
struct CommandMultiMesh : public Command {
RID multimesh ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2017-03-05 15:44:50 +00:00
CommandMultiMesh ( ) { type = TYPE_MULTIMESH ; }
2016-10-03 19:33:42 +00:00
} ;
2017-06-21 19:25:45 +00:00
struct CommandParticles : public Command {
RID particles ;
2019-06-16 02:45:24 +00:00
Color specular_shininess ;
TextureBinding texture_binding ;
2017-06-21 19:25:45 +00:00
CommandParticles ( ) { type = TYPE_PARTICLES ; }
} ;
2016-10-03 19:33:42 +00:00
struct CommandTransform : public Command {
2017-01-11 03:52:51 +00:00
Transform2D xform ;
2016-10-03 19:33:42 +00:00
CommandTransform ( ) { type = TYPE_TRANSFORM ; }
} ;
struct CommandClipIgnore : public Command {
bool ignore ;
2017-03-05 15:44:50 +00:00
CommandClipIgnore ( ) {
type = TYPE_CLIP_IGNORE ;
ignore = false ;
}
2016-10-03 19:33:42 +00:00
} ;
struct ViewportRender {
2020-03-27 18:21:27 +00:00
RenderingServer * owner ;
2017-03-05 15:44:50 +00:00
void * udata ;
2016-10-03 19:33:42 +00:00
Rect2 rect ;
} ;
2017-01-11 03:52:51 +00:00
Transform2D xform ;
2016-10-03 19:33:42 +00:00
bool clip ;
bool visible ;
bool behind ;
2018-08-29 19:48:32 +00:00
bool update_when_visible ;
2020-03-27 18:21:27 +00:00
//RS::MaterialBlendMode blend_mode;
2016-10-03 19:33:42 +00:00
int light_mask ;
2019-06-26 18:11:52 +00:00
int z_final ;
2019-06-26 22:48:05 +00:00
2016-10-03 19:33:42 +00:00
mutable bool custom_rect ;
mutable bool rect_dirty ;
mutable Rect2 rect ;
RID material ;
2018-05-03 20:29:15 +00:00
RID skeleton ;
2017-03-05 15:44:50 +00:00
Item * next ;
2016-10-03 19:33:42 +00:00
struct CopyBackBuffer {
Rect2 rect ;
Rect2 screen_rect ;
bool full ;
} ;
CopyBackBuffer * copy_back_buffer ;
Color final_modulate ;
2017-01-11 03:52:51 +00:00
Transform2D final_transform ;
2016-10-03 19:33:42 +00:00
Rect2 final_clip_rect ;
2017-03-05 15:44:50 +00:00
Item * final_clip_owner ;
Item * material_owner ;
2016-10-03 19:33:42 +00:00
ViewportRender * vp_render ;
bool distance_field ;
bool light_masked ;
Rect2 global_rect_cache ;
2017-03-05 15:44:50 +00:00
const Rect2 & get_rect ( ) const {
2020-05-14 14:41:43 +00:00
if ( custom_rect | | ( ! rect_dirty & & ! update_when_visible ) ) {
2016-10-03 19:33:42 +00:00
return rect ;
2020-05-14 14:41:43 +00:00
}
2016-10-03 19:33:42 +00:00
//must update rect
2019-06-26 22:48:05 +00:00
2020-04-01 23:20:12 +00:00
if ( commands = = nullptr ) {
2017-03-05 15:44:50 +00:00
rect = Rect2 ( ) ;
rect_dirty = false ;
2016-10-03 19:33:42 +00:00
return rect ;
}
2017-01-11 03:52:51 +00:00
Transform2D xf ;
2017-03-05 15:44:50 +00:00
bool found_xform = false ;
bool first = true ;
2016-10-03 19:33:42 +00:00
2019-06-26 22:48:05 +00:00
const Item : : Command * c = commands ;
2016-10-03 19:33:42 +00:00
2019-06-26 22:48:05 +00:00
while ( c ) {
2016-10-03 19:33:42 +00:00
Rect2 r ;
2017-03-05 15:44:50 +00:00
switch ( c - > type ) {
2016-10-03 19:33:42 +00:00
case Item : : Command : : TYPE_RECT : {
2017-03-05 15:44:50 +00:00
const Item : : CommandRect * crect = static_cast < const Item : : CommandRect * > ( c ) ;
r = crect - > rect ;
2016-10-03 19:33:42 +00:00
} break ;
case Item : : Command : : TYPE_NINEPATCH : {
2017-03-05 15:44:50 +00:00
const Item : : CommandNinePatch * style = static_cast < const Item : : CommandNinePatch * > ( c ) ;
r = style - > rect ;
2016-10-03 19:33:42 +00:00
} break ;
case Item : : Command : : TYPE_POLYGON : {
2017-03-05 15:44:50 +00:00
const Item : : CommandPolygon * polygon = static_cast < const Item : : CommandPolygon * > ( c ) ;
2019-06-24 19:13:06 +00:00
r = polygon - > polygon . rect_cache ;
} break ;
case Item : : Command : : TYPE_PRIMITIVE : {
const Item : : CommandPrimitive * primitive = static_cast < const Item : : CommandPrimitive * > ( c ) ;
2019-07-05 01:54:32 +00:00
for ( uint32_t j = 0 ; j < primitive - > point_count ; j + + ) {
2019-06-24 19:13:06 +00:00
if ( j = = 0 ) {
r . position = primitive - > points [ 0 ] ;
} else {
r . expand_to ( primitive - > points [ j ] ) ;
}
2016-10-03 19:33:42 +00:00
}
} break ;
case Item : : Command : : TYPE_MESH : {
2017-03-05 15:44:50 +00:00
const Item : : CommandMesh * mesh = static_cast < const Item : : CommandMesh * > ( c ) ;
2018-02-21 20:23:27 +00:00
AABB aabb = RasterizerStorage : : base_singleton - > mesh_get_aabb ( mesh - > mesh , RID ( ) ) ;
2016-10-03 19:33:42 +00:00
2017-06-06 18:33:51 +00:00
r = Rect2 ( aabb . position . x , aabb . position . y , aabb . size . x , aabb . size . y ) ;
2016-10-03 19:33:42 +00:00
} break ;
case Item : : Command : : TYPE_MULTIMESH : {
2017-03-05 15:44:50 +00:00
const Item : : CommandMultiMesh * multimesh = static_cast < const Item : : CommandMultiMesh * > ( c ) ;
2017-11-17 02:09:00 +00:00
AABB aabb = RasterizerStorage : : base_singleton - > multimesh_get_aabb ( multimesh - > multimesh ) ;
2016-10-03 19:33:42 +00:00
2017-06-06 18:33:51 +00:00
r = Rect2 ( aabb . position . x , aabb . position . y , aabb . size . x , aabb . size . y ) ;
2016-10-03 19:33:42 +00:00
2017-06-21 19:25:45 +00:00
} break ;
case Item : : Command : : TYPE_PARTICLES : {
const Item : : CommandParticles * particles_cmd = static_cast < const Item : : CommandParticles * > ( c ) ;
if ( particles_cmd - > particles . is_valid ( ) ) {
2017-11-17 02:09:00 +00:00
AABB aabb = RasterizerStorage : : base_singleton - > particles_get_aabb ( particles_cmd - > particles ) ;
2017-06-21 19:25:45 +00:00
r = Rect2 ( aabb . position . x , aabb . position . y , aabb . size . x , aabb . size . y ) ;
}
2016-10-03 19:33:42 +00:00
} break ;
case Item : : Command : : TYPE_TRANSFORM : {
2017-03-05 15:44:50 +00:00
const Item : : CommandTransform * transform = static_cast < const Item : : CommandTransform * > ( c ) ;
xf = transform - > xform ;
found_xform = true ;
2020-02-22 19:47:50 +00:00
[[fallthrough]] ;
2020-02-13 14:53:32 +00:00
}
2019-06-26 22:48:05 +00:00
default : {
c = c - > next ;
continue ;
}
2016-10-03 19:33:42 +00:00
}
if ( found_xform ) {
r = xf . xform ( r ) ;
2017-03-05 15:44:50 +00:00
found_xform = false ;
2016-10-03 19:33:42 +00:00
}
if ( first ) {
2017-03-05 15:44:50 +00:00
rect = r ;
first = false ;
2019-06-26 22:48:05 +00:00
} else {
2017-03-05 15:44:50 +00:00
rect = rect . merge ( r ) ;
2019-06-26 22:48:05 +00:00
}
c = c - > next ;
2016-10-03 19:33:42 +00:00
}
2017-03-05 15:44:50 +00:00
rect_dirty = false ;
2016-10-03 19:33:42 +00:00
return rect ;
}
2019-06-26 22:48:05 +00:00
Command * commands ;
Command * last_command ;
Vector < CommandBlock > blocks ;
uint32_t current_block ;
template < class T >
T * alloc_command ( ) {
T * command ;
2020-04-01 23:20:12 +00:00
if ( commands = = nullptr ) {
2019-06-26 22:48:05 +00:00
// As the most common use case of canvas items is to
// use only one command, the first is done with it's
// own allocation. The rest of them use blocks.
command = memnew ( T ) ;
2020-04-01 23:20:12 +00:00
command - > next = nullptr ;
2019-06-26 22:48:05 +00:00
commands = command ;
last_command = command ;
} else {
//Subsequent commands go into a block.
while ( true ) {
if ( unlikely ( current_block = = ( uint32_t ) blocks . size ( ) ) ) {
// If we need more blocks, we allocate them
// (they won't be freed until this CanvasItem is
// deleted, though).
CommandBlock cb ;
cb . memory = ( uint8_t * ) memalloc ( CommandBlock : : MAX_SIZE ) ;
cb . usage = 0 ;
blocks . push_back ( cb ) ;
}
CommandBlock * c = & blocks . write [ current_block ] ;
size_t space_left = CommandBlock : : MAX_SIZE - c - > usage ;
if ( space_left < sizeof ( T ) ) {
current_block + + ;
continue ;
}
//allocate block and add to the linked list
void * memory = c - > memory + c - > usage ;
command = memnew_placement ( memory , T ) ;
2020-04-01 23:20:12 +00:00
command - > next = nullptr ;
2019-06-26 22:48:05 +00:00
last_command - > next = command ;
last_command = command ;
c - > usage + = sizeof ( T ) ;
break ;
}
}
rect_dirty = true ;
return command ;
}
2019-07-10 20:44:55 +00:00
struct CustomData {
virtual ~ CustomData ( ) { }
} ;
mutable CustomData * custom_data ; //implementation dependent
2017-03-05 15:44:50 +00:00
void clear ( ) {
2019-06-26 22:48:05 +00:00
Command * c = commands ;
while ( c ) {
Command * n = c - > next ;
if ( c = = commands ) {
memdelete ( commands ) ;
2020-04-01 23:20:12 +00:00
commands = nullptr ;
2019-06-26 22:48:05 +00:00
} else {
c - > ~ Command ( ) ;
}
c = n ;
}
{
2019-07-05 01:54:32 +00:00
uint32_t cbc = MIN ( ( current_block + 1 ) , ( uint32_t ) blocks . size ( ) ) ;
2019-06-26 22:48:05 +00:00
CommandBlock * blockptr = blocks . ptrw ( ) ;
for ( uint32_t i = 0 ; i < cbc ; i + + ) {
blockptr [ i ] . usage = 0 ;
}
}
2020-04-01 23:20:12 +00:00
last_command = nullptr ;
commands = nullptr ;
2019-06-26 22:48:05 +00:00
current_block = 0 ;
2017-03-05 15:44:50 +00:00
clip = false ;
rect_dirty = true ;
2020-04-01 23:20:12 +00:00
final_clip_owner = nullptr ;
material_owner = nullptr ;
2017-03-05 15:44:50 +00:00
light_masked = false ;
}
Item ( ) {
2020-04-01 23:20:12 +00:00
commands = nullptr ;
last_command = nullptr ;
2019-06-26 22:48:05 +00:00
current_block = 0 ;
2017-03-05 15:44:50 +00:00
light_mask = 1 ;
2020-04-01 23:20:12 +00:00
vp_render = nullptr ;
next = nullptr ;
final_clip_owner = nullptr ;
2017-03-05 15:44:50 +00:00
clip = false ;
final_modulate = Color ( 1 , 1 , 1 , 1 ) ;
visible = true ;
rect_dirty = true ;
custom_rect = false ;
behind = false ;
2020-04-01 23:20:12 +00:00
material_owner = nullptr ;
copy_back_buffer = nullptr ;
2017-03-05 15:44:50 +00:00
distance_field = false ;
light_masked = false ;
2018-08-29 19:48:32 +00:00
update_when_visible = false ;
2019-06-26 18:11:52 +00:00
z_final = 0 ;
2020-04-01 23:20:12 +00:00
custom_data = nullptr ;
2017-03-05 15:44:50 +00:00
}
virtual ~ Item ( ) {
clear ( ) ;
2019-06-26 22:48:05 +00:00
for ( int i = 0 ; i < blocks . size ( ) ; i + + ) {
memfree ( blocks [ i ] . memory ) ;
}
2020-05-14 14:41:43 +00:00
if ( copy_back_buffer ) {
2020-05-10 10:56:01 +00:00
memdelete ( copy_back_buffer ) ;
2020-05-14 14:41:43 +00:00
}
2019-07-10 20:44:55 +00:00
if ( custom_data ) {
memdelete ( custom_data ) ;
}
2017-03-05 15:44:50 +00:00
}
2016-10-03 19:33:42 +00:00
} ;
2019-06-24 19:13:06 +00:00
virtual void canvas_render_items ( RID p_to_render_target , Item * p_item_list , const Color & p_modulate , Light * p_light_list , const Transform2D & p_canvas_transform ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void canvas_debug_viewport_shadows ( Light * p_lights_with_shadow ) = 0 ;
2016-10-03 19:33:42 +00:00
2019-06-10 15:38:51 +00:00
struct LightOccluderInstance {
2016-10-03 19:33:42 +00:00
bool enabled ;
RID canvas ;
RID polygon ;
2019-07-05 01:54:32 +00:00
RID occluder ;
2016-10-03 19:33:42 +00:00
Rect2 aabb_cache ;
2017-01-11 03:52:51 +00:00
Transform2D xform ;
Transform2D xform_cache ;
2016-10-03 19:33:42 +00:00
int light_mask ;
2020-03-27 18:21:27 +00:00
RS : : CanvasOccluderPolygonCullMode cull_cache ;
2016-10-03 19:33:42 +00:00
LightOccluderInstance * next ;
2017-03-05 15:44:50 +00:00
LightOccluderInstance ( ) {
enabled = true ;
2020-04-01 23:20:12 +00:00
next = nullptr ;
2017-03-05 15:44:50 +00:00
light_mask = 1 ;
2020-03-27 18:21:27 +00:00
cull_cache = RS : : CANVAS_OCCLUDER_POLYGON_CULL_DISABLED ;
2017-03-05 15:44:50 +00:00
}
2016-10-03 19:33:42 +00:00
} ;
2019-07-05 01:54:32 +00:00
virtual RID light_create ( ) = 0 ;
virtual void light_set_texture ( RID p_rid , RID p_texture ) = 0 ;
virtual void light_set_use_shadow ( RID p_rid , bool p_enable , int p_resolution ) = 0 ;
virtual void light_update_shadow ( RID p_rid , const Transform2D & p_light_xform , int p_light_mask , float p_near , float p_far , LightOccluderInstance * p_occluders ) = 0 ;
2016-10-03 19:33:42 +00:00
2019-07-05 01:54:32 +00:00
virtual RID occluder_polygon_create ( ) = 0 ;
2020-02-17 21:06:54 +00:00
virtual void occluder_polygon_set_shape_as_lines ( RID p_occluder , const Vector < Vector2 > & p_lines ) = 0 ;
2020-03-27 18:21:27 +00:00
virtual void occluder_polygon_set_cull_mode ( RID p_occluder , RS : : CanvasOccluderPolygonCullMode p_mode ) = 0 ;
2016-10-03 19:33:42 +00:00
2017-08-07 21:06:57 +00:00
virtual void draw_window_margins ( int * p_margins , RID * p_margin_textures ) = 0 ;
2019-07-05 01:54:32 +00:00
virtual bool free ( RID p_rid ) = 0 ;
2019-06-16 02:45:24 +00:00
virtual void update ( ) = 0 ;
RasterizerCanvas ( ) { singleton = this ; }
2016-10-03 19:33:42 +00:00
virtual ~ RasterizerCanvas ( ) { }
} ;
class Rasterizer {
protected :
2017-03-05 15:44:50 +00:00
static Rasterizer * ( * _create_func ) ( ) ;
2016-10-03 19:33:42 +00:00
public :
static Rasterizer * create ( ) ;
2017-03-05 15:44:50 +00:00
virtual RasterizerStorage * get_storage ( ) = 0 ;
virtual RasterizerCanvas * get_canvas ( ) = 0 ;
virtual RasterizerScene * get_scene ( ) = 0 ;
2016-10-03 19:33:42 +00:00
2019-06-13 20:37:19 +00:00
virtual void set_boot_image ( const Ref < Image > & p_image , const Color & p_color , bool p_scale , bool p_use_filter = true ) = 0 ;
2017-04-09 23:02:04 +00:00
2017-03-05 15:44:50 +00:00
virtual void initialize ( ) = 0 ;
2018-05-09 06:11:43 +00:00
virtual void begin_frame ( double frame_step ) = 0 ;
2019-06-16 02:45:24 +00:00
struct BlitToScreen {
RID render_target ;
Rect2i rect ;
//lens distorted parameters for VR should go here
} ;
2019-06-24 19:13:06 +00:00
virtual void prepare_for_blitting_render_targets ( ) = 0 ;
2020-03-04 01:51:12 +00:00
virtual void blit_render_targets_to_screen ( DisplayServer : : WindowID p_screen , const BlitToScreen * p_render_targets , int p_amount ) = 0 ;
2019-06-16 02:45:24 +00:00
2017-10-30 20:33:36 +00:00
virtual void end_frame ( bool p_swap_buffers ) = 0 ;
2017-03-05 15:44:50 +00:00
virtual void finalize ( ) = 0 ;
2020-05-01 12:34:23 +00:00
virtual uint64_t get_frame_number ( ) const = 0 ;
virtual float get_frame_delta_time ( ) const = 0 ;
2016-10-03 19:33:42 +00:00
2018-09-28 23:32:40 +00:00
virtual bool is_low_end ( ) const = 0 ;
2016-10-03 19:33:42 +00:00
virtual ~ Rasterizer ( ) { }
} ;
2017-08-27 19:07:15 +00:00
# endif // RASTERIZER_H