rasterizer.h 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411
  1. /*************************************************************************/
  2. /* rasterizer.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef RASTERIZER_H
  31. #define RASTERIZER_H
  32. #include "core/math/camera_matrix.h"
  33. #include "core/pair.h"
  34. #include "core/self_list.h"
  35. #include "servers/rendering_server.h"
  36. class RasterizerScene {
  37. public:
  38. /* SHADOW ATLAS API */
  39. virtual RID shadow_atlas_create() = 0;
  40. virtual void shadow_atlas_set_size(RID p_atlas, int p_size) = 0;
  41. virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
  42. virtual bool shadow_atlas_update_light(RID p_atlas, RID p_light_intance, float p_coverage, uint64_t p_light_version) = 0;
  43. virtual void directional_shadow_atlas_set_size(int p_size) = 0;
  44. virtual int get_directional_light_shadow_size(RID p_light_intance) = 0;
  45. virtual void set_directional_shadow_count(int p_count) = 0;
  46. /* SDFGI UPDATE */
  47. struct InstanceBase;
  48. virtual void sdfgi_update(RID p_render_buffers, RID p_environment, const Vector3 &p_world_position) = 0;
  49. virtual int sdfgi_get_pending_region_count(RID p_render_buffers) const = 0;
  50. virtual AABB sdfgi_get_pending_region_bounds(RID p_render_buffers, int p_region) const = 0;
  51. virtual uint32_t sdfgi_get_pending_region_cascade(RID p_render_buffers, int p_region) const = 0;
  52. 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;
  53. /* SKY API */
  54. virtual RID sky_create() = 0;
  55. virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
  56. virtual void sky_set_mode(RID p_sky, RS::SkyMode p_samples) = 0;
  57. virtual void sky_set_material(RID p_sky, RID p_material) = 0;
  58. virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
  59. /* ENVIRONMENT API */
  60. virtual RID environment_create() = 0;
  61. virtual void environment_set_background(RID p_env, RS::EnvironmentBG p_bg) = 0;
  62. virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
  63. virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
  64. virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
  65. virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
  66. virtual void environment_set_bg_energy(RID p_env, float p_energy) = 0;
  67. virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
  68. 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;
  69. // FIXME: Disabled during Vulkan refactoring, should be ported.
  70. #if 0
  71. virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;
  72. #endif
  73. virtual void environment_set_glow(RID p_env, bool p_enable, int p_level_flags, 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;
  74. virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
  75. virtual void environment_glow_set_use_high_quality(bool p_enable) = 0;
  76. 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;
  77. virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
  78. virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
  79. virtual void environment_set_volumetric_fog_directional_shadow_shrink_size(int p_shrink_size) = 0;
  80. virtual void environment_set_volumetric_fog_positional_shadow_shrink_size(int p_shrink_size) = 0;
  81. 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;
  82. virtual void environment_set_ssr_roughness_quality(RS::EnvironmentSSRRoughnessQuality p_quality) = 0;
  83. 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;
  84. virtual void environment_set_ssao_quality(RS::EnvironmentSSAOQuality p_quality, bool p_half_size) = 0;
  85. 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;
  86. virtual void environment_set_sdfgi_ray_count(RS::EnvironmentSDFGIRayCount p_ray_count) = 0;
  87. virtual void environment_set_sdfgi_frames_to_converge(RS::EnvironmentSDFGIFramesToConverge p_frames) = 0;
  88. 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;
  89. virtual void environment_set_adjustment(RID p_env, bool p_enable, float p_brightness, float p_contrast, float p_saturation, RID p_ramp) = 0;
  90. 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) = 0;
  91. virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
  92. virtual bool is_environment(RID p_env) const = 0;
  93. virtual RS::EnvironmentBG environment_get_background(RID p_env) const = 0;
  94. virtual int environment_get_canvas_max_layer(RID p_env) const = 0;
  95. virtual RID camera_effects_create() = 0;
  96. virtual void camera_effects_set_dof_blur_quality(RS::DOFBlurQuality p_quality, bool p_use_jitter) = 0;
  97. virtual void camera_effects_set_dof_blur_bokeh_shape(RS::DOFBokehShape p_shape) = 0;
  98. 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;
  99. virtual void camera_effects_set_custom_exposure(RID p_camera_effects, bool p_enable, float p_exposure) = 0;
  100. virtual void shadows_quality_set(RS::ShadowQuality p_quality) = 0;
  101. virtual void directional_shadow_quality_set(RS::ShadowQuality p_quality) = 0;
  102. struct InstanceDependency {
  103. void instance_notify_changed(bool p_aabb, bool p_dependencies);
  104. void instance_notify_deleted(RID p_deleted);
  105. ~InstanceDependency();
  106. private:
  107. friend struct InstanceBase;
  108. Map<InstanceBase *, uint32_t> instances;
  109. };
  110. struct InstanceBase {
  111. RS::InstanceType base_type;
  112. RID base;
  113. RID skeleton;
  114. RID material_override;
  115. RID instance_data;
  116. Transform transform;
  117. int depth_layer;
  118. uint32_t layer_mask;
  119. uint32_t instance_version;
  120. //RID sampled_light;
  121. Vector<RID> materials;
  122. Vector<RID> light_instances;
  123. Vector<RID> reflection_probe_instances;
  124. Vector<RID> gi_probe_instances;
  125. Vector<float> blend_values;
  126. RS::ShadowCastingSetting cast_shadows;
  127. //fit in 32 bits
  128. bool mirror : 8;
  129. bool receive_shadows : 8;
  130. bool visible : 8;
  131. bool baked_light : 2; //this flag is only to know if it actually did use baked light
  132. bool dynamic_gi : 2; //this flag is only to know if it actually did use baked light
  133. bool redraw_if_visible : 4;
  134. float depth; //used for sorting
  135. SelfList<InstanceBase> dependency_item;
  136. InstanceBase *lightmap;
  137. Rect2 lightmap_uv_scale;
  138. int lightmap_slice_index;
  139. uint32_t lightmap_cull_index;
  140. Vector<Color> lightmap_sh; //spherical harmonic
  141. AABB aabb;
  142. AABB transformed_aabb;
  143. struct InstanceShaderParameter {
  144. int32_t index = -1;
  145. Variant value;
  146. Variant default_value;
  147. PropertyInfo info;
  148. };
  149. Map<StringName, InstanceShaderParameter> instance_shader_parameters;
  150. bool instance_allocated_shader_parameters = false;
  151. int32_t instance_allocated_shader_parameters_offset = -1;
  152. virtual void dependency_deleted(RID p_dependency) {}
  153. virtual void dependency_changed(bool p_aabb, bool p_dependencies) {}
  154. Set<InstanceDependency *> dependencies;
  155. void instance_increase_version() {
  156. instance_version++;
  157. }
  158. void update_dependency(InstanceDependency *p_dependency) {
  159. dependencies.insert(p_dependency);
  160. p_dependency->instances[this] = instance_version;
  161. }
  162. void clean_up_dependencies() {
  163. List<Pair<InstanceDependency *, Map<InstanceBase *, uint32_t>::Element *>> to_clean_up;
  164. for (Set<InstanceDependency *>::Element *E = dependencies.front(); E; E = E->next()) {
  165. InstanceDependency *dep = E->get();
  166. Map<InstanceBase *, uint32_t>::Element *F = dep->instances.find(this);
  167. ERR_CONTINUE(!F);
  168. if (F->get() != instance_version) {
  169. Pair<InstanceDependency *, Map<InstanceBase *, uint32_t>::Element *> p;
  170. p.first = dep;
  171. p.second = F;
  172. to_clean_up.push_back(p);
  173. }
  174. }
  175. while (to_clean_up.size()) {
  176. to_clean_up.front()->get().first->instances.erase(to_clean_up.front()->get().second);
  177. to_clean_up.pop_front();
  178. }
  179. }
  180. void clear_dependencies() {
  181. for (Set<InstanceDependency *>::Element *E = dependencies.front(); E; E = E->next()) {
  182. InstanceDependency *dep = E->get();
  183. dep->instances.erase(this);
  184. }
  185. dependencies.clear();
  186. }
  187. InstanceBase() :
  188. dependency_item(this) {
  189. base_type = RS::INSTANCE_NONE;
  190. cast_shadows = RS::SHADOW_CASTING_SETTING_ON;
  191. receive_shadows = true;
  192. visible = true;
  193. depth_layer = 0;
  194. layer_mask = 1;
  195. instance_version = 0;
  196. baked_light = false;
  197. dynamic_gi = false;
  198. redraw_if_visible = false;
  199. lightmap_slice_index = 0;
  200. lightmap = nullptr;
  201. lightmap_cull_index = 0;
  202. }
  203. virtual ~InstanceBase() {
  204. clear_dependencies();
  205. }
  206. };
  207. virtual RID light_instance_create(RID p_light) = 0;
  208. virtual void light_instance_set_transform(RID p_light_instance, const Transform &p_transform) = 0;
  209. virtual void light_instance_set_aabb(RID p_light_instance, const AABB &p_aabb) = 0;
  210. 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;
  211. virtual void light_instance_mark_visible(RID p_light_instance) = 0;
  212. virtual bool light_instances_can_render_shadow_cube() const {
  213. return true;
  214. }
  215. virtual RID reflection_atlas_create() = 0;
  216. virtual void reflection_atlas_set_size(RID p_ref_atlas, int p_reflection_size, int p_reflection_count) = 0;
  217. virtual RID reflection_probe_instance_create(RID p_probe) = 0;
  218. virtual void reflection_probe_instance_set_transform(RID p_instance, const Transform &p_transform) = 0;
  219. virtual void reflection_probe_release_atlas_index(RID p_instance) = 0;
  220. virtual bool reflection_probe_instance_needs_redraw(RID p_instance) = 0;
  221. virtual bool reflection_probe_instance_has_reflection(RID p_instance) = 0;
  222. virtual bool reflection_probe_instance_begin_render(RID p_instance, RID p_reflection_atlas) = 0;
  223. virtual bool reflection_probe_instance_postprocess_step(RID p_instance) = 0;
  224. virtual RID decal_instance_create(RID p_decal) = 0;
  225. virtual void decal_instance_set_transform(RID p_decal, const Transform &p_transform) = 0;
  226. virtual RID gi_probe_instance_create(RID p_gi_probe) = 0;
  227. virtual void gi_probe_instance_set_transform_to_data(RID p_probe, const Transform &p_xform) = 0;
  228. virtual bool gi_probe_needs_update(RID p_probe) const = 0;
  229. 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;
  230. virtual void gi_probe_set_quality(RS::GIProbeQuality) = 0;
  231. 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;
  232. virtual void render_shadow(RID p_light, RID p_shadow_atlas, int p_pass, InstanceBase **p_cull_result, int p_cull_count) = 0;
  233. 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;
  234. virtual void render_sdfgi(RID p_render_buffers, int p_region, InstanceBase **p_cull_result, int p_cull_count) = 0;
  235. 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;
  236. virtual void render_particle_collider_heightfield(RID p_collider, const Transform &p_transform, InstanceBase **p_cull_result, int p_cull_count) = 0;
  237. virtual void set_scene_pass(uint64_t p_pass) = 0;
  238. virtual void set_time(double p_time, double p_step) = 0;
  239. virtual void set_debug_draw_mode(RS::ViewportDebugDraw p_debug_draw) = 0;
  240. virtual RID render_buffers_create() = 0;
  241. 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) = 0;
  242. virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
  243. virtual bool screen_space_roughness_limiter_is_active() const = 0;
  244. virtual void sub_surface_scattering_set_quality(RS::SubSurfaceScatteringQuality p_quality) = 0;
  245. virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
  246. virtual TypedArray<Image> bake_render_uv2(RID p_base, const Vector<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
  247. virtual bool free(RID p_rid) = 0;
  248. virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
  249. virtual void update() = 0;
  250. virtual ~RasterizerScene() {}
  251. };
  252. class RasterizerStorage {
  253. Color default_clear_color;
  254. public:
  255. /* TEXTURE API */
  256. virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
  257. virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, RS::TextureLayeredType p_layered_type) = 0;
  258. 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;
  259. virtual RID texture_proxy_create(RID p_base) = 0; //all slices, then all the mipmaps, must be coherent
  260. 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
  261. virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
  262. virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
  263. virtual void texture_proxy_update(RID p_proxy, RID p_base) = 0;
  264. //these two APIs can be used together or in combination with the others.
  265. virtual RID texture_2d_placeholder_create() = 0;
  266. virtual RID texture_2d_layered_placeholder_create(RenderingServer::TextureLayeredType p_layered_type) = 0;
  267. virtual RID texture_3d_placeholder_create() = 0;
  268. virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
  269. virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
  270. virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
  271. virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
  272. virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
  273. // FIXME: Disabled during Vulkan refactoring, should be ported.
  274. #if 0
  275. virtual void texture_bind(RID p_texture, uint32_t p_texture_no) = 0;
  276. #endif
  277. virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
  278. virtual String texture_get_path(RID p_texture) const = 0;
  279. virtual void texture_set_detect_3d_callback(RID p_texture, RS::TextureDetectCallback p_callback, void *p_userdata) = 0;
  280. virtual void texture_set_detect_normal_callback(RID p_texture, RS::TextureDetectCallback p_callback, void *p_userdata) = 0;
  281. virtual void texture_set_detect_roughness_callback(RID p_texture, RS::TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
  282. virtual void texture_debug_usage(List<RS::TextureInfo> *r_info) = 0;
  283. virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
  284. virtual Size2 texture_size_with_proxy(RID p_proxy) = 0;
  285. virtual void texture_add_to_decal_atlas(RID p_texture, bool p_panorama_to_dp = false) = 0;
  286. virtual void texture_remove_from_decal_atlas(RID p_texture, bool p_panorama_to_dp = false) = 0;
  287. /* SHADER API */
  288. virtual RID shader_create() = 0;
  289. virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
  290. virtual String shader_get_code(RID p_shader) const = 0;
  291. virtual void shader_get_param_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
  292. virtual void shader_set_default_texture_param(RID p_shader, const StringName &p_name, RID p_texture) = 0;
  293. virtual RID shader_get_default_texture_param(RID p_shader, const StringName &p_name) const = 0;
  294. virtual Variant shader_get_param_default(RID p_material, const StringName &p_param) const = 0;
  295. /* COMMON MATERIAL API */
  296. virtual RID material_create() = 0;
  297. virtual void material_set_render_priority(RID p_material, int priority) = 0;
  298. virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
  299. virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
  300. virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
  301. virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
  302. virtual bool material_is_animated(RID p_material) = 0;
  303. virtual bool material_casts_shadows(RID p_material) = 0;
  304. struct InstanceShaderParam {
  305. PropertyInfo info;
  306. int index;
  307. Variant default_value;
  308. };
  309. virtual void material_get_instance_shader_parameters(RID p_material, List<InstanceShaderParam> *r_parameters) = 0;
  310. virtual void material_update_dependency(RID p_material, RasterizerScene::InstanceBase *p_instance) = 0;
  311. /* MESH API */
  312. virtual RID mesh_create() = 0;
  313. /// Returns stride
  314. virtual void mesh_add_surface(RID p_mesh, const RS::SurfaceData &p_surface) = 0;
  315. virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
  316. virtual void mesh_set_blend_shape_mode(RID p_mesh, RS::BlendShapeMode p_mode) = 0;
  317. virtual RS::BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
  318. virtual void mesh_surface_update_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  319. virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
  320. virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
  321. virtual RS::SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
  322. virtual int mesh_get_surface_count(RID p_mesh) const = 0;
  323. virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
  324. virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
  325. virtual AABB mesh_get_aabb(RID p_mesh, RID p_skeleton = RID()) = 0;
  326. virtual void mesh_clear(RID p_mesh) = 0;
  327. /* MULTIMESH API */
  328. virtual RID multimesh_create() = 0;
  329. 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;
  330. virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
  331. virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
  332. virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform &p_transform) = 0;
  333. virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
  334. virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
  335. virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
  336. virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
  337. virtual Transform multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
  338. virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
  339. virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
  340. virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
  341. virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
  342. virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
  343. virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
  344. virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
  345. virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
  346. /* IMMEDIATE API */
  347. virtual RID immediate_create() = 0;
  348. virtual void immediate_begin(RID p_immediate, RS::PrimitiveType p_rimitive, RID p_texture = RID()) = 0;
  349. virtual void immediate_vertex(RID p_immediate, const Vector3 &p_vertex) = 0;
  350. virtual void immediate_normal(RID p_immediate, const Vector3 &p_normal) = 0;
  351. virtual void immediate_tangent(RID p_immediate, const Plane &p_tangent) = 0;
  352. virtual void immediate_color(RID p_immediate, const Color &p_color) = 0;
  353. virtual void immediate_uv(RID p_immediate, const Vector2 &tex_uv) = 0;
  354. virtual void immediate_uv2(RID p_immediate, const Vector2 &tex_uv) = 0;
  355. virtual void immediate_end(RID p_immediate) = 0;
  356. virtual void immediate_clear(RID p_immediate) = 0;
  357. virtual void immediate_set_material(RID p_immediate, RID p_material) = 0;
  358. virtual RID immediate_get_material(RID p_immediate) const = 0;
  359. virtual AABB immediate_get_aabb(RID p_immediate) const = 0;
  360. /* SKELETON API */
  361. virtual RID skeleton_create() = 0;
  362. virtual void skeleton_allocate(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
  363. virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
  364. virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform &p_transform) = 0;
  365. virtual Transform skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
  366. virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
  367. virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
  368. virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
  369. /* Light API */
  370. virtual RID light_create(RS::LightType p_type) = 0;
  371. RID directional_light_create() { return light_create(RS::LIGHT_DIRECTIONAL); }
  372. RID omni_light_create() { return light_create(RS::LIGHT_OMNI); }
  373. RID spot_light_create() { return light_create(RS::LIGHT_SPOT); }
  374. virtual void light_set_color(RID p_light, const Color &p_color) = 0;
  375. virtual void light_set_param(RID p_light, RS::LightParam p_param, float p_value) = 0;
  376. virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
  377. virtual void light_set_shadow_color(RID p_light, const Color &p_color) = 0;
  378. virtual void light_set_projector(RID p_light, RID p_texture) = 0;
  379. virtual void light_set_negative(RID p_light, bool p_enable) = 0;
  380. virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
  381. virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
  382. virtual void light_set_bake_mode(RID p_light, RS::LightBakeMode p_bake_mode) = 0;
  383. virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
  384. virtual void light_omni_set_shadow_mode(RID p_light, RS::LightOmniShadowMode p_mode) = 0;
  385. virtual void light_directional_set_shadow_mode(RID p_light, RS::LightDirectionalShadowMode p_mode) = 0;
  386. virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
  387. virtual bool light_directional_get_blend_splits(RID p_light) const = 0;
  388. virtual void light_directional_set_shadow_depth_range_mode(RID p_light, RS::LightDirectionalShadowDepthRangeMode p_range_mode) = 0;
  389. virtual RS::LightDirectionalShadowDepthRangeMode light_directional_get_shadow_depth_range_mode(RID p_light) const = 0;
  390. virtual RS::LightDirectionalShadowMode light_directional_get_shadow_mode(RID p_light) = 0;
  391. virtual RS::LightOmniShadowMode light_omni_get_shadow_mode(RID p_light) = 0;
  392. virtual bool light_has_shadow(RID p_light) const = 0;
  393. virtual RS::LightType light_get_type(RID p_light) const = 0;
  394. virtual AABB light_get_aabb(RID p_light) const = 0;
  395. virtual float light_get_param(RID p_light, RS::LightParam p_param) = 0;
  396. virtual Color light_get_color(RID p_light) = 0;
  397. virtual RS::LightBakeMode light_get_bake_mode(RID p_light) = 0;
  398. virtual uint32_t light_get_max_sdfgi_cascade(RID p_light) = 0;
  399. virtual uint64_t light_get_version(RID p_light) const = 0;
  400. /* PROBE API */
  401. virtual RID reflection_probe_create() = 0;
  402. virtual void reflection_probe_set_update_mode(RID p_probe, RS::ReflectionProbeUpdateMode p_mode) = 0;
  403. virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
  404. virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
  405. virtual void reflection_probe_set_ambient_mode(RID p_probe, RS::ReflectionProbeAmbientMode p_mode) = 0;
  406. virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
  407. virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
  408. virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
  409. virtual void reflection_probe_set_extents(RID p_probe, const Vector3 &p_extents) = 0;
  410. virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
  411. virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
  412. virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
  413. virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
  414. virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
  415. virtual AABB reflection_probe_get_aabb(RID p_probe) const = 0;
  416. virtual RS::ReflectionProbeUpdateMode reflection_probe_get_update_mode(RID p_probe) const = 0;
  417. virtual uint32_t reflection_probe_get_cull_mask(RID p_probe) const = 0;
  418. virtual Vector3 reflection_probe_get_extents(RID p_probe) const = 0;
  419. virtual Vector3 reflection_probe_get_origin_offset(RID p_probe) const = 0;
  420. virtual float reflection_probe_get_origin_max_distance(RID p_probe) const = 0;
  421. virtual bool reflection_probe_renders_shadows(RID p_probe) const = 0;
  422. virtual void base_update_dependency(RID p_base, RasterizerScene::InstanceBase *p_instance) = 0;
  423. virtual void skeleton_update_dependency(RID p_base, RasterizerScene::InstanceBase *p_instance) = 0;
  424. /* DECAL API */
  425. virtual RID decal_create() = 0;
  426. virtual void decal_set_extents(RID p_decal, const Vector3 &p_extents) = 0;
  427. virtual void decal_set_texture(RID p_decal, RS::DecalTexture p_type, RID p_texture) = 0;
  428. virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
  429. virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
  430. virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
  431. virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
  432. virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
  433. virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
  434. virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
  435. virtual AABB decal_get_aabb(RID p_decal) const = 0;
  436. /* GI PROBE API */
  437. virtual RID gi_probe_create() = 0;
  438. 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;
  439. virtual AABB gi_probe_get_bounds(RID p_gi_probe) const = 0;
  440. virtual Vector3i gi_probe_get_octree_size(RID p_gi_probe) const = 0;
  441. virtual Vector<uint8_t> gi_probe_get_octree_cells(RID p_gi_probe) const = 0;
  442. virtual Vector<uint8_t> gi_probe_get_data_cells(RID p_gi_probe) const = 0;
  443. virtual Vector<uint8_t> gi_probe_get_distance_field(RID p_gi_probe) const = 0;
  444. virtual Vector<int> gi_probe_get_level_counts(RID p_gi_probe) const = 0;
  445. virtual Transform gi_probe_get_to_cell_xform(RID p_gi_probe) const = 0;
  446. virtual void gi_probe_set_dynamic_range(RID p_gi_probe, float p_range) = 0;
  447. virtual float gi_probe_get_dynamic_range(RID p_gi_probe) const = 0;
  448. virtual void gi_probe_set_propagation(RID p_gi_probe, float p_range) = 0;
  449. virtual float gi_probe_get_propagation(RID p_gi_probe) const = 0;
  450. virtual void gi_probe_set_energy(RID p_gi_probe, float p_energy) = 0;
  451. virtual float gi_probe_get_energy(RID p_gi_probe) const = 0;
  452. virtual void gi_probe_set_ao(RID p_gi_probe, float p_ao) = 0;
  453. virtual float gi_probe_get_ao(RID p_gi_probe) const = 0;
  454. virtual void gi_probe_set_ao_size(RID p_gi_probe, float p_strength) = 0;
  455. virtual float gi_probe_get_ao_size(RID p_gi_probe) const = 0;
  456. virtual void gi_probe_set_bias(RID p_gi_probe, float p_bias) = 0;
  457. virtual float gi_probe_get_bias(RID p_gi_probe) const = 0;
  458. virtual void gi_probe_set_normal_bias(RID p_gi_probe, float p_range) = 0;
  459. virtual float gi_probe_get_normal_bias(RID p_gi_probe) const = 0;
  460. virtual void gi_probe_set_interior(RID p_gi_probe, bool p_enable) = 0;
  461. virtual bool gi_probe_is_interior(RID p_gi_probe) const = 0;
  462. virtual void gi_probe_set_use_two_bounces(RID p_gi_probe, bool p_enable) = 0;
  463. virtual bool gi_probe_is_using_two_bounces(RID p_gi_probe) const = 0;
  464. virtual void gi_probe_set_anisotropy_strength(RID p_gi_probe, float p_strength) = 0;
  465. virtual float gi_probe_get_anisotropy_strength(RID p_gi_probe) const = 0;
  466. virtual uint32_t gi_probe_get_version(RID p_probe) = 0;
  467. /* LIGHTMAP CAPTURE */
  468. virtual RID lightmap_create() = 0;
  469. virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
  470. virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
  471. virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
  472. 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;
  473. virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
  474. virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
  475. virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
  476. virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
  477. virtual AABB lightmap_get_aabb(RID p_lightmap) const = 0;
  478. virtual void lightmap_tap_sh_light(RID p_lightmap, const Vector3 &p_point, Color *r_sh) = 0;
  479. virtual bool lightmap_is_interior(RID p_lightmap) const = 0;
  480. virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
  481. virtual float lightmap_get_probe_capture_update_speed() const = 0;
  482. /* PARTICLES */
  483. virtual RID particles_create() = 0;
  484. virtual void particles_set_emitting(RID p_particles, bool p_emitting) = 0;
  485. virtual bool particles_get_emitting(RID p_particles) = 0;
  486. virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
  487. virtual void particles_set_lifetime(RID p_particles, float p_lifetime) = 0;
  488. virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
  489. virtual void particles_set_pre_process_time(RID p_particles, float p_time) = 0;
  490. virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
  491. virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
  492. virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
  493. virtual void particles_set_speed_scale(RID p_particles, float p_scale) = 0;
  494. virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
  495. virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
  496. virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
  497. virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
  498. virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
  499. virtual void particles_restart(RID p_particles) = 0;
  500. 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;
  501. virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
  502. virtual bool particles_is_inactive(RID p_particles) const = 0;
  503. virtual void particles_set_draw_order(RID p_particles, RS::ParticlesDrawOrder p_order) = 0;
  504. virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
  505. virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
  506. virtual void particles_request_process(RID p_particles) = 0;
  507. virtual AABB particles_get_current_aabb(RID p_particles) = 0;
  508. virtual AABB particles_get_aabb(RID p_particles) const = 0;
  509. virtual void particles_set_emission_transform(RID p_particles, const Transform &p_transform) = 0;
  510. virtual int particles_get_draw_passes(RID p_particles) const = 0;
  511. virtual RID particles_get_draw_pass_mesh(RID p_particles, int p_pass) const = 0;
  512. virtual void particles_set_view_axis(RID p_particles, const Vector3 &p_axis) = 0;
  513. virtual void particles_add_collision(RID p_particles, RasterizerScene::InstanceBase *p_instance) = 0;
  514. virtual void particles_remove_collision(RID p_particles, RasterizerScene::InstanceBase *p_instance) = 0;
  515. virtual void update_particles() = 0;
  516. /* PARTICLES COLLISION */
  517. virtual RID particles_collision_create() = 0;
  518. virtual void particles_collision_set_collision_type(RID p_particles_collision, RS::ParticlesCollisionType p_type) = 0;
  519. virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
  520. virtual void particles_collision_set_sphere_radius(RID p_particles_collision, float p_radius) = 0; //for spheres
  521. virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; //for non-spheres
  522. virtual void particles_collision_set_attractor_strength(RID p_particles_collision, float p_strength) = 0;
  523. virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, float p_directionality) = 0;
  524. virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, float p_curve) = 0;
  525. virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; //for SDF and vector field, heightfield is dynamic
  526. virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; //for SDF and vector field
  527. virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, RS::ParticlesCollisionHeightfieldResolution p_resolution) = 0; //for SDF and vector field
  528. virtual AABB particles_collision_get_aabb(RID p_particles_collision) const = 0;
  529. virtual bool particles_collision_is_heightfield(RID p_particles_collision) const = 0;
  530. virtual RID particles_collision_get_heightfield_framebuffer(RID p_particles_collision) const = 0;
  531. /* GLOBAL VARIABLES */
  532. virtual void global_variable_add(const StringName &p_name, RS::GlobalVariableType p_type, const Variant &p_value) = 0;
  533. virtual void global_variable_remove(const StringName &p_name) = 0;
  534. virtual Vector<StringName> global_variable_get_list() const = 0;
  535. virtual void global_variable_set(const StringName &p_name, const Variant &p_value) = 0;
  536. virtual void global_variable_set_override(const StringName &p_name, const Variant &p_value) = 0;
  537. virtual Variant global_variable_get(const StringName &p_name) const = 0;
  538. virtual RS::GlobalVariableType global_variable_get_type(const StringName &p_name) const = 0;
  539. virtual void global_variables_load_settings(bool p_load_textures = true) = 0;
  540. virtual void global_variables_clear() = 0;
  541. virtual int32_t global_variables_instance_allocate(RID p_instance) = 0;
  542. virtual void global_variables_instance_free(RID p_instance) = 0;
  543. virtual void global_variables_instance_update(RID p_instance, int p_index, const Variant &p_value) = 0;
  544. /* RENDER TARGET */
  545. enum RenderTargetFlags {
  546. RENDER_TARGET_TRANSPARENT,
  547. RENDER_TARGET_DIRECT_TO_SCREEN,
  548. RENDER_TARGET_FLAG_MAX
  549. };
  550. virtual RID render_target_create() = 0;
  551. virtual void render_target_set_position(RID p_render_target, int p_x, int p_y) = 0;
  552. virtual void render_target_set_size(RID p_render_target, int p_width, int p_height) = 0;
  553. virtual RID render_target_get_texture(RID p_render_target) = 0;
  554. virtual void render_target_set_external_texture(RID p_render_target, unsigned int p_texture_id) = 0;
  555. virtual void render_target_set_flag(RID p_render_target, RenderTargetFlags p_flag, bool p_value) = 0;
  556. virtual bool render_target_was_used(RID p_render_target) = 0;
  557. virtual void render_target_set_as_unused(RID p_render_target) = 0;
  558. virtual void render_target_request_clear(RID p_render_target, const Color &p_clear_color) = 0;
  559. virtual bool render_target_is_clear_requested(RID p_render_target) = 0;
  560. virtual Color render_target_get_clear_request_color(RID p_render_target) = 0;
  561. virtual void render_target_disable_clear_request(RID p_render_target) = 0;
  562. virtual void render_target_do_clear_request(RID p_render_target) = 0;
  563. virtual RS::InstanceType get_base_type(RID p_rid) const = 0;
  564. virtual bool free(RID p_rid) = 0;
  565. virtual bool has_os_feature(const String &p_feature) const = 0;
  566. virtual void update_dirty_resources() = 0;
  567. virtual void set_debug_generate_wireframes(bool p_generate) = 0;
  568. virtual void render_info_begin_capture() = 0;
  569. virtual void render_info_end_capture() = 0;
  570. virtual int get_captured_render_info(RS::RenderInfo p_info) = 0;
  571. virtual int get_render_info(RS::RenderInfo p_info) = 0;
  572. virtual String get_video_adapter_name() const = 0;
  573. virtual String get_video_adapter_vendor() const = 0;
  574. static RasterizerStorage *base_singleton;
  575. void set_default_clear_color(const Color &p_color) {
  576. default_clear_color = p_color;
  577. }
  578. Color get_default_clear_color() const {
  579. return default_clear_color;
  580. }
  581. #define TIMESTAMP_BEGIN() \
  582. { \
  583. if (RSG::storage->capturing_timestamps) \
  584. RSG::storage->capture_timestamps_begin(); \
  585. }
  586. #define RENDER_TIMESTAMP(m_text) \
  587. { \
  588. if (RSG::storage->capturing_timestamps) \
  589. RSG::storage->capture_timestamp(m_text); \
  590. }
  591. bool capturing_timestamps = false;
  592. virtual void capture_timestamps_begin() = 0;
  593. virtual void capture_timestamp(const String &p_name) = 0;
  594. virtual uint32_t get_captured_timestamps_count() const = 0;
  595. virtual uint64_t get_captured_timestamps_frame() const = 0;
  596. virtual uint64_t get_captured_timestamp_gpu_time(uint32_t p_index) const = 0;
  597. virtual uint64_t get_captured_timestamp_cpu_time(uint32_t p_index) const = 0;
  598. virtual String get_captured_timestamp_name(uint32_t p_index) const = 0;
  599. RasterizerStorage();
  600. virtual ~RasterizerStorage() {}
  601. };
  602. class RasterizerCanvas {
  603. public:
  604. static RasterizerCanvas *singleton;
  605. enum CanvasRectFlags {
  606. CANVAS_RECT_REGION = 1,
  607. CANVAS_RECT_TILE = 2,
  608. CANVAS_RECT_FLIP_H = 4,
  609. CANVAS_RECT_FLIP_V = 8,
  610. CANVAS_RECT_TRANSPOSE = 16,
  611. CANVAS_RECT_CLIP_UV = 32
  612. };
  613. struct Light {
  614. bool enabled;
  615. Color color;
  616. Transform2D xform;
  617. float height;
  618. float energy;
  619. float scale;
  620. int z_min;
  621. int z_max;
  622. int layer_min;
  623. int layer_max;
  624. int item_mask;
  625. int item_shadow_mask;
  626. RS::CanvasLightMode mode;
  627. RID texture;
  628. Vector2 texture_offset;
  629. RID canvas;
  630. bool use_shadow;
  631. int shadow_buffer_size;
  632. RS::CanvasLightShadowFilter shadow_filter;
  633. Color shadow_color;
  634. float shadow_smooth;
  635. //void *texture_cache; // implementation dependent
  636. Rect2 rect_cache;
  637. Transform2D xform_cache;
  638. float radius_cache; //used for shadow far plane
  639. //CameraMatrix shadow_matrix_cache;
  640. Transform2D light_shader_xform;
  641. //Vector2 light_shader_pos;
  642. Light *shadows_next_ptr;
  643. Light *filter_next_ptr;
  644. Light *next_ptr;
  645. Light *mask_next_ptr;
  646. RID light_internal;
  647. uint64_t version;
  648. int32_t render_index_cache;
  649. Light() {
  650. version = 0;
  651. enabled = true;
  652. color = Color(1, 1, 1);
  653. shadow_color = Color(0, 0, 0, 0);
  654. height = 0;
  655. z_min = -1024;
  656. z_max = 1024;
  657. layer_min = 0;
  658. layer_max = 0;
  659. item_mask = 1;
  660. scale = 1.0;
  661. energy = 1.0;
  662. item_shadow_mask = 1;
  663. mode = RS::CANVAS_LIGHT_MODE_ADD;
  664. // texture_cache = nullptr;
  665. next_ptr = nullptr;
  666. mask_next_ptr = nullptr;
  667. filter_next_ptr = nullptr;
  668. use_shadow = false;
  669. shadow_buffer_size = 2048;
  670. shadow_filter = RS::CANVAS_LIGHT_FILTER_NONE;
  671. shadow_smooth = 0.0;
  672. render_index_cache = -1;
  673. }
  674. };
  675. typedef uint64_t TextureBindingID;
  676. 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;
  677. virtual void free_texture_binding(TextureBindingID p_binding) = 0;
  678. //easier wrap to avoid mistakes
  679. struct Item;
  680. struct TextureBinding {
  681. TextureBindingID binding_id;
  682. _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) {
  683. if (p_filter == RS::CANVAS_ITEM_TEXTURE_FILTER_DEFAULT) {
  684. p_filter = p_item_filter;
  685. }
  686. if (p_repeat == RS::CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT) {
  687. p_repeat = p_item_repeat;
  688. }
  689. 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()) {
  690. ERR_FAIL_COND(binding_id != 0);
  691. binding_id = singleton->request_texture_binding(p_texture, p_normalmap, p_specular, p_filter, p_repeat, p_multimesh);
  692. }
  693. }
  694. _FORCE_INLINE_ TextureBinding() { binding_id = 0; }
  695. _FORCE_INLINE_ ~TextureBinding() {
  696. if (binding_id) {
  697. singleton->free_texture_binding(binding_id);
  698. }
  699. }
  700. };
  701. typedef uint64_t PolygonID;
  702. 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;
  703. virtual void free_polygon(PolygonID p_polygon) = 0;
  704. //also easier to wrap to avoid mistakes
  705. struct Polygon {
  706. PolygonID polygon_id;
  707. Rect2 rect_cache;
  708. _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>()) {
  709. ERR_FAIL_COND(polygon_id != 0);
  710. {
  711. uint32_t pc = p_points.size();
  712. const Vector2 *v2 = p_points.ptr();
  713. rect_cache.position = *v2;
  714. for (uint32_t i = 1; i < pc; i++) {
  715. rect_cache.expand_to(v2[i]);
  716. }
  717. }
  718. polygon_id = singleton->request_polygon(p_indices, p_points, p_colors, p_uvs, p_bones, p_weights);
  719. }
  720. _FORCE_INLINE_ Polygon() { polygon_id = 0; }
  721. _FORCE_INLINE_ ~Polygon() {
  722. if (polygon_id) {
  723. singleton->free_polygon(polygon_id);
  724. }
  725. }
  726. };
  727. //item
  728. struct Item {
  729. //commands are allocated in blocks of 4k to improve performance
  730. //and cache coherence.
  731. //blocks always grow but never shrink.
  732. struct CommandBlock {
  733. enum {
  734. MAX_SIZE = 4096
  735. };
  736. uint32_t usage;
  737. uint8_t *memory;
  738. };
  739. struct Command {
  740. enum Type {
  741. TYPE_RECT,
  742. TYPE_NINEPATCH,
  743. TYPE_POLYGON,
  744. TYPE_PRIMITIVE,
  745. TYPE_MESH,
  746. TYPE_MULTIMESH,
  747. TYPE_PARTICLES,
  748. TYPE_TRANSFORM,
  749. TYPE_CLIP_IGNORE,
  750. };
  751. Command *next;
  752. Type type;
  753. virtual ~Command() {}
  754. };
  755. struct CommandRect : public Command {
  756. Rect2 rect;
  757. Color modulate;
  758. Rect2 source;
  759. uint8_t flags;
  760. Color specular_shininess;
  761. TextureBinding texture_binding;
  762. CommandRect() {
  763. flags = 0;
  764. type = TYPE_RECT;
  765. }
  766. };
  767. struct CommandNinePatch : public Command {
  768. Rect2 rect;
  769. Rect2 source;
  770. float margin[4];
  771. bool draw_center;
  772. Color color;
  773. RS::NinePatchAxisMode axis_x;
  774. RS::NinePatchAxisMode axis_y;
  775. Color specular_shininess;
  776. TextureBinding texture_binding;
  777. CommandNinePatch() {
  778. draw_center = true;
  779. type = TYPE_NINEPATCH;
  780. }
  781. };
  782. struct CommandPolygon : public Command {
  783. RS::PrimitiveType primitive;
  784. Polygon polygon;
  785. Color specular_shininess;
  786. TextureBinding texture_binding;
  787. CommandPolygon() {
  788. type = TYPE_POLYGON;
  789. }
  790. };
  791. struct CommandPrimitive : public Command {
  792. uint32_t point_count;
  793. Vector2 points[4];
  794. Vector2 uvs[4];
  795. Color colors[4];
  796. Color specular_shininess;
  797. TextureBinding texture_binding;
  798. CommandPrimitive() {
  799. type = TYPE_PRIMITIVE;
  800. }
  801. };
  802. struct CommandMesh : public Command {
  803. RID mesh;
  804. Transform2D transform;
  805. Color modulate;
  806. Color specular_shininess;
  807. TextureBinding texture_binding;
  808. CommandMesh() { type = TYPE_MESH; }
  809. };
  810. struct CommandMultiMesh : public Command {
  811. RID multimesh;
  812. Color specular_shininess;
  813. TextureBinding texture_binding;
  814. CommandMultiMesh() { type = TYPE_MULTIMESH; }
  815. };
  816. struct CommandParticles : public Command {
  817. RID particles;
  818. Color specular_shininess;
  819. TextureBinding texture_binding;
  820. CommandParticles() { type = TYPE_PARTICLES; }
  821. };
  822. struct CommandTransform : public Command {
  823. Transform2D xform;
  824. CommandTransform() { type = TYPE_TRANSFORM; }
  825. };
  826. struct CommandClipIgnore : public Command {
  827. bool ignore;
  828. CommandClipIgnore() {
  829. type = TYPE_CLIP_IGNORE;
  830. ignore = false;
  831. }
  832. };
  833. struct ViewportRender {
  834. RenderingServer *owner;
  835. void *udata;
  836. Rect2 rect;
  837. };
  838. Transform2D xform;
  839. bool clip;
  840. bool visible;
  841. bool behind;
  842. bool update_when_visible;
  843. //RS::MaterialBlendMode blend_mode;
  844. int light_mask;
  845. int z_final;
  846. mutable bool custom_rect;
  847. mutable bool rect_dirty;
  848. mutable Rect2 rect;
  849. RID material;
  850. RID skeleton;
  851. Item *next;
  852. struct CopyBackBuffer {
  853. Rect2 rect;
  854. Rect2 screen_rect;
  855. bool full;
  856. };
  857. CopyBackBuffer *copy_back_buffer;
  858. Color final_modulate;
  859. Transform2D final_transform;
  860. Rect2 final_clip_rect;
  861. Item *final_clip_owner;
  862. Item *material_owner;
  863. ViewportRender *vp_render;
  864. bool distance_field;
  865. bool light_masked;
  866. Rect2 global_rect_cache;
  867. const Rect2 &get_rect() const {
  868. if (custom_rect || (!rect_dirty && !update_when_visible)) {
  869. return rect;
  870. }
  871. //must update rect
  872. if (commands == nullptr) {
  873. rect = Rect2();
  874. rect_dirty = false;
  875. return rect;
  876. }
  877. Transform2D xf;
  878. bool found_xform = false;
  879. bool first = true;
  880. const Item::Command *c = commands;
  881. while (c) {
  882. Rect2 r;
  883. switch (c->type) {
  884. case Item::Command::TYPE_RECT: {
  885. const Item::CommandRect *crect = static_cast<const Item::CommandRect *>(c);
  886. r = crect->rect;
  887. } break;
  888. case Item::Command::TYPE_NINEPATCH: {
  889. const Item::CommandNinePatch *style = static_cast<const Item::CommandNinePatch *>(c);
  890. r = style->rect;
  891. } break;
  892. case Item::Command::TYPE_POLYGON: {
  893. const Item::CommandPolygon *polygon = static_cast<const Item::CommandPolygon *>(c);
  894. r = polygon->polygon.rect_cache;
  895. } break;
  896. case Item::Command::TYPE_PRIMITIVE: {
  897. const Item::CommandPrimitive *primitive = static_cast<const Item::CommandPrimitive *>(c);
  898. for (uint32_t j = 0; j < primitive->point_count; j++) {
  899. if (j == 0) {
  900. r.position = primitive->points[0];
  901. } else {
  902. r.expand_to(primitive->points[j]);
  903. }
  904. }
  905. } break;
  906. case Item::Command::TYPE_MESH: {
  907. const Item::CommandMesh *mesh = static_cast<const Item::CommandMesh *>(c);
  908. AABB aabb = RasterizerStorage::base_singleton->mesh_get_aabb(mesh->mesh, RID());
  909. r = Rect2(aabb.position.x, aabb.position.y, aabb.size.x, aabb.size.y);
  910. } break;
  911. case Item::Command::TYPE_MULTIMESH: {
  912. const Item::CommandMultiMesh *multimesh = static_cast<const Item::CommandMultiMesh *>(c);
  913. AABB aabb = RasterizerStorage::base_singleton->multimesh_get_aabb(multimesh->multimesh);
  914. r = Rect2(aabb.position.x, aabb.position.y, aabb.size.x, aabb.size.y);
  915. } break;
  916. case Item::Command::TYPE_PARTICLES: {
  917. const Item::CommandParticles *particles_cmd = static_cast<const Item::CommandParticles *>(c);
  918. if (particles_cmd->particles.is_valid()) {
  919. AABB aabb = RasterizerStorage::base_singleton->particles_get_aabb(particles_cmd->particles);
  920. r = Rect2(aabb.position.x, aabb.position.y, aabb.size.x, aabb.size.y);
  921. }
  922. } break;
  923. case Item::Command::TYPE_TRANSFORM: {
  924. const Item::CommandTransform *transform = static_cast<const Item::CommandTransform *>(c);
  925. xf = transform->xform;
  926. found_xform = true;
  927. [[fallthrough]];
  928. }
  929. default: {
  930. c = c->next;
  931. continue;
  932. }
  933. }
  934. if (found_xform) {
  935. r = xf.xform(r);
  936. found_xform = false;
  937. }
  938. if (first) {
  939. rect = r;
  940. first = false;
  941. } else {
  942. rect = rect.merge(r);
  943. }
  944. c = c->next;
  945. }
  946. rect_dirty = false;
  947. return rect;
  948. }
  949. Command *commands;
  950. Command *last_command;
  951. Vector<CommandBlock> blocks;
  952. uint32_t current_block;
  953. template <class T>
  954. T *alloc_command() {
  955. T *command;
  956. if (commands == nullptr) {
  957. // As the most common use case of canvas items is to
  958. // use only one command, the first is done with it's
  959. // own allocation. The rest of them use blocks.
  960. command = memnew(T);
  961. command->next = nullptr;
  962. commands = command;
  963. last_command = command;
  964. } else {
  965. //Subsequent commands go into a block.
  966. while (true) {
  967. if (unlikely(current_block == (uint32_t)blocks.size())) {
  968. // If we need more blocks, we allocate them
  969. // (they won't be freed until this CanvasItem is
  970. // deleted, though).
  971. CommandBlock cb;
  972. cb.memory = (uint8_t *)memalloc(CommandBlock::MAX_SIZE);
  973. cb.usage = 0;
  974. blocks.push_back(cb);
  975. }
  976. CommandBlock *c = &blocks.write[current_block];
  977. size_t space_left = CommandBlock::MAX_SIZE - c->usage;
  978. if (space_left < sizeof(T)) {
  979. current_block++;
  980. continue;
  981. }
  982. //allocate block and add to the linked list
  983. void *memory = c->memory + c->usage;
  984. command = memnew_placement(memory, T);
  985. command->next = nullptr;
  986. last_command->next = command;
  987. last_command = command;
  988. c->usage += sizeof(T);
  989. break;
  990. }
  991. }
  992. rect_dirty = true;
  993. return command;
  994. }
  995. struct CustomData {
  996. virtual ~CustomData() {}
  997. };
  998. mutable CustomData *custom_data; //implementation dependent
  999. void clear() {
  1000. Command *c = commands;
  1001. while (c) {
  1002. Command *n = c->next;
  1003. if (c == commands) {
  1004. memdelete(commands);
  1005. commands = nullptr;
  1006. } else {
  1007. c->~Command();
  1008. }
  1009. c = n;
  1010. }
  1011. {
  1012. uint32_t cbc = MIN((current_block + 1), (uint32_t)blocks.size());
  1013. CommandBlock *blockptr = blocks.ptrw();
  1014. for (uint32_t i = 0; i < cbc; i++) {
  1015. blockptr[i].usage = 0;
  1016. }
  1017. }
  1018. last_command = nullptr;
  1019. commands = nullptr;
  1020. current_block = 0;
  1021. clip = false;
  1022. rect_dirty = true;
  1023. final_clip_owner = nullptr;
  1024. material_owner = nullptr;
  1025. light_masked = false;
  1026. }
  1027. Item() {
  1028. commands = nullptr;
  1029. last_command = nullptr;
  1030. current_block = 0;
  1031. light_mask = 1;
  1032. vp_render = nullptr;
  1033. next = nullptr;
  1034. final_clip_owner = nullptr;
  1035. clip = false;
  1036. final_modulate = Color(1, 1, 1, 1);
  1037. visible = true;
  1038. rect_dirty = true;
  1039. custom_rect = false;
  1040. behind = false;
  1041. material_owner = nullptr;
  1042. copy_back_buffer = nullptr;
  1043. distance_field = false;
  1044. light_masked = false;
  1045. update_when_visible = false;
  1046. z_final = 0;
  1047. custom_data = nullptr;
  1048. }
  1049. virtual ~Item() {
  1050. clear();
  1051. for (int i = 0; i < blocks.size(); i++) {
  1052. memfree(blocks[i].memory);
  1053. }
  1054. if (copy_back_buffer) {
  1055. memdelete(copy_back_buffer);
  1056. }
  1057. if (custom_data) {
  1058. memdelete(custom_data);
  1059. }
  1060. }
  1061. };
  1062. 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;
  1063. virtual void canvas_debug_viewport_shadows(Light *p_lights_with_shadow) = 0;
  1064. struct LightOccluderInstance {
  1065. bool enabled;
  1066. RID canvas;
  1067. RID polygon;
  1068. RID occluder;
  1069. Rect2 aabb_cache;
  1070. Transform2D xform;
  1071. Transform2D xform_cache;
  1072. int light_mask;
  1073. RS::CanvasOccluderPolygonCullMode cull_cache;
  1074. LightOccluderInstance *next;
  1075. LightOccluderInstance() {
  1076. enabled = true;
  1077. next = nullptr;
  1078. light_mask = 1;
  1079. cull_cache = RS::CANVAS_OCCLUDER_POLYGON_CULL_DISABLED;
  1080. }
  1081. };
  1082. virtual RID light_create() = 0;
  1083. virtual void light_set_texture(RID p_rid, RID p_texture) = 0;
  1084. virtual void light_set_use_shadow(RID p_rid, bool p_enable, int p_resolution) = 0;
  1085. 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;
  1086. virtual RID occluder_polygon_create() = 0;
  1087. virtual void occluder_polygon_set_shape_as_lines(RID p_occluder, const Vector<Vector2> &p_lines) = 0;
  1088. virtual void occluder_polygon_set_cull_mode(RID p_occluder, RS::CanvasOccluderPolygonCullMode p_mode) = 0;
  1089. virtual void draw_window_margins(int *p_margins, RID *p_margin_textures) = 0;
  1090. virtual bool free(RID p_rid) = 0;
  1091. virtual void update() = 0;
  1092. RasterizerCanvas() { singleton = this; }
  1093. virtual ~RasterizerCanvas() {}
  1094. };
  1095. class Rasterizer {
  1096. protected:
  1097. static Rasterizer *(*_create_func)();
  1098. public:
  1099. static Rasterizer *create();
  1100. virtual RasterizerStorage *get_storage() = 0;
  1101. virtual RasterizerCanvas *get_canvas() = 0;
  1102. virtual RasterizerScene *get_scene() = 0;
  1103. virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;
  1104. virtual void initialize() = 0;
  1105. virtual void begin_frame(double frame_step) = 0;
  1106. struct BlitToScreen {
  1107. RID render_target;
  1108. Rect2i rect;
  1109. //lens distorted parameters for VR should go here
  1110. };
  1111. virtual void prepare_for_blitting_render_targets() = 0;
  1112. virtual void blit_render_targets_to_screen(DisplayServer::WindowID p_screen, const BlitToScreen *p_render_targets, int p_amount) = 0;
  1113. virtual void end_frame(bool p_swap_buffers) = 0;
  1114. virtual void finalize() = 0;
  1115. virtual uint64_t get_frame_number() const = 0;
  1116. virtual float get_frame_delta_time() const = 0;
  1117. virtual bool is_low_end() const = 0;
  1118. virtual ~Rasterizer() {}
  1119. };
  1120. #endif // RASTERIZER_H