particles_storage.cpp 72 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852
  1. /**************************************************************************/
  2. /* particles_storage.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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. #include "particles_storage.h"
  31. #include "servers/rendering/renderer_rd/renderer_compositor_rd.h"
  32. #include "servers/rendering/rendering_server_globals.h"
  33. #include "texture_storage.h"
  34. using namespace RendererRD;
  35. ParticlesStorage *ParticlesStorage::singleton = nullptr;
  36. ParticlesStorage *ParticlesStorage::get_singleton() {
  37. return singleton;
  38. }
  39. ParticlesStorage::ParticlesStorage() {
  40. singleton = this;
  41. MaterialStorage *material_storage = MaterialStorage::get_singleton();
  42. /* Effects */
  43. sort_effects = memnew(SortEffects);
  44. /* Particles */
  45. {
  46. String defines = "#define SAMPLERS_BINDING_FIRST_INDEX " + itos(SAMPLERS_BINDING_FIRST_INDEX) + "\n";
  47. // Initialize particles
  48. Vector<String> particles_modes;
  49. particles_modes.push_back("");
  50. particles_shader.shader.initialize(particles_modes, defines);
  51. }
  52. MaterialStorage::get_singleton()->shader_set_data_request_function(MaterialStorage::SHADER_TYPE_PARTICLES, _create_particles_shader_funcs);
  53. MaterialStorage::get_singleton()->material_set_data_request_function(MaterialStorage::SHADER_TYPE_PARTICLES, _create_particles_material_funcs);
  54. {
  55. ShaderCompiler::DefaultIdentifierActions actions;
  56. actions.renames["COLOR"] = "PARTICLE.color";
  57. actions.renames["VELOCITY"] = "PARTICLE.velocity";
  58. //actions.renames["MASS"] = "mass"; ?
  59. actions.renames["ACTIVE"] = "particle_active";
  60. actions.renames["RESTART"] = "restart";
  61. actions.renames["CUSTOM"] = "PARTICLE.custom";
  62. for (int i = 0; i < ParticlesShader::MAX_USERDATAS; i++) {
  63. String udname = "USERDATA" + itos(i + 1);
  64. actions.renames[udname] = "PARTICLE.userdata" + itos(i + 1);
  65. actions.usage_defines[udname] = "#define USERDATA" + itos(i + 1) + "_USED\n";
  66. }
  67. actions.renames["TRANSFORM"] = "PARTICLE.xform";
  68. actions.renames["TIME"] = "frame_history.data[0].time";
  69. actions.renames["PI"] = _MKSTR(Math_PI);
  70. actions.renames["TAU"] = _MKSTR(Math_TAU);
  71. actions.renames["E"] = _MKSTR(Math_E);
  72. actions.renames["LIFETIME"] = "params.lifetime";
  73. actions.renames["DELTA"] = "local_delta";
  74. actions.renames["NUMBER"] = "particle_number";
  75. actions.renames["INDEX"] = "index";
  76. //actions.renames["GRAVITY"] = "current_gravity";
  77. actions.renames["EMISSION_TRANSFORM"] = "FRAME.emission_transform";
  78. actions.renames["RANDOM_SEED"] = "FRAME.random_seed";
  79. actions.renames["FLAG_EMIT_POSITION"] = "EMISSION_FLAG_HAS_POSITION";
  80. actions.renames["FLAG_EMIT_ROT_SCALE"] = "EMISSION_FLAG_HAS_ROTATION_SCALE";
  81. actions.renames["FLAG_EMIT_VELOCITY"] = "EMISSION_FLAG_HAS_VELOCITY";
  82. actions.renames["FLAG_EMIT_COLOR"] = "EMISSION_FLAG_HAS_COLOR";
  83. actions.renames["FLAG_EMIT_CUSTOM"] = "EMISSION_FLAG_HAS_CUSTOM";
  84. actions.renames["RESTART_POSITION"] = "restart_position";
  85. actions.renames["RESTART_ROT_SCALE"] = "restart_rotation_scale";
  86. actions.renames["RESTART_VELOCITY"] = "restart_velocity";
  87. actions.renames["RESTART_COLOR"] = "restart_color";
  88. actions.renames["RESTART_CUSTOM"] = "restart_custom";
  89. actions.renames["emit_subparticle"] = "emit_subparticle";
  90. actions.renames["COLLIDED"] = "collided";
  91. actions.renames["COLLISION_NORMAL"] = "collision_normal";
  92. actions.renames["COLLISION_DEPTH"] = "collision_depth";
  93. actions.renames["ATTRACTOR_FORCE"] = "attractor_force";
  94. actions.render_mode_defines["disable_force"] = "#define DISABLE_FORCE\n";
  95. actions.render_mode_defines["disable_velocity"] = "#define DISABLE_VELOCITY\n";
  96. actions.render_mode_defines["keep_data"] = "#define ENABLE_KEEP_DATA\n";
  97. actions.render_mode_defines["collision_use_scale"] = "#define USE_COLLISION_SCALE\n";
  98. actions.base_texture_binding_index = 1;
  99. actions.texture_layout_set = 3;
  100. actions.base_uniform_string = "material.";
  101. actions.base_varying_index = 10;
  102. actions.default_filter = ShaderLanguage::FILTER_LINEAR_MIPMAP;
  103. actions.default_repeat = ShaderLanguage::REPEAT_ENABLE;
  104. actions.global_buffer_array_variable = "global_shader_uniforms.data";
  105. particles_shader.compiler.initialize(actions);
  106. }
  107. {
  108. // default material and shader for particles shader
  109. particles_shader.default_shader = material_storage->shader_allocate();
  110. material_storage->shader_initialize(particles_shader.default_shader);
  111. material_storage->shader_set_code(particles_shader.default_shader, R"(
  112. // Default particles shader.
  113. shader_type particles;
  114. void process() {
  115. COLOR = vec4(1.0);
  116. }
  117. )");
  118. particles_shader.default_material = material_storage->material_allocate();
  119. material_storage->material_initialize(particles_shader.default_material);
  120. material_storage->material_set_shader(particles_shader.default_material, particles_shader.default_shader);
  121. ParticleProcessMaterialData *md = static_cast<ParticleProcessMaterialData *>(material_storage->material_get_data(particles_shader.default_material, MaterialStorage::SHADER_TYPE_PARTICLES));
  122. particles_shader.default_shader_rd = particles_shader.shader.version_get_shader(md->shader_data->version, 0);
  123. Vector<RD::Uniform> uniforms;
  124. {
  125. RD::Uniform u;
  126. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  127. u.binding = 2;
  128. u.append_id(material_storage->global_shader_uniforms_get_storage_buffer());
  129. uniforms.push_back(u);
  130. }
  131. uniforms.append_array(material_storage->get_default_sampler_uniforms(SAMPLERS_BINDING_FIRST_INDEX));
  132. particles_shader.base_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.default_shader_rd, BASE_UNIFORM_SET);
  133. }
  134. {
  135. Vector<String> copy_modes;
  136. for (int i = 0; i <= ParticlesShader::MAX_USERDATAS; i++) {
  137. if (i == 0) {
  138. copy_modes.push_back("\n#define MODE_FILL_INSTANCES\n");
  139. copy_modes.push_back("\n#define MODE_FILL_SORT_BUFFER\n#define USE_SORT_BUFFER\n");
  140. copy_modes.push_back("\n#define MODE_FILL_INSTANCES\n#define USE_SORT_BUFFER\n");
  141. } else {
  142. copy_modes.push_back("\n#define MODE_FILL_INSTANCES\n#define USERDATA_COUNT " + itos(i) + "\n");
  143. copy_modes.push_back("\n#define MODE_FILL_SORT_BUFFER\n#define USE_SORT_BUFFER\n#define USERDATA_COUNT " + itos(i) + "\n");
  144. copy_modes.push_back("\n#define MODE_FILL_INSTANCES\n#define USE_SORT_BUFFER\n#define USERDATA_COUNT " + itos(i) + "\n");
  145. }
  146. }
  147. particles_shader.copy_shader.initialize(copy_modes);
  148. particles_shader.copy_shader_version = particles_shader.copy_shader.version_create();
  149. for (int i = 0; i <= ParticlesShader::MAX_USERDATAS; i++) {
  150. for (int j = 0; j < ParticlesShader::COPY_MODE_MAX; j++) {
  151. particles_shader.copy_pipelines[i * ParticlesShader::COPY_MODE_MAX + j] = RD::get_singleton()->compute_pipeline_create(particles_shader.copy_shader.version_get_shader(particles_shader.copy_shader_version, i * ParticlesShader::COPY_MODE_MAX + j));
  152. }
  153. }
  154. }
  155. }
  156. ParticlesStorage::~ParticlesStorage() {
  157. MaterialStorage *material_storage = MaterialStorage::get_singleton();
  158. particles_shader.copy_shader.version_free(particles_shader.copy_shader_version);
  159. material_storage->material_free(particles_shader.default_material);
  160. material_storage->shader_free(particles_shader.default_shader);
  161. if (sort_effects) {
  162. memdelete(sort_effects);
  163. sort_effects = nullptr;
  164. }
  165. singleton = nullptr;
  166. }
  167. bool ParticlesStorage::free(RID p_rid) {
  168. if (owns_particles(p_rid)) {
  169. particles_free(p_rid);
  170. return true;
  171. } else if (owns_particles_collision(p_rid)) {
  172. particles_collision_free(p_rid);
  173. return true;
  174. } else if (owns_particles_collision_instance(p_rid)) {
  175. particles_collision_instance_free(p_rid);
  176. return true;
  177. }
  178. return false;
  179. }
  180. /* PARTICLES */
  181. RID ParticlesStorage::particles_allocate() {
  182. return particles_owner.allocate_rid();
  183. }
  184. void ParticlesStorage::particles_initialize(RID p_rid) {
  185. particles_owner.initialize_rid(p_rid, Particles());
  186. }
  187. void ParticlesStorage::particles_free(RID p_rid) {
  188. update_particles();
  189. Particles *particles = particles_owner.get_or_null(p_rid);
  190. particles->dependency.deleted_notify(p_rid);
  191. _particles_free_data(particles);
  192. particles_owner.free(p_rid);
  193. }
  194. void ParticlesStorage::particles_set_mode(RID p_particles, RS::ParticlesMode p_mode) {
  195. Particles *particles = particles_owner.get_or_null(p_particles);
  196. ERR_FAIL_COND(!particles);
  197. if (particles->mode == p_mode) {
  198. return;
  199. }
  200. _particles_free_data(particles);
  201. particles->mode = p_mode;
  202. }
  203. void ParticlesStorage::particles_set_emitting(RID p_particles, bool p_emitting) {
  204. Particles *particles = particles_owner.get_or_null(p_particles);
  205. ERR_FAIL_COND(!particles);
  206. particles->emitting = p_emitting;
  207. }
  208. bool ParticlesStorage::particles_get_emitting(RID p_particles) {
  209. ERR_FAIL_COND_V_MSG(RSG::threaded, false, "This function should never be used with threaded rendering, as it stalls the renderer.");
  210. Particles *particles = particles_owner.get_or_null(p_particles);
  211. ERR_FAIL_COND_V(!particles, false);
  212. return particles->emitting;
  213. }
  214. void ParticlesStorage::_particles_free_data(Particles *particles) {
  215. if (particles->particle_buffer.is_valid()) {
  216. RD::get_singleton()->free(particles->particle_buffer);
  217. particles->particle_buffer = RID();
  218. RD::get_singleton()->free(particles->particle_instance_buffer);
  219. particles->particle_instance_buffer = RID();
  220. }
  221. particles->userdata_count = 0;
  222. if (particles->frame_params_buffer.is_valid()) {
  223. RD::get_singleton()->free(particles->frame_params_buffer);
  224. particles->frame_params_buffer = RID();
  225. }
  226. particles->particles_transforms_buffer_uniform_set = RID();
  227. if (RD::get_singleton()->uniform_set_is_valid(particles->trail_bind_pose_uniform_set)) {
  228. RD::get_singleton()->free(particles->trail_bind_pose_uniform_set);
  229. }
  230. particles->trail_bind_pose_uniform_set = RID();
  231. if (particles->trail_bind_pose_buffer.is_valid()) {
  232. RD::get_singleton()->free(particles->trail_bind_pose_buffer);
  233. particles->trail_bind_pose_buffer = RID();
  234. }
  235. if (RD::get_singleton()->uniform_set_is_valid(particles->collision_textures_uniform_set)) {
  236. RD::get_singleton()->free(particles->collision_textures_uniform_set);
  237. }
  238. particles->collision_textures_uniform_set = RID();
  239. if (particles->particles_sort_buffer.is_valid()) {
  240. RD::get_singleton()->free(particles->particles_sort_buffer);
  241. particles->particles_sort_buffer = RID();
  242. particles->particles_sort_uniform_set = RID();
  243. }
  244. if (particles->emission_buffer != nullptr) {
  245. particles->emission_buffer = nullptr;
  246. particles->emission_buffer_data.clear();
  247. RD::get_singleton()->free(particles->emission_storage_buffer);
  248. particles->emission_storage_buffer = RID();
  249. }
  250. if (RD::get_singleton()->uniform_set_is_valid(particles->particles_material_uniform_set)) {
  251. //will need to be re-created
  252. RD::get_singleton()->free(particles->particles_material_uniform_set);
  253. }
  254. particles->particles_material_uniform_set = RID();
  255. }
  256. void ParticlesStorage::particles_set_amount(RID p_particles, int p_amount) {
  257. Particles *particles = particles_owner.get_or_null(p_particles);
  258. ERR_FAIL_COND(!particles);
  259. if (particles->amount == p_amount) {
  260. return;
  261. }
  262. _particles_free_data(particles);
  263. particles->amount = p_amount;
  264. particles->prev_ticks = 0;
  265. particles->phase = 0;
  266. particles->prev_phase = 0;
  267. particles->clear = true;
  268. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES);
  269. }
  270. void ParticlesStorage::particles_set_lifetime(RID p_particles, double p_lifetime) {
  271. Particles *particles = particles_owner.get_or_null(p_particles);
  272. ERR_FAIL_COND(!particles);
  273. particles->lifetime = p_lifetime;
  274. }
  275. void ParticlesStorage::particles_set_one_shot(RID p_particles, bool p_one_shot) {
  276. Particles *particles = particles_owner.get_or_null(p_particles);
  277. ERR_FAIL_COND(!particles);
  278. particles->one_shot = p_one_shot;
  279. }
  280. void ParticlesStorage::particles_set_pre_process_time(RID p_particles, double p_time) {
  281. Particles *particles = particles_owner.get_or_null(p_particles);
  282. ERR_FAIL_COND(!particles);
  283. particles->pre_process_time = p_time;
  284. }
  285. void ParticlesStorage::particles_set_explosiveness_ratio(RID p_particles, real_t p_ratio) {
  286. Particles *particles = particles_owner.get_or_null(p_particles);
  287. ERR_FAIL_COND(!particles);
  288. particles->explosiveness = p_ratio;
  289. }
  290. void ParticlesStorage::particles_set_randomness_ratio(RID p_particles, real_t p_ratio) {
  291. Particles *particles = particles_owner.get_or_null(p_particles);
  292. ERR_FAIL_COND(!particles);
  293. particles->randomness = p_ratio;
  294. }
  295. void ParticlesStorage::particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) {
  296. Particles *particles = particles_owner.get_or_null(p_particles);
  297. ERR_FAIL_COND(!particles);
  298. particles->custom_aabb = p_aabb;
  299. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  300. }
  301. void ParticlesStorage::particles_set_speed_scale(RID p_particles, double p_scale) {
  302. Particles *particles = particles_owner.get_or_null(p_particles);
  303. ERR_FAIL_COND(!particles);
  304. particles->speed_scale = p_scale;
  305. }
  306. void ParticlesStorage::particles_set_use_local_coordinates(RID p_particles, bool p_enable) {
  307. Particles *particles = particles_owner.get_or_null(p_particles);
  308. ERR_FAIL_COND(!particles);
  309. particles->use_local_coords = p_enable;
  310. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES);
  311. }
  312. void ParticlesStorage::particles_set_fixed_fps(RID p_particles, int p_fps) {
  313. Particles *particles = particles_owner.get_or_null(p_particles);
  314. ERR_FAIL_COND(!particles);
  315. particles->fixed_fps = p_fps;
  316. _particles_free_data(particles);
  317. particles->prev_ticks = 0;
  318. particles->phase = 0;
  319. particles->prev_phase = 0;
  320. particles->clear = true;
  321. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES);
  322. }
  323. void ParticlesStorage::particles_set_interpolate(RID p_particles, bool p_enable) {
  324. Particles *particles = particles_owner.get_or_null(p_particles);
  325. ERR_FAIL_COND(!particles);
  326. particles->interpolate = p_enable;
  327. }
  328. void ParticlesStorage::particles_set_fractional_delta(RID p_particles, bool p_enable) {
  329. Particles *particles = particles_owner.get_or_null(p_particles);
  330. ERR_FAIL_COND(!particles);
  331. particles->fractional_delta = p_enable;
  332. }
  333. void ParticlesStorage::particles_set_trails(RID p_particles, bool p_enable, double p_length) {
  334. Particles *particles = particles_owner.get_or_null(p_particles);
  335. ERR_FAIL_COND(!particles);
  336. ERR_FAIL_COND(p_length < 0.01);
  337. p_length = MIN(10.0, p_length);
  338. particles->trails_enabled = p_enable;
  339. particles->trail_lifetime = p_length;
  340. _particles_free_data(particles);
  341. particles->prev_ticks = 0;
  342. particles->phase = 0;
  343. particles->prev_phase = 0;
  344. particles->clear = true;
  345. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES);
  346. }
  347. void ParticlesStorage::particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) {
  348. Particles *particles = particles_owner.get_or_null(p_particles);
  349. ERR_FAIL_COND(!particles);
  350. if (particles->trail_bind_pose_buffer.is_valid() && particles->trail_bind_poses.size() != p_bind_poses.size()) {
  351. _particles_free_data(particles);
  352. particles->prev_ticks = 0;
  353. particles->phase = 0;
  354. particles->prev_phase = 0;
  355. particles->clear = true;
  356. }
  357. particles->trail_bind_poses = p_bind_poses;
  358. particles->trail_bind_poses_dirty = true;
  359. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES);
  360. }
  361. void ParticlesStorage::particles_set_collision_base_size(RID p_particles, real_t p_size) {
  362. Particles *particles = particles_owner.get_or_null(p_particles);
  363. ERR_FAIL_COND(!particles);
  364. particles->collision_base_size = p_size;
  365. }
  366. void ParticlesStorage::particles_set_transform_align(RID p_particles, RS::ParticlesTransformAlign p_transform_align) {
  367. Particles *particles = particles_owner.get_or_null(p_particles);
  368. ERR_FAIL_COND(!particles);
  369. particles->transform_align = p_transform_align;
  370. }
  371. void ParticlesStorage::particles_set_process_material(RID p_particles, RID p_material) {
  372. Particles *particles = particles_owner.get_or_null(p_particles);
  373. ERR_FAIL_COND(!particles);
  374. particles->process_material = p_material;
  375. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_PARTICLES); //the instance buffer may have changed
  376. }
  377. RID ParticlesStorage::particles_get_process_material(RID p_particles) const {
  378. Particles *particles = particles_owner.get_or_null(p_particles);
  379. ERR_FAIL_COND_V(!particles, RID());
  380. return particles->process_material;
  381. }
  382. void ParticlesStorage::particles_set_draw_order(RID p_particles, RS::ParticlesDrawOrder p_order) {
  383. Particles *particles = particles_owner.get_or_null(p_particles);
  384. ERR_FAIL_COND(!particles);
  385. particles->draw_order = p_order;
  386. }
  387. void ParticlesStorage::particles_set_draw_passes(RID p_particles, int p_passes) {
  388. Particles *particles = particles_owner.get_or_null(p_particles);
  389. ERR_FAIL_COND(!particles);
  390. particles->draw_passes.resize(p_passes);
  391. }
  392. void ParticlesStorage::particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) {
  393. Particles *particles = particles_owner.get_or_null(p_particles);
  394. ERR_FAIL_COND(!particles);
  395. ERR_FAIL_INDEX(p_pass, particles->draw_passes.size());
  396. particles->draw_passes.write[p_pass] = p_mesh;
  397. }
  398. void ParticlesStorage::particles_restart(RID p_particles) {
  399. Particles *particles = particles_owner.get_or_null(p_particles);
  400. ERR_FAIL_COND(!particles);
  401. particles->restart_request = true;
  402. }
  403. void ParticlesStorage::_particles_allocate_emission_buffer(Particles *particles) {
  404. ERR_FAIL_COND(particles->emission_buffer != nullptr);
  405. particles->emission_buffer_data.resize(sizeof(ParticleEmissionBuffer::Data) * particles->amount + sizeof(uint32_t) * 4);
  406. memset(particles->emission_buffer_data.ptrw(), 0, particles->emission_buffer_data.size());
  407. particles->emission_buffer = reinterpret_cast<ParticleEmissionBuffer *>(particles->emission_buffer_data.ptrw());
  408. particles->emission_buffer->particle_max = particles->amount;
  409. particles->emission_storage_buffer = RD::get_singleton()->storage_buffer_create(particles->emission_buffer_data.size(), particles->emission_buffer_data);
  410. if (RD::get_singleton()->uniform_set_is_valid(particles->particles_material_uniform_set)) {
  411. //will need to be re-created
  412. RD::get_singleton()->free(particles->particles_material_uniform_set);
  413. particles->particles_material_uniform_set = RID();
  414. }
  415. }
  416. void ParticlesStorage::particles_set_subemitter(RID p_particles, RID p_subemitter_particles) {
  417. Particles *particles = particles_owner.get_or_null(p_particles);
  418. ERR_FAIL_COND(!particles);
  419. ERR_FAIL_COND(p_particles == p_subemitter_particles);
  420. particles->sub_emitter = p_subemitter_particles;
  421. if (RD::get_singleton()->uniform_set_is_valid(particles->particles_material_uniform_set)) {
  422. RD::get_singleton()->free(particles->particles_material_uniform_set);
  423. particles->particles_material_uniform_set = RID(); //clear and force to re create sub emitting
  424. }
  425. }
  426. void ParticlesStorage::particles_emit(RID p_particles, const Transform3D &p_transform, const Vector3 &p_velocity, const Color &p_color, const Color &p_custom, uint32_t p_emit_flags) {
  427. Particles *particles = particles_owner.get_or_null(p_particles);
  428. ERR_FAIL_COND(!particles);
  429. ERR_FAIL_COND(particles->amount == 0);
  430. if (particles->emitting) {
  431. particles->clear = true;
  432. particles->emitting = false;
  433. }
  434. if (particles->emission_buffer == nullptr) {
  435. _particles_allocate_emission_buffer(particles);
  436. }
  437. particles->inactive = false;
  438. particles->inactive_time = 0;
  439. int32_t idx = particles->emission_buffer->particle_count;
  440. if (idx < particles->emission_buffer->particle_max) {
  441. RendererRD::MaterialStorage::store_transform(p_transform, particles->emission_buffer->data[idx].xform);
  442. particles->emission_buffer->data[idx].velocity[0] = p_velocity.x;
  443. particles->emission_buffer->data[idx].velocity[1] = p_velocity.y;
  444. particles->emission_buffer->data[idx].velocity[2] = p_velocity.z;
  445. particles->emission_buffer->data[idx].custom[0] = p_custom.r;
  446. particles->emission_buffer->data[idx].custom[1] = p_custom.g;
  447. particles->emission_buffer->data[idx].custom[2] = p_custom.b;
  448. particles->emission_buffer->data[idx].custom[3] = p_custom.a;
  449. particles->emission_buffer->data[idx].color[0] = p_color.r;
  450. particles->emission_buffer->data[idx].color[1] = p_color.g;
  451. particles->emission_buffer->data[idx].color[2] = p_color.b;
  452. particles->emission_buffer->data[idx].color[3] = p_color.a;
  453. particles->emission_buffer->data[idx].flags = p_emit_flags;
  454. particles->emission_buffer->particle_count++;
  455. }
  456. }
  457. void ParticlesStorage::particles_request_process(RID p_particles) {
  458. Particles *particles = particles_owner.get_or_null(p_particles);
  459. ERR_FAIL_COND(!particles);
  460. if (!particles->dirty) {
  461. particles->dirty = true;
  462. particles->update_list = particle_update_list;
  463. particle_update_list = particles;
  464. }
  465. }
  466. AABB ParticlesStorage::particles_get_current_aabb(RID p_particles) {
  467. if (RSG::threaded) {
  468. WARN_PRINT_ONCE("Calling this function with threaded rendering enabled stalls the renderer, use with care.");
  469. }
  470. const Particles *particles = particles_owner.get_or_null(p_particles);
  471. ERR_FAIL_COND_V(!particles, AABB());
  472. int total_amount = particles->amount;
  473. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  474. total_amount *= particles->trail_bind_poses.size();
  475. }
  476. Vector<uint8_t> buffer = RD::get_singleton()->buffer_get_data(particles->particle_buffer);
  477. ERR_FAIL_COND_V(buffer.size() != (int)(total_amount * sizeof(ParticleData)), AABB());
  478. Transform3D inv = particles->emission_transform.affine_inverse();
  479. AABB aabb;
  480. if (buffer.size()) {
  481. bool first = true;
  482. const uint8_t *data_ptr = (const uint8_t *)buffer.ptr();
  483. uint32_t particle_data_size = sizeof(ParticleData) + sizeof(float) * particles->userdata_count;
  484. for (int i = 0; i < total_amount; i++) {
  485. const ParticleData &particle_data = *(const ParticleData *)&data_ptr[particle_data_size * i];
  486. if (particle_data.active) {
  487. Vector3 pos = Vector3(particle_data.xform[12], particle_data.xform[13], particle_data.xform[14]);
  488. if (!particles->use_local_coords) {
  489. pos = inv.xform(pos);
  490. }
  491. if (first) {
  492. aabb.position = pos;
  493. first = false;
  494. } else {
  495. aabb.expand_to(pos);
  496. }
  497. }
  498. }
  499. }
  500. float longest_axis_size = 0;
  501. for (int i = 0; i < particles->draw_passes.size(); i++) {
  502. if (particles->draw_passes[i].is_valid()) {
  503. AABB maabb = MeshStorage::get_singleton()->mesh_get_aabb(particles->draw_passes[i], RID());
  504. longest_axis_size = MAX(maabb.get_longest_axis_size(), longest_axis_size);
  505. }
  506. }
  507. aabb.grow_by(longest_axis_size);
  508. return aabb;
  509. }
  510. AABB ParticlesStorage::particles_get_aabb(RID p_particles) const {
  511. const Particles *particles = particles_owner.get_or_null(p_particles);
  512. ERR_FAIL_COND_V(!particles, AABB());
  513. return particles->custom_aabb;
  514. }
  515. void ParticlesStorage::particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) {
  516. Particles *particles = particles_owner.get_or_null(p_particles);
  517. ERR_FAIL_COND(!particles);
  518. particles->emission_transform = p_transform;
  519. }
  520. int ParticlesStorage::particles_get_draw_passes(RID p_particles) const {
  521. const Particles *particles = particles_owner.get_or_null(p_particles);
  522. ERR_FAIL_COND_V(!particles, 0);
  523. return particles->draw_passes.size();
  524. }
  525. RID ParticlesStorage::particles_get_draw_pass_mesh(RID p_particles, int p_pass) const {
  526. const Particles *particles = particles_owner.get_or_null(p_particles);
  527. ERR_FAIL_COND_V(!particles, RID());
  528. ERR_FAIL_INDEX_V(p_pass, particles->draw_passes.size(), RID());
  529. return particles->draw_passes[p_pass];
  530. }
  531. void ParticlesStorage::particles_add_collision(RID p_particles, RID p_particles_collision_instance) {
  532. Particles *particles = particles_owner.get_or_null(p_particles);
  533. ERR_FAIL_COND(!particles);
  534. particles->collisions.insert(p_particles_collision_instance);
  535. }
  536. void ParticlesStorage::particles_remove_collision(RID p_particles, RID p_particles_collision_instance) {
  537. Particles *particles = particles_owner.get_or_null(p_particles);
  538. ERR_FAIL_COND(!particles);
  539. particles->collisions.erase(p_particles_collision_instance);
  540. }
  541. void ParticlesStorage::particles_set_canvas_sdf_collision(RID p_particles, bool p_enable, const Transform2D &p_xform, const Rect2 &p_to_screen, RID p_texture) {
  542. Particles *particles = particles_owner.get_or_null(p_particles);
  543. ERR_FAIL_COND(!particles);
  544. particles->has_sdf_collision = p_enable;
  545. particles->sdf_collision_transform = p_xform;
  546. particles->sdf_collision_to_screen = p_to_screen;
  547. particles->sdf_collision_texture = p_texture;
  548. }
  549. void ParticlesStorage::_particles_process(Particles *p_particles, double p_delta) {
  550. TextureStorage *texture_storage = TextureStorage::get_singleton();
  551. MaterialStorage *material_storage = MaterialStorage::get_singleton();
  552. if (p_particles->particles_material_uniform_set.is_null() || !RD::get_singleton()->uniform_set_is_valid(p_particles->particles_material_uniform_set)) {
  553. Vector<RD::Uniform> uniforms;
  554. {
  555. RD::Uniform u;
  556. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  557. u.binding = 0;
  558. u.append_id(p_particles->frame_params_buffer);
  559. uniforms.push_back(u);
  560. }
  561. {
  562. RD::Uniform u;
  563. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  564. u.binding = 1;
  565. u.append_id(p_particles->particle_buffer);
  566. uniforms.push_back(u);
  567. }
  568. {
  569. RD::Uniform u;
  570. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  571. u.binding = 2;
  572. if (p_particles->emission_storage_buffer.is_valid()) {
  573. u.append_id(p_particles->emission_storage_buffer);
  574. } else {
  575. u.append_id(MeshStorage::get_singleton()->get_default_rd_storage_buffer());
  576. }
  577. uniforms.push_back(u);
  578. }
  579. {
  580. RD::Uniform u;
  581. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  582. u.binding = 3;
  583. Particles *sub_emitter = particles_owner.get_or_null(p_particles->sub_emitter);
  584. if (sub_emitter) {
  585. if (sub_emitter->emission_buffer == nullptr) { //no emission buffer, allocate emission buffer
  586. _particles_allocate_emission_buffer(sub_emitter);
  587. }
  588. u.append_id(sub_emitter->emission_storage_buffer);
  589. } else {
  590. u.append_id(MeshStorage::get_singleton()->get_default_rd_storage_buffer());
  591. }
  592. uniforms.push_back(u);
  593. }
  594. p_particles->particles_material_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.default_shader_rd, 1);
  595. }
  596. double new_phase = Math::fmod((double)p_particles->phase + (p_delta / p_particles->lifetime) * p_particles->speed_scale, 1.0);
  597. //move back history (if there is any)
  598. for (uint32_t i = p_particles->frame_history.size() - 1; i > 0; i--) {
  599. p_particles->frame_history[i] = p_particles->frame_history[i - 1];
  600. }
  601. //update current frame
  602. ParticlesFrameParams &frame_params = p_particles->frame_history[0];
  603. if (p_particles->clear) {
  604. p_particles->cycle_number = 0;
  605. p_particles->random_seed = Math::rand();
  606. } else if (new_phase < p_particles->phase) {
  607. if (p_particles->one_shot) {
  608. p_particles->emitting = false;
  609. }
  610. p_particles->cycle_number++;
  611. }
  612. frame_params.emitting = p_particles->emitting;
  613. frame_params.system_phase = new_phase;
  614. frame_params.prev_system_phase = p_particles->phase;
  615. p_particles->phase = new_phase;
  616. frame_params.time = RendererCompositorRD::get_singleton()->get_total_time();
  617. frame_params.delta = p_delta * p_particles->speed_scale;
  618. frame_params.random_seed = p_particles->random_seed;
  619. frame_params.explosiveness = p_particles->explosiveness;
  620. frame_params.randomness = p_particles->randomness;
  621. if (p_particles->use_local_coords) {
  622. RendererRD::MaterialStorage::store_transform(Transform3D(), frame_params.emission_transform);
  623. } else {
  624. RendererRD::MaterialStorage::store_transform(p_particles->emission_transform, frame_params.emission_transform);
  625. }
  626. frame_params.cycle = p_particles->cycle_number;
  627. frame_params.frame = p_particles->frame_counter++;
  628. frame_params.pad0 = 0;
  629. frame_params.pad1 = 0;
  630. frame_params.pad2 = 0;
  631. { //collision and attractors
  632. frame_params.collider_count = 0;
  633. frame_params.attractor_count = 0;
  634. frame_params.particle_size = p_particles->collision_base_size;
  635. RID collision_3d_textures[ParticlesFrameParams::MAX_3D_TEXTURES];
  636. RID collision_heightmap_texture;
  637. Transform3D to_particles;
  638. if (p_particles->use_local_coords) {
  639. to_particles = p_particles->emission_transform.affine_inverse();
  640. }
  641. if (p_particles->has_sdf_collision && RD::get_singleton()->texture_is_valid(p_particles->sdf_collision_texture)) {
  642. //2D collision
  643. Transform2D xform = p_particles->sdf_collision_transform; //will use dotproduct manually so invert beforehand
  644. if (!p_particles->use_local_coords) {
  645. Transform2D emission;
  646. emission.columns[0] = Vector2(p_particles->emission_transform.basis.get_column(0).x, p_particles->emission_transform.basis.get_column(0).y);
  647. emission.columns[1] = Vector2(p_particles->emission_transform.basis.get_column(1).x, p_particles->emission_transform.basis.get_column(1).y);
  648. emission.set_origin(Vector2(p_particles->emission_transform.origin.x, p_particles->emission_transform.origin.y));
  649. xform = xform * emission.affine_inverse();
  650. }
  651. Transform2D revert = xform.affine_inverse();
  652. frame_params.collider_count = 1;
  653. frame_params.colliders[0].transform[0] = xform.columns[0][0];
  654. frame_params.colliders[0].transform[1] = xform.columns[0][1];
  655. frame_params.colliders[0].transform[2] = 0;
  656. frame_params.colliders[0].transform[3] = xform.columns[2][0];
  657. frame_params.colliders[0].transform[4] = xform.columns[1][0];
  658. frame_params.colliders[0].transform[5] = xform.columns[1][1];
  659. frame_params.colliders[0].transform[6] = 0;
  660. frame_params.colliders[0].transform[7] = xform.columns[2][1];
  661. frame_params.colliders[0].transform[8] = revert.columns[0][0];
  662. frame_params.colliders[0].transform[9] = revert.columns[0][1];
  663. frame_params.colliders[0].transform[10] = 0;
  664. frame_params.colliders[0].transform[11] = revert.columns[2][0];
  665. frame_params.colliders[0].transform[12] = revert.columns[1][0];
  666. frame_params.colliders[0].transform[13] = revert.columns[1][1];
  667. frame_params.colliders[0].transform[14] = 0;
  668. frame_params.colliders[0].transform[15] = revert.columns[2][1];
  669. frame_params.colliders[0].extents[0] = p_particles->sdf_collision_to_screen.size.x;
  670. frame_params.colliders[0].extents[1] = p_particles->sdf_collision_to_screen.size.y;
  671. frame_params.colliders[0].extents[2] = p_particles->sdf_collision_to_screen.position.x;
  672. frame_params.colliders[0].scale = p_particles->sdf_collision_to_screen.position.y;
  673. frame_params.colliders[0].texture_index = 0;
  674. frame_params.colliders[0].type = ParticlesFrameParams::COLLISION_TYPE_2D_SDF;
  675. collision_heightmap_texture = p_particles->sdf_collision_texture;
  676. //replace in all other history frames where used because parameters are no longer valid if screen moves
  677. for (ParticlesFrameParams &params : p_particles->frame_history) {
  678. if (params.collider_count > 0 && params.colliders[0].type == ParticlesFrameParams::COLLISION_TYPE_2D_SDF) {
  679. params.colliders[0] = frame_params.colliders[0];
  680. }
  681. }
  682. }
  683. uint32_t collision_3d_textures_used = 0;
  684. for (const RID &E : p_particles->collisions) {
  685. ParticlesCollisionInstance *pci = particles_collision_instance_owner.get_or_null(E);
  686. if (!pci || !pci->active) {
  687. continue;
  688. }
  689. ParticlesCollision *pc = particles_collision_owner.get_or_null(pci->collision);
  690. ERR_CONTINUE(!pc);
  691. Transform3D to_collider = pci->transform;
  692. if (p_particles->use_local_coords) {
  693. to_collider = to_particles * to_collider;
  694. }
  695. Vector3 scale = to_collider.basis.get_scale();
  696. to_collider.basis.orthonormalize();
  697. if (pc->type <= RS::PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT) {
  698. //attractor
  699. if (frame_params.attractor_count >= ParticlesFrameParams::MAX_ATTRACTORS) {
  700. continue;
  701. }
  702. ParticlesFrameParams::Attractor &attr = frame_params.attractors[frame_params.attractor_count];
  703. RendererRD::MaterialStorage::store_transform(to_collider, attr.transform);
  704. attr.strength = pc->attractor_strength;
  705. attr.attenuation = pc->attractor_attenuation;
  706. attr.directionality = pc->attractor_directionality;
  707. switch (pc->type) {
  708. case RS::PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT: {
  709. attr.type = ParticlesFrameParams::ATTRACTOR_TYPE_SPHERE;
  710. float radius = pc->radius;
  711. radius *= (scale.x + scale.y + scale.z) / 3.0;
  712. attr.extents[0] = radius;
  713. attr.extents[1] = radius;
  714. attr.extents[2] = radius;
  715. } break;
  716. case RS::PARTICLES_COLLISION_TYPE_BOX_ATTRACT: {
  717. attr.type = ParticlesFrameParams::ATTRACTOR_TYPE_BOX;
  718. Vector3 extents = pc->extents * scale;
  719. attr.extents[0] = extents.x;
  720. attr.extents[1] = extents.y;
  721. attr.extents[2] = extents.z;
  722. } break;
  723. case RS::PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT: {
  724. if (collision_3d_textures_used >= ParticlesFrameParams::MAX_3D_TEXTURES) {
  725. continue;
  726. }
  727. attr.type = ParticlesFrameParams::ATTRACTOR_TYPE_VECTOR_FIELD;
  728. Vector3 extents = pc->extents * scale;
  729. attr.extents[0] = extents.x;
  730. attr.extents[1] = extents.y;
  731. attr.extents[2] = extents.z;
  732. attr.texture_index = collision_3d_textures_used;
  733. collision_3d_textures[collision_3d_textures_used] = pc->field_texture;
  734. collision_3d_textures_used++;
  735. } break;
  736. default: {
  737. }
  738. }
  739. frame_params.attractor_count++;
  740. } else {
  741. //collider
  742. if (frame_params.collider_count >= ParticlesFrameParams::MAX_COLLIDERS) {
  743. continue;
  744. }
  745. ParticlesFrameParams::Collider &col = frame_params.colliders[frame_params.collider_count];
  746. RendererRD::MaterialStorage::store_transform(to_collider, col.transform);
  747. switch (pc->type) {
  748. case RS::PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE: {
  749. col.type = ParticlesFrameParams::COLLISION_TYPE_SPHERE;
  750. float radius = pc->radius;
  751. radius *= (scale.x + scale.y + scale.z) / 3.0;
  752. col.extents[0] = radius;
  753. col.extents[1] = radius;
  754. col.extents[2] = radius;
  755. } break;
  756. case RS::PARTICLES_COLLISION_TYPE_BOX_COLLIDE: {
  757. col.type = ParticlesFrameParams::COLLISION_TYPE_BOX;
  758. Vector3 extents = pc->extents * scale;
  759. col.extents[0] = extents.x;
  760. col.extents[1] = extents.y;
  761. col.extents[2] = extents.z;
  762. } break;
  763. case RS::PARTICLES_COLLISION_TYPE_SDF_COLLIDE: {
  764. if (collision_3d_textures_used >= ParticlesFrameParams::MAX_3D_TEXTURES) {
  765. continue;
  766. }
  767. col.type = ParticlesFrameParams::COLLISION_TYPE_SDF;
  768. Vector3 extents = pc->extents * scale;
  769. col.extents[0] = extents.x;
  770. col.extents[1] = extents.y;
  771. col.extents[2] = extents.z;
  772. col.texture_index = collision_3d_textures_used;
  773. col.scale = (scale.x + scale.y + scale.z) * 0.333333333333; //non uniform scale non supported
  774. collision_3d_textures[collision_3d_textures_used] = pc->field_texture;
  775. collision_3d_textures_used++;
  776. } break;
  777. case RS::PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE: {
  778. if (collision_heightmap_texture != RID()) { //already taken
  779. continue;
  780. }
  781. col.type = ParticlesFrameParams::COLLISION_TYPE_HEIGHT_FIELD;
  782. Vector3 extents = pc->extents * scale;
  783. col.extents[0] = extents.x;
  784. col.extents[1] = extents.y;
  785. col.extents[2] = extents.z;
  786. collision_heightmap_texture = pc->heightfield_texture;
  787. } break;
  788. default: {
  789. }
  790. }
  791. frame_params.collider_count++;
  792. }
  793. }
  794. bool different = false;
  795. if (collision_3d_textures_used == p_particles->collision_3d_textures_used) {
  796. for (int i = 0; i < ParticlesFrameParams::MAX_3D_TEXTURES; i++) {
  797. if (p_particles->collision_3d_textures[i] != collision_3d_textures[i]) {
  798. different = true;
  799. break;
  800. }
  801. }
  802. }
  803. if (collision_heightmap_texture != p_particles->collision_heightmap_texture) {
  804. different = true;
  805. }
  806. bool uniform_set_valid = RD::get_singleton()->uniform_set_is_valid(p_particles->collision_textures_uniform_set);
  807. if (different || !uniform_set_valid) {
  808. if (uniform_set_valid) {
  809. RD::get_singleton()->free(p_particles->collision_textures_uniform_set);
  810. }
  811. Vector<RD::Uniform> uniforms;
  812. {
  813. RD::Uniform u;
  814. u.uniform_type = RD::UNIFORM_TYPE_TEXTURE;
  815. u.binding = 0;
  816. for (uint32_t i = 0; i < ParticlesFrameParams::MAX_3D_TEXTURES; i++) {
  817. RID rd_tex;
  818. if (i < collision_3d_textures_used) {
  819. if (TextureStorage::get_singleton()->texture_get_type(collision_3d_textures[i]) == TextureStorage::TYPE_3D) {
  820. rd_tex = TextureStorage::get_singleton()->texture_get_rd_texture(collision_3d_textures[i]);
  821. }
  822. }
  823. if (rd_tex == RID()) {
  824. rd_tex = texture_storage->texture_rd_get_default(TextureStorage::DEFAULT_RD_TEXTURE_3D_WHITE);
  825. }
  826. u.append_id(rd_tex);
  827. }
  828. uniforms.push_back(u);
  829. }
  830. {
  831. RD::Uniform u;
  832. u.uniform_type = RD::UNIFORM_TYPE_TEXTURE;
  833. u.binding = 1;
  834. if (collision_heightmap_texture.is_valid()) {
  835. u.append_id(collision_heightmap_texture);
  836. } else {
  837. u.append_id(texture_storage->texture_rd_get_default(TextureStorage::DEFAULT_RD_TEXTURE_BLACK));
  838. }
  839. uniforms.push_back(u);
  840. }
  841. p_particles->collision_textures_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.default_shader_rd, 2);
  842. p_particles->collision_heightmap_texture = collision_heightmap_texture;
  843. }
  844. }
  845. ParticlesShader::PushConstant push_constant;
  846. int process_amount = p_particles->amount;
  847. if (p_particles->trails_enabled && p_particles->trail_bind_poses.size() > 1) {
  848. process_amount *= p_particles->trail_bind_poses.size();
  849. }
  850. push_constant.clear = p_particles->clear;
  851. push_constant.total_particles = p_particles->amount;
  852. push_constant.lifetime = p_particles->lifetime;
  853. push_constant.trail_size = p_particles->trail_params.size();
  854. push_constant.use_fractional_delta = p_particles->fractional_delta;
  855. push_constant.sub_emitter_mode = !p_particles->emitting && p_particles->emission_buffer && (p_particles->emission_buffer->particle_count > 0 || p_particles->force_sub_emit);
  856. push_constant.trail_pass = false;
  857. p_particles->force_sub_emit = false; //reset
  858. Particles *sub_emitter = particles_owner.get_or_null(p_particles->sub_emitter);
  859. if (sub_emitter && sub_emitter->emission_storage_buffer.is_valid()) {
  860. // print_line("updating subemitter buffer");
  861. int32_t zero[4] = { 0, sub_emitter->amount, 0, 0 };
  862. RD::get_singleton()->buffer_update(sub_emitter->emission_storage_buffer, 0, sizeof(uint32_t) * 4, zero);
  863. push_constant.can_emit = true;
  864. if (sub_emitter->emitting) {
  865. sub_emitter->emitting = false;
  866. sub_emitter->clear = true; //will need to clear if it was emitting, sorry
  867. }
  868. //make sure the sub emitter processes particles too
  869. sub_emitter->inactive = false;
  870. sub_emitter->inactive_time = 0;
  871. sub_emitter->force_sub_emit = true;
  872. } else {
  873. push_constant.can_emit = false;
  874. }
  875. if (p_particles->emission_buffer && p_particles->emission_buffer->particle_count) {
  876. RD::get_singleton()->buffer_update(p_particles->emission_storage_buffer, 0, sizeof(uint32_t) * 4 + sizeof(ParticleEmissionBuffer::Data) * p_particles->emission_buffer->particle_count, p_particles->emission_buffer);
  877. p_particles->emission_buffer->particle_count = 0;
  878. }
  879. p_particles->clear = false;
  880. if (p_particles->trail_params.size() > 1) {
  881. //fill the trail params
  882. for (uint32_t i = 0; i < p_particles->trail_params.size(); i++) {
  883. uint32_t src_idx = i * p_particles->frame_history.size() / p_particles->trail_params.size();
  884. p_particles->trail_params[i] = p_particles->frame_history[src_idx];
  885. }
  886. } else {
  887. p_particles->trail_params[0] = p_particles->frame_history[0];
  888. }
  889. RD::get_singleton()->buffer_update(p_particles->frame_params_buffer, 0, sizeof(ParticlesFrameParams) * p_particles->trail_params.size(), p_particles->trail_params.ptr());
  890. ParticleProcessMaterialData *m = static_cast<ParticleProcessMaterialData *>(material_storage->material_get_data(p_particles->process_material, MaterialStorage::SHADER_TYPE_PARTICLES));
  891. if (!m) {
  892. m = static_cast<ParticleProcessMaterialData *>(material_storage->material_get_data(particles_shader.default_material, MaterialStorage::SHADER_TYPE_PARTICLES));
  893. }
  894. ERR_FAIL_COND(!m);
  895. p_particles->has_collision_cache = m->shader_data->uses_collision;
  896. //todo should maybe compute all particle systems together?
  897. RD::ComputeListID compute_list = RD::get_singleton()->compute_list_begin();
  898. RD::get_singleton()->compute_list_bind_compute_pipeline(compute_list, m->shader_data->pipeline);
  899. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles_shader.base_uniform_set, BASE_UNIFORM_SET);
  900. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, p_particles->particles_material_uniform_set, MATERIAL_UNIFORM_SET);
  901. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, p_particles->collision_textures_uniform_set, COLLISION_TEXTURTES_UNIFORM_SET);
  902. if (m->uniform_set.is_valid() && RD::get_singleton()->uniform_set_is_valid(m->uniform_set)) {
  903. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, m->uniform_set, 3);
  904. m->set_as_used();
  905. }
  906. RD::get_singleton()->compute_list_set_push_constant(compute_list, &push_constant, sizeof(ParticlesShader::PushConstant));
  907. if (p_particles->trails_enabled && p_particles->trail_bind_poses.size() > 1) {
  908. //trails requires two passes in order to catch particle starts
  909. RD::get_singleton()->compute_list_dispatch_threads(compute_list, process_amount / p_particles->trail_bind_poses.size(), 1, 1);
  910. RD::get_singleton()->compute_list_add_barrier(compute_list);
  911. push_constant.trail_pass = true;
  912. RD::get_singleton()->compute_list_set_push_constant(compute_list, &push_constant, sizeof(ParticlesShader::PushConstant));
  913. RD::get_singleton()->compute_list_dispatch_threads(compute_list, process_amount - p_particles->amount, 1, 1);
  914. } else {
  915. RD::get_singleton()->compute_list_dispatch_threads(compute_list, process_amount, 1, 1);
  916. }
  917. RD::get_singleton()->compute_list_end();
  918. }
  919. void ParticlesStorage::particles_set_view_axis(RID p_particles, const Vector3 &p_axis, const Vector3 &p_up_axis) {
  920. Particles *particles = particles_owner.get_or_null(p_particles);
  921. ERR_FAIL_COND(!particles);
  922. if (particles->draw_order != RS::PARTICLES_DRAW_ORDER_VIEW_DEPTH && particles->transform_align != RS::PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD && particles->transform_align != RS::PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY) {
  923. return;
  924. }
  925. if (particles->particle_buffer.is_null() || particles->trail_bind_pose_uniform_set.is_null()) {
  926. return; //particles have not processed yet
  927. }
  928. bool do_sort = particles->draw_order == RS::PARTICLES_DRAW_ORDER_VIEW_DEPTH;
  929. //copy to sort buffer
  930. if (do_sort && particles->particles_sort_buffer == RID()) {
  931. uint32_t size = particles->amount;
  932. if (size & 1) {
  933. size++; //make multiple of 16
  934. }
  935. size *= sizeof(float) * 2;
  936. particles->particles_sort_buffer = RD::get_singleton()->storage_buffer_create(size);
  937. {
  938. Vector<RD::Uniform> uniforms;
  939. {
  940. RD::Uniform u;
  941. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  942. u.binding = 0;
  943. u.append_id(particles->particles_sort_buffer);
  944. uniforms.push_back(u);
  945. }
  946. particles->particles_sort_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.copy_shader.version_get_shader(particles_shader.copy_shader_version, ParticlesShader::COPY_MODE_FILL_SORT_BUFFER), 1);
  947. }
  948. }
  949. ParticlesShader::CopyPushConstant copy_push_constant;
  950. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  951. int fixed_fps = 60.0;
  952. if (particles->fixed_fps > 0) {
  953. fixed_fps = particles->fixed_fps;
  954. }
  955. copy_push_constant.trail_size = particles->trail_bind_poses.size();
  956. copy_push_constant.trail_total = particles->frame_history.size();
  957. copy_push_constant.frame_delta = 1.0 / fixed_fps;
  958. } else {
  959. copy_push_constant.trail_size = 1;
  960. copy_push_constant.trail_total = 1;
  961. copy_push_constant.frame_delta = 0.0;
  962. }
  963. copy_push_constant.order_by_lifetime = (particles->draw_order == RS::PARTICLES_DRAW_ORDER_LIFETIME || particles->draw_order == RS::PARTICLES_DRAW_ORDER_REVERSE_LIFETIME);
  964. copy_push_constant.lifetime_split = (MIN(int(particles->amount * particles->phase), particles->amount - 1) + 1) % particles->amount;
  965. copy_push_constant.lifetime_reverse = particles->draw_order == RS::PARTICLES_DRAW_ORDER_REVERSE_LIFETIME;
  966. copy_push_constant.frame_remainder = particles->interpolate ? particles->frame_remainder : 0.0;
  967. copy_push_constant.total_particles = particles->amount;
  968. copy_push_constant.copy_mode_2d = false;
  969. Vector3 axis = -p_axis; // cameras look to z negative
  970. if (particles->use_local_coords) {
  971. axis = particles->emission_transform.basis.xform_inv(axis).normalized();
  972. }
  973. copy_push_constant.sort_direction[0] = axis.x;
  974. copy_push_constant.sort_direction[1] = axis.y;
  975. copy_push_constant.sort_direction[2] = axis.z;
  976. copy_push_constant.align_up[0] = p_up_axis.x;
  977. copy_push_constant.align_up[1] = p_up_axis.y;
  978. copy_push_constant.align_up[2] = p_up_axis.z;
  979. copy_push_constant.align_mode = particles->transform_align;
  980. if (do_sort) {
  981. RD::ComputeListID compute_list = RD::get_singleton()->compute_list_begin();
  982. RD::get_singleton()->compute_list_bind_compute_pipeline(compute_list, particles_shader.copy_pipelines[ParticlesShader::COPY_MODE_FILL_SORT_BUFFER + particles->userdata_count * ParticlesShader::COPY_MODE_MAX]);
  983. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->particles_copy_uniform_set, 0);
  984. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->particles_sort_uniform_set, 1);
  985. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->trail_bind_pose_uniform_set, 2);
  986. RD::get_singleton()->compute_list_set_push_constant(compute_list, &copy_push_constant, sizeof(ParticlesShader::CopyPushConstant));
  987. RD::get_singleton()->compute_list_dispatch_threads(compute_list, particles->amount, 1, 1);
  988. RD::get_singleton()->compute_list_end();
  989. sort_effects->sort_buffer(particles->particles_sort_uniform_set, particles->amount);
  990. }
  991. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  992. copy_push_constant.total_particles *= particles->trail_bind_poses.size();
  993. }
  994. RD::ComputeListID compute_list = RD::get_singleton()->compute_list_begin();
  995. uint32_t copy_pipeline = do_sort ? ParticlesShader::COPY_MODE_FILL_INSTANCES_WITH_SORT_BUFFER : ParticlesShader::COPY_MODE_FILL_INSTANCES;
  996. copy_pipeline += particles->userdata_count * ParticlesShader::COPY_MODE_MAX;
  997. copy_push_constant.copy_mode_2d = particles->mode == RS::PARTICLES_MODE_2D ? 1 : 0;
  998. RD::get_singleton()->compute_list_bind_compute_pipeline(compute_list, particles_shader.copy_pipelines[copy_pipeline]);
  999. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->particles_copy_uniform_set, 0);
  1000. if (do_sort) {
  1001. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->particles_sort_uniform_set, 1);
  1002. }
  1003. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->trail_bind_pose_uniform_set, 2);
  1004. RD::get_singleton()->compute_list_set_push_constant(compute_list, &copy_push_constant, sizeof(ParticlesShader::CopyPushConstant));
  1005. RD::get_singleton()->compute_list_dispatch_threads(compute_list, copy_push_constant.total_particles, 1, 1);
  1006. RD::get_singleton()->compute_list_end();
  1007. }
  1008. void ParticlesStorage::_particles_update_buffers(Particles *particles) {
  1009. uint32_t userdata_count = 0;
  1010. MaterialStorage::ShaderData *shader_data = MaterialStorage::get_singleton()->material_get_shader_data(particles->process_material);
  1011. if (shader_data) {
  1012. const ParticlesShaderData *particle_shader_data = static_cast<const ParticlesShaderData *>(shader_data);
  1013. userdata_count = particle_shader_data->userdata_count;
  1014. }
  1015. if (userdata_count != particles->userdata_count) {
  1016. // Mismatch userdata, re-create buffers.
  1017. _particles_free_data(particles);
  1018. }
  1019. if (particles->amount > 0 && particles->particle_buffer.is_null()) {
  1020. int total_amount = particles->amount;
  1021. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  1022. total_amount *= particles->trail_bind_poses.size();
  1023. }
  1024. uint32_t xform_size = particles->mode == RS::PARTICLES_MODE_2D ? 2 : 3;
  1025. particles->particle_buffer = RD::get_singleton()->storage_buffer_create((sizeof(ParticleData) + userdata_count * sizeof(float) * 4) * total_amount);
  1026. particles->userdata_count = userdata_count;
  1027. PackedByteArray data;
  1028. data.resize_zeroed(sizeof(float) * 4 * (xform_size + 1 + 1) * total_amount);
  1029. particles->particle_instance_buffer = RD::get_singleton()->storage_buffer_create(sizeof(float) * 4 * (xform_size + 1 + 1) * total_amount, data);
  1030. //needs to clear it
  1031. {
  1032. Vector<RD::Uniform> uniforms;
  1033. {
  1034. RD::Uniform u;
  1035. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  1036. u.binding = 1;
  1037. u.append_id(particles->particle_buffer);
  1038. uniforms.push_back(u);
  1039. }
  1040. {
  1041. RD::Uniform u;
  1042. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  1043. u.binding = 2;
  1044. u.append_id(particles->particle_instance_buffer);
  1045. uniforms.push_back(u);
  1046. }
  1047. particles->particles_copy_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.copy_shader.version_get_shader(particles_shader.copy_shader_version, 0), 0);
  1048. }
  1049. }
  1050. }
  1051. void ParticlesStorage::update_particles() {
  1052. while (particle_update_list) {
  1053. //use transform feedback to process particles
  1054. Particles *particles = particle_update_list;
  1055. //take and remove
  1056. particle_update_list = particles->update_list;
  1057. particles->update_list = nullptr;
  1058. particles->dirty = false;
  1059. _particles_update_buffers(particles);
  1060. if (particles->restart_request) {
  1061. particles->prev_ticks = 0;
  1062. particles->phase = 0;
  1063. particles->prev_phase = 0;
  1064. particles->clear = true;
  1065. particles->restart_request = false;
  1066. }
  1067. if (particles->inactive && !particles->emitting) {
  1068. //go next
  1069. continue;
  1070. }
  1071. if (particles->emitting) {
  1072. if (particles->inactive) {
  1073. //restart system from scratch
  1074. particles->prev_ticks = 0;
  1075. particles->phase = 0;
  1076. particles->prev_phase = 0;
  1077. particles->clear = true;
  1078. }
  1079. particles->inactive = false;
  1080. particles->inactive_time = 0;
  1081. } else {
  1082. particles->inactive_time += particles->speed_scale * RendererCompositorRD::get_singleton()->get_frame_delta_time();
  1083. if (particles->inactive_time > particles->lifetime * 1.2) {
  1084. particles->inactive = true;
  1085. continue;
  1086. }
  1087. }
  1088. // TODO: Should use display refresh rate for all this.
  1089. float screen_hz = 60;
  1090. int fixed_fps = 0;
  1091. if (particles->fixed_fps > 0) {
  1092. fixed_fps = particles->fixed_fps;
  1093. } else if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  1094. fixed_fps = screen_hz;
  1095. }
  1096. {
  1097. //update trails
  1098. int history_size = 1;
  1099. int trail_steps = 1;
  1100. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  1101. history_size = MAX(1, int(particles->trail_lifetime * fixed_fps));
  1102. trail_steps = particles->trail_bind_poses.size();
  1103. }
  1104. if (uint32_t(history_size) != particles->frame_history.size()) {
  1105. particles->frame_history.resize(history_size);
  1106. memset(particles->frame_history.ptr(), 0, sizeof(ParticlesFrameParams) * history_size);
  1107. }
  1108. if (uint32_t(trail_steps) != particles->trail_params.size() || particles->frame_params_buffer.is_null()) {
  1109. particles->trail_params.resize(trail_steps);
  1110. if (particles->frame_params_buffer.is_valid()) {
  1111. RD::get_singleton()->free(particles->frame_params_buffer);
  1112. }
  1113. particles->frame_params_buffer = RD::get_singleton()->storage_buffer_create(sizeof(ParticlesFrameParams) * trail_steps);
  1114. }
  1115. if (particles->trail_bind_poses.size() > 1 && particles->trail_bind_pose_buffer.is_null()) {
  1116. particles->trail_bind_pose_buffer = RD::get_singleton()->storage_buffer_create(sizeof(float) * 16 * particles->trail_bind_poses.size());
  1117. particles->trail_bind_poses_dirty = true;
  1118. }
  1119. if (particles->trail_bind_pose_uniform_set.is_null()) {
  1120. Vector<RD::Uniform> uniforms;
  1121. {
  1122. RD::Uniform u;
  1123. u.uniform_type = RD::UNIFORM_TYPE_STORAGE_BUFFER;
  1124. u.binding = 0;
  1125. if (particles->trail_bind_pose_buffer.is_valid()) {
  1126. u.append_id(particles->trail_bind_pose_buffer);
  1127. } else {
  1128. u.append_id(MeshStorage::get_singleton()->get_default_rd_storage_buffer());
  1129. }
  1130. uniforms.push_back(u);
  1131. }
  1132. particles->trail_bind_pose_uniform_set = RD::get_singleton()->uniform_set_create(uniforms, particles_shader.copy_shader.version_get_shader(particles_shader.copy_shader_version, 0), 2);
  1133. }
  1134. if (particles->trail_bind_pose_buffer.is_valid() && particles->trail_bind_poses_dirty) {
  1135. if (particles_shader.pose_update_buffer.size() < uint32_t(particles->trail_bind_poses.size()) * 16) {
  1136. particles_shader.pose_update_buffer.resize(particles->trail_bind_poses.size() * 16);
  1137. }
  1138. for (int i = 0; i < particles->trail_bind_poses.size(); i++) {
  1139. RendererRD::MaterialStorage::store_transform(particles->trail_bind_poses[i], &particles_shader.pose_update_buffer[i * 16]);
  1140. }
  1141. RD::get_singleton()->buffer_update(particles->trail_bind_pose_buffer, 0, particles->trail_bind_poses.size() * 16 * sizeof(float), particles_shader.pose_update_buffer.ptr());
  1142. }
  1143. }
  1144. bool zero_time_scale = Engine::get_singleton()->get_time_scale() <= 0.0;
  1145. if (particles->clear && particles->pre_process_time > 0.0) {
  1146. double frame_time;
  1147. if (fixed_fps > 0) {
  1148. frame_time = 1.0 / fixed_fps;
  1149. } else {
  1150. frame_time = 1.0 / 30.0;
  1151. }
  1152. double todo = particles->pre_process_time;
  1153. while (todo >= 0) {
  1154. _particles_process(particles, frame_time);
  1155. todo -= frame_time;
  1156. }
  1157. }
  1158. if (fixed_fps > 0) {
  1159. double frame_time;
  1160. double decr;
  1161. if (zero_time_scale) {
  1162. frame_time = 0.0;
  1163. decr = 1.0 / fixed_fps;
  1164. } else {
  1165. frame_time = 1.0 / fixed_fps;
  1166. decr = frame_time;
  1167. }
  1168. double delta = RendererCompositorRD::get_singleton()->get_frame_delta_time();
  1169. if (delta > 0.1) { //avoid recursive stalls if fps goes below 10
  1170. delta = 0.1;
  1171. } else if (delta <= 0.0) { //unlikely but..
  1172. delta = 0.001;
  1173. }
  1174. double todo = particles->frame_remainder + delta;
  1175. while (todo >= frame_time || particles->clear) {
  1176. _particles_process(particles, frame_time);
  1177. todo -= decr;
  1178. }
  1179. particles->frame_remainder = todo;
  1180. } else {
  1181. if (zero_time_scale) {
  1182. _particles_process(particles, 0.0);
  1183. } else {
  1184. _particles_process(particles, RendererCompositorRD::get_singleton()->get_frame_delta_time());
  1185. }
  1186. }
  1187. // Ensure that memory is initialized (the code above should ensure that _particles_process is always called at least once upon clearing).
  1188. DEV_ASSERT(!particles->clear);
  1189. // Copy particles to instance buffer.
  1190. if (particles->draw_order != RS::PARTICLES_DRAW_ORDER_VIEW_DEPTH && particles->transform_align != RS::PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD && particles->transform_align != RS::PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY) {
  1191. //does not need view dependent operation, do copy here
  1192. ParticlesShader::CopyPushConstant copy_push_constant;
  1193. int total_amount = particles->amount;
  1194. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  1195. total_amount *= particles->trail_bind_poses.size();
  1196. }
  1197. // Affect 2D only.
  1198. if (particles->use_local_coords) {
  1199. // In local mode, particle positions are calculated locally (relative to the node position)
  1200. // and they're also drawn locally.
  1201. // It works as expected, so we just pass an identity transform.
  1202. RendererRD::MaterialStorage::store_transform(Transform3D(), copy_push_constant.inv_emission_transform);
  1203. } else {
  1204. // In global mode, particle positions are calculated globally (relative to the canvas origin)
  1205. // but they're drawn locally.
  1206. // So, we need to pass the inverse of the emission transform to bring the
  1207. // particles to local coordinates before drawing.
  1208. Transform3D inv = particles->emission_transform.affine_inverse();
  1209. RendererRD::MaterialStorage::store_transform(inv, copy_push_constant.inv_emission_transform);
  1210. }
  1211. copy_push_constant.total_particles = total_amount;
  1212. copy_push_constant.frame_remainder = particles->interpolate ? particles->frame_remainder : 0.0;
  1213. copy_push_constant.align_mode = particles->transform_align;
  1214. copy_push_constant.align_up[0] = 0;
  1215. copy_push_constant.align_up[1] = 0;
  1216. copy_push_constant.align_up[2] = 0;
  1217. if (particles->trails_enabled && particles->trail_bind_poses.size() > 1) {
  1218. copy_push_constant.trail_size = particles->trail_bind_poses.size();
  1219. copy_push_constant.trail_total = particles->frame_history.size();
  1220. copy_push_constant.frame_delta = 1.0 / fixed_fps;
  1221. } else {
  1222. copy_push_constant.trail_size = 1;
  1223. copy_push_constant.trail_total = 1;
  1224. copy_push_constant.frame_delta = 0.0;
  1225. }
  1226. copy_push_constant.order_by_lifetime = (particles->draw_order == RS::PARTICLES_DRAW_ORDER_LIFETIME || particles->draw_order == RS::PARTICLES_DRAW_ORDER_REVERSE_LIFETIME);
  1227. copy_push_constant.lifetime_split = (MIN(int(particles->amount * particles->phase), particles->amount - 1) + 1) % particles->amount;
  1228. copy_push_constant.lifetime_reverse = particles->draw_order == RS::PARTICLES_DRAW_ORDER_REVERSE_LIFETIME;
  1229. RD::ComputeListID compute_list = RD::get_singleton()->compute_list_begin();
  1230. copy_push_constant.copy_mode_2d = particles->mode == RS::PARTICLES_MODE_2D ? 1 : 0;
  1231. RD::get_singleton()->compute_list_bind_compute_pipeline(compute_list, particles_shader.copy_pipelines[ParticlesShader::COPY_MODE_FILL_INSTANCES + particles->userdata_count * ParticlesShader::COPY_MODE_MAX]);
  1232. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->particles_copy_uniform_set, 0);
  1233. RD::get_singleton()->compute_list_bind_uniform_set(compute_list, particles->trail_bind_pose_uniform_set, 2);
  1234. RD::get_singleton()->compute_list_set_push_constant(compute_list, &copy_push_constant, sizeof(ParticlesShader::CopyPushConstant));
  1235. RD::get_singleton()->compute_list_dispatch_threads(compute_list, total_amount, 1, 1);
  1236. RD::get_singleton()->compute_list_end();
  1237. }
  1238. particles->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  1239. }
  1240. }
  1241. Dependency *ParticlesStorage::particles_get_dependency(RID p_particles) const {
  1242. Particles *particles = particles_owner.get_or_null(p_particles);
  1243. ERR_FAIL_NULL_V(particles, nullptr);
  1244. return &particles->dependency;
  1245. }
  1246. bool ParticlesStorage::particles_is_inactive(RID p_particles) const {
  1247. ERR_FAIL_COND_V_MSG(RSG::threaded, false, "This function should never be used with threaded rendering, as it stalls the renderer.");
  1248. const Particles *particles = particles_owner.get_or_null(p_particles);
  1249. ERR_FAIL_COND_V(!particles, false);
  1250. return !particles->emitting && particles->inactive;
  1251. }
  1252. /* Particles SHADER */
  1253. void ParticlesStorage::ParticlesShaderData::set_code(const String &p_code) {
  1254. ParticlesStorage *particles_storage = ParticlesStorage::get_singleton();
  1255. //compile
  1256. code = p_code;
  1257. valid = false;
  1258. ubo_size = 0;
  1259. uniforms.clear();
  1260. uses_collision = false;
  1261. if (code.is_empty()) {
  1262. return; //just invalid, but no error
  1263. }
  1264. ShaderCompiler::GeneratedCode gen_code;
  1265. ShaderCompiler::IdentifierActions actions;
  1266. actions.entry_point_stages["start"] = ShaderCompiler::STAGE_COMPUTE;
  1267. actions.entry_point_stages["process"] = ShaderCompiler::STAGE_COMPUTE;
  1268. /*
  1269. uses_time = false;
  1270. actions.render_mode_flags["use_half_res_pass"] = &uses_half_res;
  1271. actions.render_mode_flags["use_quarter_res_pass"] = &uses_quarter_res;
  1272. actions.usage_flag_pointers["TIME"] = &uses_time;
  1273. */
  1274. actions.usage_flag_pointers["COLLIDED"] = &uses_collision;
  1275. userdata_count = 0;
  1276. for (uint32_t i = 0; i < ParticlesShader::MAX_USERDATAS; i++) {
  1277. userdatas_used[i] = false;
  1278. actions.usage_flag_pointers["USERDATA" + itos(i + 1)] = &userdatas_used[i];
  1279. }
  1280. actions.uniforms = &uniforms;
  1281. Error err = particles_storage->particles_shader.compiler.compile(RS::SHADER_PARTICLES, code, &actions, path, gen_code);
  1282. ERR_FAIL_COND_MSG(err != OK, "Shader compilation failed.");
  1283. if (version.is_null()) {
  1284. version = particles_storage->particles_shader.shader.version_create();
  1285. }
  1286. for (uint32_t i = 0; i < ParticlesShader::MAX_USERDATAS; i++) {
  1287. if (userdatas_used[i]) {
  1288. userdata_count++;
  1289. }
  1290. }
  1291. particles_storage->particles_shader.shader.version_set_compute_code(version, gen_code.code, gen_code.uniforms, gen_code.stage_globals[ShaderCompiler::STAGE_COMPUTE], gen_code.defines);
  1292. ERR_FAIL_COND(!particles_storage->particles_shader.shader.version_is_valid(version));
  1293. ubo_size = gen_code.uniform_total_size;
  1294. ubo_offsets = gen_code.uniform_offsets;
  1295. texture_uniforms = gen_code.texture_uniforms;
  1296. //update pipelines
  1297. pipeline = RD::get_singleton()->compute_pipeline_create(particles_storage->particles_shader.shader.version_get_shader(version, 0));
  1298. valid = true;
  1299. }
  1300. bool ParticlesStorage::ParticlesShaderData::is_animated() const {
  1301. return false;
  1302. }
  1303. bool ParticlesStorage::ParticlesShaderData::casts_shadows() const {
  1304. return false;
  1305. }
  1306. RS::ShaderNativeSourceCode ParticlesStorage::ParticlesShaderData::get_native_source_code() const {
  1307. return ParticlesStorage::get_singleton()->particles_shader.shader.version_get_native_source_code(version);
  1308. }
  1309. ParticlesStorage::ParticlesShaderData::~ParticlesShaderData() {
  1310. //pipeline variants will clear themselves if shader is gone
  1311. if (version.is_valid()) {
  1312. ParticlesStorage::get_singleton()->particles_shader.shader.version_free(version);
  1313. }
  1314. }
  1315. MaterialStorage::ShaderData *ParticlesStorage::_create_particles_shader_func() {
  1316. ParticlesShaderData *shader_data = memnew(ParticlesShaderData);
  1317. return shader_data;
  1318. }
  1319. bool ParticlesStorage::ParticleProcessMaterialData::update_parameters(const HashMap<StringName, Variant> &p_parameters, bool p_uniform_dirty, bool p_textures_dirty) {
  1320. return update_parameters_uniform_set(p_parameters, p_uniform_dirty, p_textures_dirty, shader_data->uniforms, shader_data->ubo_offsets.ptr(), shader_data->texture_uniforms, shader_data->default_texture_params, shader_data->ubo_size, uniform_set, ParticlesStorage::get_singleton()->particles_shader.shader.version_get_shader(shader_data->version, 0), 3, true, false);
  1321. }
  1322. ParticlesStorage::ParticleProcessMaterialData::~ParticleProcessMaterialData() {
  1323. free_parameters_uniform_set(uniform_set);
  1324. }
  1325. MaterialStorage::MaterialData *ParticlesStorage::_create_particles_material_func(ParticlesShaderData *p_shader) {
  1326. ParticleProcessMaterialData *material_data = memnew(ParticleProcessMaterialData);
  1327. material_data->shader_data = p_shader;
  1328. //update will happen later anyway so do nothing.
  1329. return material_data;
  1330. }
  1331. ////////
  1332. /* PARTICLES COLLISION API */
  1333. RID ParticlesStorage::particles_collision_allocate() {
  1334. return particles_collision_owner.allocate_rid();
  1335. }
  1336. void ParticlesStorage::particles_collision_initialize(RID p_rid) {
  1337. particles_collision_owner.initialize_rid(p_rid, ParticlesCollision());
  1338. }
  1339. void ParticlesStorage::particles_collision_free(RID p_rid) {
  1340. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_rid);
  1341. if (particles_collision->heightfield_texture.is_valid()) {
  1342. RD::get_singleton()->free(particles_collision->heightfield_texture);
  1343. }
  1344. particles_collision->dependency.deleted_notify(p_rid);
  1345. particles_collision_owner.free(p_rid);
  1346. }
  1347. RID ParticlesStorage::particles_collision_get_heightfield_framebuffer(RID p_particles_collision) const {
  1348. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1349. ERR_FAIL_COND_V(!particles_collision, RID());
  1350. ERR_FAIL_COND_V(particles_collision->type != RS::PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE, RID());
  1351. if (particles_collision->heightfield_texture == RID()) {
  1352. //create
  1353. const int resolutions[RS::PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX] = { 256, 512, 1024, 2048, 4096, 8192 };
  1354. Size2i size;
  1355. if (particles_collision->extents.x > particles_collision->extents.z) {
  1356. size.x = resolutions[particles_collision->heightfield_resolution];
  1357. size.y = int32_t(particles_collision->extents.z / particles_collision->extents.x * size.x);
  1358. } else {
  1359. size.y = resolutions[particles_collision->heightfield_resolution];
  1360. size.x = int32_t(particles_collision->extents.x / particles_collision->extents.z * size.y);
  1361. }
  1362. RD::TextureFormat tf;
  1363. tf.format = RD::DATA_FORMAT_D32_SFLOAT;
  1364. tf.width = size.x;
  1365. tf.height = size.y;
  1366. tf.texture_type = RD::TEXTURE_TYPE_2D;
  1367. tf.usage_bits = RD::TEXTURE_USAGE_SAMPLING_BIT | RD::TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
  1368. particles_collision->heightfield_texture = RD::get_singleton()->texture_create(tf, RD::TextureView());
  1369. Vector<RID> fb_tex;
  1370. fb_tex.push_back(particles_collision->heightfield_texture);
  1371. particles_collision->heightfield_fb = RD::get_singleton()->framebuffer_create(fb_tex);
  1372. particles_collision->heightfield_fb_size = size;
  1373. }
  1374. return particles_collision->heightfield_fb;
  1375. }
  1376. void ParticlesStorage::particles_collision_set_collision_type(RID p_particles_collision, RS::ParticlesCollisionType p_type) {
  1377. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1378. ERR_FAIL_COND(!particles_collision);
  1379. if (p_type == particles_collision->type) {
  1380. return;
  1381. }
  1382. if (particles_collision->heightfield_texture.is_valid()) {
  1383. RD::get_singleton()->free(particles_collision->heightfield_texture);
  1384. particles_collision->heightfield_texture = RID();
  1385. }
  1386. particles_collision->type = p_type;
  1387. particles_collision->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  1388. }
  1389. void ParticlesStorage::particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) {
  1390. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1391. ERR_FAIL_COND(!particles_collision);
  1392. particles_collision->cull_mask = p_cull_mask;
  1393. }
  1394. void ParticlesStorage::particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) {
  1395. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1396. ERR_FAIL_COND(!particles_collision);
  1397. particles_collision->radius = p_radius;
  1398. particles_collision->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  1399. }
  1400. void ParticlesStorage::particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) {
  1401. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1402. ERR_FAIL_COND(!particles_collision);
  1403. particles_collision->extents = p_extents;
  1404. particles_collision->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  1405. }
  1406. void ParticlesStorage::particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) {
  1407. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1408. ERR_FAIL_COND(!particles_collision);
  1409. particles_collision->attractor_strength = p_strength;
  1410. }
  1411. void ParticlesStorage::particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) {
  1412. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1413. ERR_FAIL_COND(!particles_collision);
  1414. particles_collision->attractor_directionality = p_directionality;
  1415. }
  1416. void ParticlesStorage::particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) {
  1417. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1418. ERR_FAIL_COND(!particles_collision);
  1419. particles_collision->attractor_attenuation = p_curve;
  1420. }
  1421. void ParticlesStorage::particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) {
  1422. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1423. ERR_FAIL_COND(!particles_collision);
  1424. particles_collision->field_texture = p_texture;
  1425. }
  1426. void ParticlesStorage::particles_collision_height_field_update(RID p_particles_collision) {
  1427. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1428. ERR_FAIL_COND(!particles_collision);
  1429. particles_collision->dependency.changed_notify(Dependency::DEPENDENCY_CHANGED_AABB);
  1430. }
  1431. void ParticlesStorage::particles_collision_set_height_field_resolution(RID p_particles_collision, RS::ParticlesCollisionHeightfieldResolution p_resolution) {
  1432. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1433. ERR_FAIL_COND(!particles_collision);
  1434. ERR_FAIL_INDEX(p_resolution, RS::PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX);
  1435. if (particles_collision->heightfield_resolution == p_resolution) {
  1436. return;
  1437. }
  1438. particles_collision->heightfield_resolution = p_resolution;
  1439. if (particles_collision->heightfield_texture.is_valid()) {
  1440. RD::get_singleton()->free(particles_collision->heightfield_texture);
  1441. particles_collision->heightfield_texture = RID();
  1442. }
  1443. }
  1444. AABB ParticlesStorage::particles_collision_get_aabb(RID p_particles_collision) const {
  1445. ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1446. ERR_FAIL_COND_V(!particles_collision, AABB());
  1447. switch (particles_collision->type) {
  1448. case RS::PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1449. case RS::PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE: {
  1450. AABB aabb;
  1451. aabb.position = -Vector3(1, 1, 1) * particles_collision->radius;
  1452. aabb.size = Vector3(2, 2, 2) * particles_collision->radius;
  1453. return aabb;
  1454. }
  1455. default: {
  1456. AABB aabb;
  1457. aabb.position = -particles_collision->extents;
  1458. aabb.size = particles_collision->extents * 2;
  1459. return aabb;
  1460. }
  1461. }
  1462. }
  1463. Vector3 ParticlesStorage::particles_collision_get_extents(RID p_particles_collision) const {
  1464. const ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1465. ERR_FAIL_COND_V(!particles_collision, Vector3());
  1466. return particles_collision->extents;
  1467. }
  1468. bool ParticlesStorage::particles_collision_is_heightfield(RID p_particles_collision) const {
  1469. const ParticlesCollision *particles_collision = particles_collision_owner.get_or_null(p_particles_collision);
  1470. ERR_FAIL_COND_V(!particles_collision, false);
  1471. return particles_collision->type == RS::PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE;
  1472. }
  1473. Dependency *ParticlesStorage::particles_collision_get_dependency(RID p_particles_collision) const {
  1474. ParticlesCollision *pc = particles_collision_owner.get_or_null(p_particles_collision);
  1475. ERR_FAIL_NULL_V(pc, nullptr);
  1476. return &pc->dependency;
  1477. }
  1478. /* Particles collision instance */
  1479. RID ParticlesStorage::particles_collision_instance_create(RID p_collision) {
  1480. ParticlesCollisionInstance pci;
  1481. pci.collision = p_collision;
  1482. return particles_collision_instance_owner.make_rid(pci);
  1483. }
  1484. void ParticlesStorage::particles_collision_instance_free(RID p_rid) {
  1485. particles_collision_instance_owner.free(p_rid);
  1486. }
  1487. void ParticlesStorage::particles_collision_instance_set_transform(RID p_collision_instance, const Transform3D &p_transform) {
  1488. ParticlesCollisionInstance *pci = particles_collision_instance_owner.get_or_null(p_collision_instance);
  1489. ERR_FAIL_COND(!pci);
  1490. pci->transform = p_transform;
  1491. }
  1492. void ParticlesStorage::particles_collision_instance_set_active(RID p_collision_instance, bool p_active) {
  1493. ParticlesCollisionInstance *pci = particles_collision_instance_owner.get_or_null(p_collision_instance);
  1494. ERR_FAIL_COND(!pci);
  1495. pci->active = p_active;
  1496. }