rendering_server.h 73 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687
  1. /*************************************************************************/
  2. /* rendering_server.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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 RENDERING_SERVER_H
  31. #define RENDERING_SERVER_H
  32. #include "core/io/image.h"
  33. #include "core/math/geometry_3d.h"
  34. #include "core/math/transform_2d.h"
  35. #include "core/object/class_db.h"
  36. #include "core/object/worker_thread_pool.h"
  37. #include "core/templates/rid.h"
  38. #include "core/variant/typed_array.h"
  39. #include "core/variant/variant.h"
  40. #include "servers/display_server.h"
  41. #include "servers/rendering/rendering_device.h"
  42. template <typename T>
  43. class TypedArray;
  44. class RenderingServer : public Object {
  45. GDCLASS(RenderingServer, Object);
  46. static RenderingServer *singleton;
  47. int mm_policy = 0;
  48. bool render_loop_enabled = true;
  49. Array _get_array_from_surface(uint32_t p_format, Vector<uint8_t> p_vertex_data, Vector<uint8_t> p_attrib_data, Vector<uint8_t> p_skin_data, int p_vertex_len, Vector<uint8_t> p_index_data, int p_index_len) const;
  50. const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);
  51. const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);
  52. protected:
  53. RID _make_test_cube();
  54. void _free_internal_rids();
  55. RID test_texture;
  56. RID white_texture;
  57. RID test_material;
  58. Error _surface_set_data(Array p_arrays, uint32_t p_format, uint32_t *p_offsets, uint32_t p_vertex_stride, uint32_t p_attrib_stride, uint32_t p_skin_stride, Vector<uint8_t> &r_vertex_array, Vector<uint8_t> &r_attrib_array, Vector<uint8_t> &r_skin_array, int p_vertex_array_len, Vector<uint8_t> &r_index_array, int p_index_array_len, AABB &r_aabb, Vector<AABB> &r_bone_aabb);
  59. static RenderingServer *(*create_func)();
  60. static void _bind_methods();
  61. public:
  62. static RenderingServer *get_singleton();
  63. static RenderingServer *create();
  64. enum {
  65. NO_INDEX_ARRAY = -1,
  66. ARRAY_WEIGHTS_SIZE = 4,
  67. CANVAS_ITEM_Z_MIN = -4096,
  68. CANVAS_ITEM_Z_MAX = 4096,
  69. MAX_GLOW_LEVELS = 7,
  70. MAX_CURSORS = 8,
  71. MAX_2D_DIRECTIONAL_LIGHTS = 8,
  72. MAX_MESH_SURFACES = 256
  73. };
  74. /* TEXTURE API */
  75. enum TextureLayeredType {
  76. TEXTURE_LAYERED_2D_ARRAY,
  77. TEXTURE_LAYERED_CUBEMAP,
  78. TEXTURE_LAYERED_CUBEMAP_ARRAY,
  79. };
  80. enum CubeMapLayer {
  81. CUBEMAP_LAYER_LEFT,
  82. CUBEMAP_LAYER_RIGHT,
  83. CUBEMAP_LAYER_BOTTOM,
  84. CUBEMAP_LAYER_TOP,
  85. CUBEMAP_LAYER_FRONT,
  86. CUBEMAP_LAYER_BACK
  87. };
  88. virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
  89. virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;
  90. 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; //all slices, then all the mipmaps, must be coherent
  91. virtual RID texture_proxy_create(RID p_base) = 0;
  92. virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
  93. virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
  94. virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;
  95. // These two APIs can be used together or in combination with the others.
  96. virtual RID texture_2d_placeholder_create() = 0;
  97. virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;
  98. virtual RID texture_3d_placeholder_create() = 0;
  99. virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
  100. virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
  101. virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
  102. virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
  103. virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
  104. virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
  105. virtual String texture_get_path(RID p_texture) const = 0;
  106. typedef void (*TextureDetectCallback)(void *);
  107. virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  108. virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  109. enum TextureDetectRoughnessChannel {
  110. TEXTURE_DETECT_ROUGHNESS_R,
  111. TEXTURE_DETECT_ROUGHNESS_G,
  112. TEXTURE_DETECT_ROUGHNESS_B,
  113. TEXTURE_DETECT_ROUGHNESS_A,
  114. TEXTURE_DETECT_ROUGHNESS_GRAY,
  115. };
  116. typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);
  117. virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
  118. struct TextureInfo {
  119. RID texture;
  120. uint32_t width;
  121. uint32_t height;
  122. uint32_t depth;
  123. Image::Format format;
  124. int bytes;
  125. String path;
  126. };
  127. virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;
  128. Array _texture_debug_usage_bind();
  129. virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
  130. virtual RID texture_get_rd_texture_rid(RID p_texture, bool p_srgb = false) const = 0;
  131. /* SHADER API */
  132. enum ShaderMode {
  133. SHADER_SPATIAL,
  134. SHADER_CANVAS_ITEM,
  135. SHADER_PARTICLES,
  136. SHADER_SKY,
  137. SHADER_FOG,
  138. SHADER_MAX
  139. };
  140. virtual RID shader_create() = 0;
  141. virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
  142. virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;
  143. virtual String shader_get_code(RID p_shader) const = 0;
  144. virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
  145. virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;
  146. virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;
  147. virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;
  148. struct ShaderNativeSourceCode {
  149. struct Version {
  150. struct Stage {
  151. String name;
  152. String code;
  153. };
  154. Vector<Stage> stages;
  155. };
  156. Vector<Version> versions;
  157. };
  158. virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;
  159. /* COMMON MATERIAL API */
  160. enum {
  161. MATERIAL_RENDER_PRIORITY_MIN = -128,
  162. MATERIAL_RENDER_PRIORITY_MAX = 127,
  163. };
  164. virtual RID material_create() = 0;
  165. virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
  166. virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
  167. virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
  168. virtual void material_set_render_priority(RID p_material, int priority) = 0;
  169. virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
  170. /* MESH API */
  171. enum ArrayType {
  172. ARRAY_VERTEX = 0, // RG32F or RGB32F (depending on 2D bit)
  173. ARRAY_NORMAL = 1, // A2B10G10R10, A is ignored.
  174. ARRAY_TANGENT = 2, // A2B10G10R10, A flips sign of binormal.
  175. ARRAY_COLOR = 3, // RGBA8
  176. ARRAY_TEX_UV = 4, // RG32F
  177. ARRAY_TEX_UV2 = 5, // RG32F
  178. ARRAY_CUSTOM0 = 6, // Depends on ArrayCustomFormat.
  179. ARRAY_CUSTOM1 = 7,
  180. ARRAY_CUSTOM2 = 8,
  181. ARRAY_CUSTOM3 = 9,
  182. ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)
  183. ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)
  184. ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF.
  185. ARRAY_MAX = 13
  186. };
  187. enum {
  188. ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0
  189. };
  190. enum ArrayCustomFormat {
  191. ARRAY_CUSTOM_RGBA8_UNORM,
  192. ARRAY_CUSTOM_RGBA8_SNORM,
  193. ARRAY_CUSTOM_RG_HALF,
  194. ARRAY_CUSTOM_RGBA_HALF,
  195. ARRAY_CUSTOM_R_FLOAT,
  196. ARRAY_CUSTOM_RG_FLOAT,
  197. ARRAY_CUSTOM_RGB_FLOAT,
  198. ARRAY_CUSTOM_RGBA_FLOAT,
  199. ARRAY_CUSTOM_MAX
  200. };
  201. enum ArrayFormat {
  202. /* ARRAY FORMAT FLAGS */
  203. ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX,
  204. ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,
  205. ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,
  206. ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,
  207. ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,
  208. ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,
  209. ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,
  210. ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,
  211. ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,
  212. ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,
  213. ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,
  214. ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,
  215. ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,
  216. ARRAY_FORMAT_BLEND_SHAPE_MASK = ARRAY_FORMAT_VERTEX | ARRAY_FORMAT_NORMAL | ARRAY_FORMAT_TANGENT,
  217. ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),
  218. ARRAY_FORMAT_CUSTOM_BITS = 3,
  219. ARRAY_FORMAT_CUSTOM_MASK = 0x7,
  220. ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),
  221. ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),
  222. ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),
  223. ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),
  224. ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),
  225. ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),
  226. ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),
  227. ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),
  228. ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 1 << (ARRAY_INDEX + 1 + 15),
  229. };
  230. enum PrimitiveType {
  231. PRIMITIVE_POINTS,
  232. PRIMITIVE_LINES,
  233. PRIMITIVE_LINE_STRIP,
  234. PRIMITIVE_TRIANGLES,
  235. PRIMITIVE_TRIANGLE_STRIP,
  236. PRIMITIVE_MAX,
  237. };
  238. struct SurfaceData {
  239. PrimitiveType primitive = PRIMITIVE_MAX;
  240. uint32_t format = 0;
  241. Vector<uint8_t> vertex_data; // Vertex, Normal, Tangent (change with skinning, blendshape).
  242. Vector<uint8_t> attribute_data; // Color, UV, UV2, Custom0-3.
  243. Vector<uint8_t> skin_data; // Bone index, Bone weight.
  244. uint32_t vertex_count = 0;
  245. Vector<uint8_t> index_data;
  246. uint32_t index_count = 0;
  247. AABB aabb;
  248. struct LOD {
  249. float edge_length = 0.0f;
  250. Vector<uint8_t> index_data;
  251. };
  252. Vector<LOD> lods;
  253. Vector<AABB> bone_aabbs;
  254. Vector<uint8_t> blend_shape_data;
  255. RID material;
  256. };
  257. virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;
  258. virtual RID mesh_create() = 0;
  259. virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;
  260. virtual uint32_t mesh_surface_get_format_offset(uint32_t p_format, int p_vertex_len, int p_array_index) const;
  261. virtual uint32_t mesh_surface_get_format_vertex_stride(uint32_t p_format, int p_vertex_len) const;
  262. virtual uint32_t mesh_surface_get_format_attribute_stride(uint32_t p_format, int p_vertex_len) const;
  263. virtual uint32_t mesh_surface_get_format_skin_stride(uint32_t p_format, int p_vertex_len) const;
  264. /// Returns stride
  265. virtual void mesh_surface_make_offsets_from_format(uint32_t p_format, int p_vertex_len, int p_index_len, uint32_t *r_offsets, uint32_t &r_vertex_element_size, uint32_t &r_attrib_element_size, uint32_t &r_skin_element_size) const;
  266. virtual Error mesh_create_surface_data_from_arrays(SurfaceData *r_surface_data, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint32_t p_compress_format = 0);
  267. Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;
  268. Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;
  269. TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;
  270. Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;
  271. virtual void mesh_add_surface_from_arrays(RID p_mesh, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint32_t p_compress_format = 0);
  272. virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;
  273. virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
  274. enum BlendShapeMode {
  275. BLEND_SHAPE_MODE_NORMALIZED,
  276. BLEND_SHAPE_MODE_RELATIVE,
  277. };
  278. virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;
  279. virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
  280. virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  281. virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  282. virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  283. virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
  284. virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
  285. virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
  286. virtual int mesh_get_surface_count(RID p_mesh) const = 0;
  287. virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
  288. virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
  289. virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;
  290. virtual void mesh_clear(RID p_mesh) = 0;
  291. /* MULTIMESH API */
  292. virtual RID multimesh_create() = 0;
  293. enum MultimeshTransformFormat {
  294. MULTIMESH_TRANSFORM_2D,
  295. MULTIMESH_TRANSFORM_3D,
  296. };
  297. virtual void multimesh_allocate_data(RID p_multimesh, int p_instances, MultimeshTransformFormat p_transform_format, bool p_use_colors = false, bool p_use_custom_data = false) = 0;
  298. virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
  299. virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
  300. virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;
  301. virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
  302. virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
  303. virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
  304. virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
  305. virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
  306. virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
  307. virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
  308. virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
  309. virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
  310. virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
  311. virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
  312. virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
  313. virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
  314. /* SKELETON API */
  315. virtual RID skeleton_create() = 0;
  316. virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
  317. virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
  318. virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;
  319. virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
  320. virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
  321. virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
  322. virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
  323. /* Light API */
  324. enum LightType {
  325. LIGHT_DIRECTIONAL,
  326. LIGHT_OMNI,
  327. LIGHT_SPOT
  328. };
  329. enum LightParam {
  330. LIGHT_PARAM_ENERGY,
  331. LIGHT_PARAM_INDIRECT_ENERGY,
  332. LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY,
  333. LIGHT_PARAM_SPECULAR,
  334. LIGHT_PARAM_RANGE,
  335. LIGHT_PARAM_SIZE,
  336. LIGHT_PARAM_ATTENUATION,
  337. LIGHT_PARAM_SPOT_ANGLE,
  338. LIGHT_PARAM_SPOT_ATTENUATION,
  339. LIGHT_PARAM_SHADOW_MAX_DISTANCE,
  340. LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,
  341. LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,
  342. LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,
  343. LIGHT_PARAM_SHADOW_FADE_START,
  344. LIGHT_PARAM_SHADOW_NORMAL_BIAS,
  345. LIGHT_PARAM_SHADOW_BIAS,
  346. LIGHT_PARAM_SHADOW_PANCAKE_SIZE,
  347. LIGHT_PARAM_SHADOW_OPACITY,
  348. LIGHT_PARAM_SHADOW_BLUR,
  349. LIGHT_PARAM_TRANSMITTANCE_BIAS,
  350. LIGHT_PARAM_INTENSITY,
  351. LIGHT_PARAM_MAX
  352. };
  353. virtual RID directional_light_create() = 0;
  354. virtual RID omni_light_create() = 0;
  355. virtual RID spot_light_create() = 0;
  356. virtual void light_set_color(RID p_light, const Color &p_color) = 0;
  357. virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;
  358. virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
  359. virtual void light_set_projector(RID p_light, RID p_texture) = 0;
  360. virtual void light_set_negative(RID p_light, bool p_enable) = 0;
  361. virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
  362. virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;
  363. virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
  364. enum LightBakeMode {
  365. LIGHT_BAKE_DISABLED,
  366. LIGHT_BAKE_STATIC,
  367. LIGHT_BAKE_DYNAMIC,
  368. };
  369. virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;
  370. virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
  371. // Omni light
  372. enum LightOmniShadowMode {
  373. LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,
  374. LIGHT_OMNI_SHADOW_CUBE,
  375. };
  376. virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;
  377. // Directional light
  378. enum LightDirectionalShadowMode {
  379. LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,
  380. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,
  381. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,
  382. };
  383. enum LightDirectionalSkyMode {
  384. LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY,
  385. LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY,
  386. LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY,
  387. };
  388. virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;
  389. virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
  390. virtual void light_directional_set_sky_mode(RID p_light, LightDirectionalSkyMode p_mode) = 0;
  391. // Shadow atlas
  392. virtual RID shadow_atlas_create() = 0;
  393. virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;
  394. virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
  395. virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;
  396. enum ShadowQuality {
  397. SHADOW_QUALITY_HARD,
  398. SHADOW_QUALITY_SOFT_VERY_LOW,
  399. SHADOW_QUALITY_SOFT_LOW,
  400. SHADOW_QUALITY_SOFT_MEDIUM,
  401. SHADOW_QUALITY_SOFT_HIGH,
  402. SHADOW_QUALITY_SOFT_ULTRA,
  403. SHADOW_QUALITY_MAX
  404. };
  405. virtual void positional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
  406. virtual void directional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
  407. enum LightProjectorFilter {
  408. LIGHT_PROJECTOR_FILTER_NEAREST,
  409. LIGHT_PROJECTOR_FILTER_LINEAR,
  410. LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS,
  411. LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS,
  412. LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
  413. LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
  414. };
  415. virtual void light_projectors_set_filter(LightProjectorFilter p_filter) = 0;
  416. /* PROBE API */
  417. virtual RID reflection_probe_create() = 0;
  418. enum ReflectionProbeUpdateMode {
  419. REFLECTION_PROBE_UPDATE_ONCE,
  420. REFLECTION_PROBE_UPDATE_ALWAYS,
  421. };
  422. virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;
  423. virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
  424. enum ReflectionProbeAmbientMode {
  425. REFLECTION_PROBE_AMBIENT_DISABLED,
  426. REFLECTION_PROBE_AMBIENT_ENVIRONMENT,
  427. REFLECTION_PROBE_AMBIENT_COLOR,
  428. };
  429. virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;
  430. virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
  431. virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
  432. virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
  433. virtual void reflection_probe_set_extents(RID p_probe, const Vector3 &p_extents) = 0;
  434. virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
  435. virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
  436. virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
  437. virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
  438. virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
  439. virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
  440. virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;
  441. /* DECAL API */
  442. enum DecalTexture {
  443. DECAL_TEXTURE_ALBEDO,
  444. DECAL_TEXTURE_NORMAL,
  445. DECAL_TEXTURE_ORM,
  446. DECAL_TEXTURE_EMISSION,
  447. DECAL_TEXTURE_MAX
  448. };
  449. virtual RID decal_create() = 0;
  450. virtual void decal_set_extents(RID p_decal, const Vector3 &p_extents) = 0;
  451. virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;
  452. virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
  453. virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
  454. virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
  455. virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
  456. virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
  457. virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
  458. virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
  459. enum DecalFilter {
  460. DECAL_FILTER_NEAREST,
  461. DECAL_FILTER_LINEAR,
  462. DECAL_FILTER_NEAREST_MIPMAPS,
  463. DECAL_FILTER_LINEAR_MIPMAPS,
  464. DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
  465. DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
  466. };
  467. virtual void decals_set_filter(DecalFilter p_quality) = 0;
  468. /* VOXEL GI API */
  469. virtual RID voxel_gi_create() = 0;
  470. virtual void voxel_gi_allocate_data(RID p_voxel_gi, const Transform3D &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;
  471. virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;
  472. virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;
  473. virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;
  474. virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;
  475. virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;
  476. virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;
  477. virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;
  478. virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;
  479. virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;
  480. virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;
  481. virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;
  482. virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;
  483. virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;
  484. virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;
  485. virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;
  486. enum VoxelGIQuality {
  487. VOXEL_GI_QUALITY_LOW,
  488. VOXEL_GI_QUALITY_HIGH,
  489. };
  490. virtual void voxel_gi_set_quality(VoxelGIQuality) = 0;
  491. /* LIGHTMAP */
  492. virtual RID lightmap_create() = 0;
  493. virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
  494. virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
  495. virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
  496. 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;
  497. virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;
  498. virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
  499. virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
  500. virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
  501. virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
  502. virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
  503. /* PARTICLES API */
  504. virtual RID particles_create() = 0;
  505. enum ParticlesMode {
  506. PARTICLES_MODE_2D,
  507. PARTICLES_MODE_3D
  508. };
  509. virtual void particles_set_mode(RID p_particles, ParticlesMode p_mode) = 0;
  510. virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;
  511. virtual bool particles_get_emitting(RID p_particles) = 0;
  512. virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
  513. virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;
  514. virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
  515. virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;
  516. virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
  517. virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
  518. virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
  519. virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;
  520. virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
  521. virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
  522. virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
  523. virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;
  524. virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
  525. virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
  526. enum ParticlesTransformAlign {
  527. PARTICLES_TRANSFORM_ALIGN_DISABLED,
  528. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,
  529. PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,
  530. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,
  531. };
  532. virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;
  533. virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;
  534. virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;
  535. virtual bool particles_is_inactive(RID p_particles) = 0;
  536. virtual void particles_request_process(RID p_particles) = 0;
  537. virtual void particles_restart(RID p_particles) = 0;
  538. virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
  539. enum ParticlesEmitFlags {
  540. PARTICLES_EMIT_FLAG_POSITION = 1,
  541. PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,
  542. PARTICLES_EMIT_FLAG_VELOCITY = 4,
  543. PARTICLES_EMIT_FLAG_COLOR = 8,
  544. PARTICLES_EMIT_FLAG_CUSTOM = 16
  545. };
  546. virtual void 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) = 0;
  547. enum ParticlesDrawOrder {
  548. PARTICLES_DRAW_ORDER_INDEX,
  549. PARTICLES_DRAW_ORDER_LIFETIME,
  550. PARTICLES_DRAW_ORDER_REVERSE_LIFETIME,
  551. PARTICLES_DRAW_ORDER_VIEW_DEPTH,
  552. };
  553. virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;
  554. virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
  555. virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
  556. virtual AABB particles_get_current_aabb(RID p_particles) = 0;
  557. virtual void particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) = 0; // This is only used for 2D, in 3D it's automatic.
  558. /* PARTICLES COLLISION API */
  559. virtual RID particles_collision_create() = 0;
  560. enum ParticlesCollisionType {
  561. PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,
  562. PARTICLES_COLLISION_TYPE_BOX_ATTRACT,
  563. PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,
  564. PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,
  565. PARTICLES_COLLISION_TYPE_BOX_COLLIDE,
  566. PARTICLES_COLLISION_TYPE_SDF_COLLIDE,
  567. PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,
  568. };
  569. virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;
  570. virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
  571. virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.
  572. virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.
  573. virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;
  574. virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;
  575. virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;
  576. virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.
  577. virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.
  578. enum ParticlesCollisionHeightfieldResolution { // Longest axis resolution.
  579. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,
  580. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,
  581. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,
  582. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,
  583. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,
  584. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,
  585. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,
  586. };
  587. virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.
  588. /* FOG VOLUME API */
  589. virtual RID fog_volume_create() = 0;
  590. enum FogVolumeShape {
  591. FOG_VOLUME_SHAPE_ELLIPSOID,
  592. FOG_VOLUME_SHAPE_CONE,
  593. FOG_VOLUME_SHAPE_CYLINDER,
  594. FOG_VOLUME_SHAPE_BOX,
  595. FOG_VOLUME_SHAPE_WORLD,
  596. FOG_VOLUME_SHAPE_MAX,
  597. };
  598. virtual void fog_volume_set_shape(RID p_fog_volume, FogVolumeShape p_shape) = 0;
  599. virtual void fog_volume_set_extents(RID p_fog_volume, const Vector3 &p_extents) = 0;
  600. virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;
  601. /* VISIBILITY NOTIFIER API */
  602. virtual RID visibility_notifier_create() = 0;
  603. virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;
  604. virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
  605. /* OCCLUDER API */
  606. virtual RID occluder_create() = 0;
  607. virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;
  608. /* CAMERA API */
  609. virtual RID camera_create() = 0;
  610. virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;
  611. virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;
  612. virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;
  613. virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;
  614. virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;
  615. virtual void camera_set_environment(RID p_camera, RID p_env) = 0;
  616. virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;
  617. virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;
  618. /* VIEWPORT API */
  619. enum CanvasItemTextureFilter {
  620. CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
  621. CANVAS_ITEM_TEXTURE_FILTER_NEAREST,
  622. CANVAS_ITEM_TEXTURE_FILTER_LINEAR,
  623. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,
  624. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,
  625. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,
  626. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,
  627. CANVAS_ITEM_TEXTURE_FILTER_MAX
  628. };
  629. enum CanvasItemTextureRepeat {
  630. CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
  631. CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,
  632. CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,
  633. CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,
  634. CANVAS_ITEM_TEXTURE_REPEAT_MAX,
  635. };
  636. virtual RID viewport_create() = 0;
  637. enum ViewportScaling3DMode {
  638. VIEWPORT_SCALING_3D_MODE_BILINEAR,
  639. VIEWPORT_SCALING_3D_MODE_FSR,
  640. VIEWPORT_SCALING_3D_MODE_MAX
  641. };
  642. virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;
  643. virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;
  644. virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;
  645. virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;
  646. virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;
  647. virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;
  648. virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;
  649. virtual void viewport_set_scaling_3d_mode(RID p_viewport, ViewportScaling3DMode p_scaling_3d_mode) = 0;
  650. virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;
  651. virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;
  652. virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;
  653. enum ViewportUpdateMode {
  654. VIEWPORT_UPDATE_DISABLED,
  655. VIEWPORT_UPDATE_ONCE, // Then goes to disabled, must be manually updated.
  656. VIEWPORT_UPDATE_WHEN_VISIBLE, // Default
  657. VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,
  658. VIEWPORT_UPDATE_ALWAYS
  659. };
  660. virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;
  661. enum ViewportClearMode {
  662. VIEWPORT_CLEAR_ALWAYS,
  663. VIEWPORT_CLEAR_NEVER,
  664. VIEWPORT_CLEAR_ONLY_NEXT_FRAME
  665. };
  666. virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;
  667. virtual RID viewport_get_texture(RID p_viewport) const = 0;
  668. virtual void viewport_set_disable_environment(RID p_viewport, bool p_disable) = 0;
  669. virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;
  670. virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;
  671. virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;
  672. virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;
  673. virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;
  674. virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;
  675. virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;
  676. virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;
  677. virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;
  678. virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;
  679. virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;
  680. virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;
  681. virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;
  682. virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;
  683. enum ViewportSDFOversize {
  684. VIEWPORT_SDF_OVERSIZE_100_PERCENT,
  685. VIEWPORT_SDF_OVERSIZE_120_PERCENT,
  686. VIEWPORT_SDF_OVERSIZE_150_PERCENT,
  687. VIEWPORT_SDF_OVERSIZE_200_PERCENT,
  688. VIEWPORT_SDF_OVERSIZE_MAX
  689. };
  690. enum ViewportSDFScale {
  691. VIEWPORT_SDF_SCALE_100_PERCENT,
  692. VIEWPORT_SDF_SCALE_50_PERCENT,
  693. VIEWPORT_SDF_SCALE_25_PERCENT,
  694. VIEWPORT_SDF_SCALE_MAX
  695. };
  696. virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;
  697. virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;
  698. virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;
  699. enum ViewportMSAA {
  700. VIEWPORT_MSAA_DISABLED,
  701. VIEWPORT_MSAA_2X,
  702. VIEWPORT_MSAA_4X,
  703. VIEWPORT_MSAA_8X,
  704. VIEWPORT_MSAA_MAX,
  705. };
  706. virtual void viewport_set_msaa_3d(RID p_viewport, ViewportMSAA p_msaa) = 0;
  707. virtual void viewport_set_msaa_2d(RID p_viewport, ViewportMSAA p_msaa) = 0;
  708. enum ViewportScreenSpaceAA {
  709. VIEWPORT_SCREEN_SPACE_AA_DISABLED,
  710. VIEWPORT_SCREEN_SPACE_AA_FXAA,
  711. VIEWPORT_SCREEN_SPACE_AA_MAX,
  712. };
  713. virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;
  714. virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;
  715. virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;
  716. virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;
  717. virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;
  718. virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;
  719. enum ViewportOcclusionCullingBuildQuality {
  720. VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,
  721. VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,
  722. VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,
  723. };
  724. virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;
  725. enum ViewportRenderInfo {
  726. VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,
  727. VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME,
  728. VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,
  729. VIEWPORT_RENDER_INFO_MAX,
  730. };
  731. enum ViewportRenderInfoType {
  732. VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  733. VIEWPORT_RENDER_INFO_TYPE_SHADOW,
  734. VIEWPORT_RENDER_INFO_TYPE_MAX
  735. };
  736. virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfoType p_type, ViewportRenderInfo p_info) = 0;
  737. enum ViewportDebugDraw {
  738. VIEWPORT_DEBUG_DRAW_DISABLED,
  739. VIEWPORT_DEBUG_DRAW_UNSHADED,
  740. VIEWPORT_DEBUG_DRAW_LIGHTING,
  741. VIEWPORT_DEBUG_DRAW_OVERDRAW,
  742. VIEWPORT_DEBUG_DRAW_WIREFRAME,
  743. VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,
  744. VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO,
  745. VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING,
  746. VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION,
  747. VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,
  748. VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,
  749. VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,
  750. VIEWPORT_DEBUG_DRAW_SSAO,
  751. VIEWPORT_DEBUG_DRAW_SSIL,
  752. VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,
  753. VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,
  754. VIEWPORT_DEBUG_DRAW_SDFGI,
  755. VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,
  756. VIEWPORT_DEBUG_DRAW_GI_BUFFER,
  757. VIEWPORT_DEBUG_DRAW_DISABLE_LOD,
  758. VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,
  759. VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,
  760. VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,
  761. VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,
  762. VIEWPORT_DEBUG_DRAW_OCCLUDERS,
  763. VIEWPORT_DEBUG_DRAW_MOTION_VECTORS,
  764. };
  765. virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;
  766. virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;
  767. virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;
  768. virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;
  769. virtual RID viewport_find_from_screen_attachment(DisplayServer::WindowID p_id = DisplayServer::MAIN_WINDOW_ID) const = 0;
  770. enum ViewportVRSMode {
  771. VIEWPORT_VRS_DISABLED,
  772. VIEWPORT_VRS_TEXTURE,
  773. VIEWPORT_VRS_XR,
  774. VIEWPORT_VRS_MAX,
  775. };
  776. virtual void viewport_set_vrs_mode(RID p_viewport, ViewportVRSMode p_mode) = 0;
  777. virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;
  778. /* SKY API */
  779. enum SkyMode {
  780. SKY_MODE_AUTOMATIC,
  781. SKY_MODE_QUALITY,
  782. SKY_MODE_INCREMENTAL,
  783. SKY_MODE_REALTIME
  784. };
  785. virtual RID sky_create() = 0;
  786. virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
  787. virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;
  788. virtual void sky_set_material(RID p_sky, RID p_material) = 0;
  789. virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
  790. /* ENVIRONMENT API */
  791. virtual RID environment_create() = 0;
  792. enum EnvironmentBG {
  793. ENV_BG_CLEAR_COLOR,
  794. ENV_BG_COLOR,
  795. ENV_BG_SKY,
  796. ENV_BG_CANVAS,
  797. ENV_BG_KEEP,
  798. ENV_BG_CAMERA_FEED,
  799. ENV_BG_MAX
  800. };
  801. enum EnvironmentAmbientSource {
  802. ENV_AMBIENT_SOURCE_BG,
  803. ENV_AMBIENT_SOURCE_DISABLED,
  804. ENV_AMBIENT_SOURCE_COLOR,
  805. ENV_AMBIENT_SOURCE_SKY,
  806. };
  807. enum EnvironmentReflectionSource {
  808. ENV_REFLECTION_SOURCE_BG,
  809. ENV_REFLECTION_SOURCE_DISABLED,
  810. ENV_REFLECTION_SOURCE_SKY,
  811. };
  812. virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;
  813. virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
  814. virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
  815. virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
  816. virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
  817. virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;
  818. virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
  819. virtual void environment_set_ambient_light(RID p_env, const Color &p_color, EnvironmentAmbientSource p_ambient = ENV_AMBIENT_SOURCE_BG, float p_energy = 1.0, float p_sky_contribution = 0.0, EnvironmentReflectionSource p_reflection_source = ENV_REFLECTION_SOURCE_BG) = 0;
  820. enum EnvironmentGlowBlendMode {
  821. ENV_GLOW_BLEND_MODE_ADDITIVE,
  822. ENV_GLOW_BLEND_MODE_SCREEN,
  823. ENV_GLOW_BLEND_MODE_SOFTLIGHT,
  824. ENV_GLOW_BLEND_MODE_REPLACE,
  825. ENV_GLOW_BLEND_MODE_MIX,
  826. };
  827. virtual void environment_set_glow(RID p_env, bool p_enable, Vector<float> p_levels, float p_intensity, float p_strength, float p_mix, float p_bloom_threshold, EnvironmentGlowBlendMode p_blend_mode, float p_hdr_bleed_threshold, float p_hdr_bleed_scale, float p_hdr_luminance_cap, float p_glow_map_strength, RID p_glow_map) = 0;
  828. virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
  829. virtual void environment_glow_set_use_high_quality(bool p_enable) = 0;
  830. enum EnvironmentToneMapper {
  831. ENV_TONE_MAPPER_LINEAR,
  832. ENV_TONE_MAPPER_REINHARD,
  833. ENV_TONE_MAPPER_FILMIC,
  834. ENV_TONE_MAPPER_ACES
  835. };
  836. virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;
  837. virtual void environment_set_adjustment(RID p_env, bool p_enable, float p_brightness, float p_contrast, float p_saturation, bool p_use_1d_color_correction, RID p_color_correction) = 0;
  838. virtual void environment_set_ssr(RID p_env, bool p_enable, int p_max_steps, float p_fade_in, float p_fade_out, float p_depth_tolerance) = 0;
  839. enum EnvironmentSSRRoughnessQuality {
  840. ENV_SSR_ROUGHNESS_QUALITY_DISABLED,
  841. ENV_SSR_ROUGHNESS_QUALITY_LOW,
  842. ENV_SSR_ROUGHNESS_QUALITY_MEDIUM,
  843. ENV_SSR_ROUGHNESS_QUALITY_HIGH,
  844. };
  845. virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;
  846. virtual void environment_set_ssao(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_power, float p_detail, float p_horizon, float p_sharpness, float p_light_affect, float p_ao_channel_affect) = 0;
  847. enum EnvironmentSSAOQuality {
  848. ENV_SSAO_QUALITY_VERY_LOW,
  849. ENV_SSAO_QUALITY_LOW,
  850. ENV_SSAO_QUALITY_MEDIUM,
  851. ENV_SSAO_QUALITY_HIGH,
  852. ENV_SSAO_QUALITY_ULTRA,
  853. };
  854. virtual void environment_set_ssao_quality(EnvironmentSSAOQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
  855. virtual void environment_set_ssil(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_sharpness, float p_normal_rejection) = 0;
  856. enum EnvironmentSSILQuality {
  857. ENV_SSIL_QUALITY_VERY_LOW,
  858. ENV_SSIL_QUALITY_LOW,
  859. ENV_SSIL_QUALITY_MEDIUM,
  860. ENV_SSIL_QUALITY_HIGH,
  861. ENV_SSIL_QUALITY_ULTRA,
  862. };
  863. virtual void environment_set_ssil_quality(EnvironmentSSILQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
  864. enum EnvironmentSDFGIYScale {
  865. ENV_SDFGI_Y_SCALE_50_PERCENT,
  866. ENV_SDFGI_Y_SCALE_75_PERCENT,
  867. ENV_SDFGI_Y_SCALE_100_PERCENT,
  868. };
  869. virtual void environment_set_sdfgi(RID p_env, bool p_enable, int p_cascades, float p_min_cell_size, EnvironmentSDFGIYScale p_y_scale, bool p_use_occlusion, float p_bounce_feedback, bool p_read_sky, float p_energy, float p_normal_bias, float p_probe_bias) = 0;
  870. enum EnvironmentSDFGIRayCount {
  871. ENV_SDFGI_RAY_COUNT_4,
  872. ENV_SDFGI_RAY_COUNT_8,
  873. ENV_SDFGI_RAY_COUNT_16,
  874. ENV_SDFGI_RAY_COUNT_32,
  875. ENV_SDFGI_RAY_COUNT_64,
  876. ENV_SDFGI_RAY_COUNT_96,
  877. ENV_SDFGI_RAY_COUNT_128,
  878. ENV_SDFGI_RAY_COUNT_MAX,
  879. };
  880. virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;
  881. enum EnvironmentSDFGIFramesToConverge {
  882. ENV_SDFGI_CONVERGE_IN_5_FRAMES,
  883. ENV_SDFGI_CONVERGE_IN_10_FRAMES,
  884. ENV_SDFGI_CONVERGE_IN_15_FRAMES,
  885. ENV_SDFGI_CONVERGE_IN_20_FRAMES,
  886. ENV_SDFGI_CONVERGE_IN_25_FRAMES,
  887. ENV_SDFGI_CONVERGE_IN_30_FRAMES,
  888. ENV_SDFGI_CONVERGE_MAX
  889. };
  890. virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;
  891. enum EnvironmentSDFGIFramesToUpdateLight {
  892. ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,
  893. ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,
  894. ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,
  895. ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,
  896. ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,
  897. ENV_SDFGI_UPDATE_LIGHT_MAX,
  898. };
  899. virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;
  900. virtual void environment_set_fog(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective, float p_sky_affect) = 0;
  901. virtual void environment_set_volumetric_fog(RID p_env, bool p_enable, float p_density, const Color &p_albedo, const Color &p_emission, float p_emission_energy, float p_anisotropy, float p_length, float p_detail_spread, float p_gi_inject, bool p_temporal_reprojection, float p_temporal_reprojection_amount, float p_ambient_inject, float p_sky_affect) = 0;
  902. virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
  903. virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
  904. virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
  905. virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
  906. enum SubSurfaceScatteringQuality {
  907. SUB_SURFACE_SCATTERING_QUALITY_DISABLED,
  908. SUB_SURFACE_SCATTERING_QUALITY_LOW,
  909. SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,
  910. SUB_SURFACE_SCATTERING_QUALITY_HIGH,
  911. };
  912. virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;
  913. virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
  914. /* CAMERA EFFECTS */
  915. virtual RID camera_attributes_create() = 0;
  916. enum DOFBlurQuality {
  917. DOF_BLUR_QUALITY_VERY_LOW,
  918. DOF_BLUR_QUALITY_LOW,
  919. DOF_BLUR_QUALITY_MEDIUM,
  920. DOF_BLUR_QUALITY_HIGH,
  921. };
  922. virtual void camera_attributes_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;
  923. enum DOFBokehShape {
  924. DOF_BOKEH_BOX,
  925. DOF_BOKEH_HEXAGON,
  926. DOF_BOKEH_CIRCLE
  927. };
  928. virtual void camera_attributes_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;
  929. virtual void camera_attributes_set_dof_blur(RID p_camera_attributes, 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;
  930. virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;
  931. virtual void camera_attributes_set_auto_exposure(RID p_camera_attributes, bool p_enable, float p_min_sensitivity, float p_max_sensitivity, float p_speed, float p_scale) = 0;
  932. /* SCENARIO API */
  933. virtual RID scenario_create() = 0;
  934. virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;
  935. virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;
  936. virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;
  937. /* INSTANCING API */
  938. enum InstanceType {
  939. INSTANCE_NONE,
  940. INSTANCE_MESH,
  941. INSTANCE_MULTIMESH,
  942. INSTANCE_PARTICLES,
  943. INSTANCE_PARTICLES_COLLISION,
  944. INSTANCE_LIGHT,
  945. INSTANCE_REFLECTION_PROBE,
  946. INSTANCE_DECAL,
  947. INSTANCE_VOXEL_GI,
  948. INSTANCE_LIGHTMAP,
  949. INSTANCE_OCCLUDER,
  950. INSTANCE_VISIBLITY_NOTIFIER,
  951. INSTANCE_FOG_VOLUME,
  952. INSTANCE_MAX,
  953. INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_PARTICLES)
  954. };
  955. virtual RID instance_create2(RID p_base, RID p_scenario);
  956. virtual RID instance_create() = 0;
  957. virtual void instance_set_base(RID p_instance, RID p_base) = 0;
  958. virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;
  959. virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;
  960. virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;
  961. virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;
  962. virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;
  963. virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;
  964. virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;
  965. virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;
  966. virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;
  967. virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;
  968. virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;
  969. virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;
  970. // Don't use these in a game!
  971. virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;
  972. virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;
  973. virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;
  974. PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;
  975. PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;
  976. PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;
  977. enum InstanceFlags {
  978. INSTANCE_FLAG_USE_BAKED_LIGHT,
  979. INSTANCE_FLAG_USE_DYNAMIC_GI,
  980. INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,
  981. INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,
  982. INSTANCE_FLAG_MAX
  983. };
  984. enum ShadowCastingSetting {
  985. SHADOW_CASTING_SETTING_OFF,
  986. SHADOW_CASTING_SETTING_ON,
  987. SHADOW_CASTING_SETTING_DOUBLE_SIDED,
  988. SHADOW_CASTING_SETTING_SHADOWS_ONLY,
  989. };
  990. enum VisibilityRangeFadeMode {
  991. VISIBILITY_RANGE_FADE_DISABLED,
  992. VISIBILITY_RANGE_FADE_SELF,
  993. VISIBILITY_RANGE_FADE_DEPENDENCIES,
  994. };
  995. virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;
  996. virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;
  997. virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;
  998. virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;
  999. virtual void instance_geometry_set_visibility_range(RID p_instance, float p_min, float p_max, float p_min_margin, float p_max_margin, VisibilityRangeFadeMode p_fade_mode) = 0;
  1000. virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;
  1001. virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;
  1002. virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;
  1003. virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;
  1004. virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;
  1005. virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;
  1006. virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;
  1007. /* Bake 3D objects */
  1008. enum BakeChannels {
  1009. BAKE_CHANNEL_ALBEDO_ALPHA,
  1010. BAKE_CHANNEL_NORMAL,
  1011. BAKE_CHANNEL_ORM,
  1012. BAKE_CHANNEL_EMISSION
  1013. };
  1014. virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
  1015. /* CANVAS (2D) */
  1016. virtual RID canvas_create() = 0;
  1017. virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;
  1018. virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;
  1019. virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;
  1020. virtual void canvas_set_disable_scale(bool p_disable) = 0;
  1021. /* CANVAS TEXTURE */
  1022. virtual RID canvas_texture_create() = 0;
  1023. enum CanvasTextureChannel {
  1024. CANVAS_TEXTURE_CHANNEL_DIFFUSE,
  1025. CANVAS_TEXTURE_CHANNEL_NORMAL,
  1026. CANVAS_TEXTURE_CHANNEL_SPECULAR,
  1027. };
  1028. virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;
  1029. virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;
  1030. // Takes effect only for new draw commands.
  1031. virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;
  1032. virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;
  1033. /* CANVAS ITEM */
  1034. virtual RID canvas_item_create() = 0;
  1035. virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;
  1036. virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;
  1037. virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;
  1038. virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;
  1039. virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;
  1040. virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;
  1041. virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  1042. virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;
  1043. virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;
  1044. virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;
  1045. virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;
  1046. virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;
  1047. virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;
  1048. virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;
  1049. enum NinePatchAxisMode {
  1050. NINE_PATCH_STRETCH,
  1051. NINE_PATCH_TILE,
  1052. NINE_PATCH_TILE_FIT,
  1053. };
  1054. virtual void canvas_item_add_line(RID p_item, const Point2 &p_from, const Point2 &p_to, const Color &p_color, float p_width = 1.0, bool p_antialiased = false) = 0;
  1055. virtual void canvas_item_add_polyline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = 1.0, bool p_antialiased = false) = 0;
  1056. virtual void canvas_item_add_multiline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = 1.0) = 0;
  1057. virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color) = 0;
  1058. virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color) = 0;
  1059. virtual void canvas_item_add_texture_rect(RID p_item, const Rect2 &p_rect, RID p_texture, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false) = 0;
  1060. virtual void canvas_item_add_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, bool p_clip_uv = false) = 0;
  1061. virtual void canvas_item_add_msdf_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), int p_outline_size = 0, float p_px_range = 1.0) = 0;
  1062. virtual void canvas_item_add_lcd_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1)) = 0;
  1063. virtual void canvas_item_add_nine_patch(RID p_item, const Rect2 &p_rect, const Rect2 &p_source, RID p_texture, const Vector2 &p_topleft, const Vector2 &p_bottomright, NinePatchAxisMode p_x_axis_mode = NINE_PATCH_STRETCH, NinePatchAxisMode p_y_axis_mode = NINE_PATCH_STRETCH, bool p_draw_center = true, const Color &p_modulate = Color(1, 1, 1)) = 0;
  1064. virtual void canvas_item_add_primitive(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs, RID p_texture, float p_width = 1.0) = 0;
  1065. virtual void canvas_item_add_polygon(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs = Vector<Point2>(), RID p_texture = RID()) = 0;
  1066. virtual void canvas_item_add_triangle_array(RID p_item, 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>(), RID p_texture = RID(), int p_count = -1) = 0;
  1067. virtual void canvas_item_add_mesh(RID p_item, const RID &p_mesh, const Transform2D &p_transform = Transform2D(), const Color &p_modulate = Color(1, 1, 1), RID p_texture = RID()) = 0;
  1068. virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;
  1069. virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;
  1070. virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  1071. virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;
  1072. virtual void canvas_item_add_animation_slice(RID p_item, double p_animation_length, double p_slice_begin, double p_slice_end, double p_offset) = 0;
  1073. virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;
  1074. virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;
  1075. virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;
  1076. virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;
  1077. virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;
  1078. virtual void canvas_item_clear(RID p_item) = 0;
  1079. virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;
  1080. virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;
  1081. virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;
  1082. virtual void canvas_item_set_visibility_notifier(RID p_item, bool p_enable, const Rect2 &p_area, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
  1083. enum CanvasGroupMode {
  1084. CANVAS_GROUP_MODE_DISABLED,
  1085. CANVAS_GROUP_MODE_CLIP_ONLY,
  1086. CANVAS_GROUP_MODE_CLIP_AND_DRAW,
  1087. CANVAS_GROUP_MODE_TRANSPARENT,
  1088. };
  1089. virtual void canvas_item_set_canvas_group_mode(RID p_item, CanvasGroupMode p_mode, float p_clear_margin = 5.0, bool p_fit_empty = false, float p_fit_margin = 0.0, bool p_blur_mipmaps = false) = 0;
  1090. /* CANVAS LIGHT */
  1091. virtual RID canvas_light_create() = 0;
  1092. enum CanvasLightMode {
  1093. CANVAS_LIGHT_MODE_POINT,
  1094. CANVAS_LIGHT_MODE_DIRECTIONAL,
  1095. };
  1096. virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;
  1097. virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;
  1098. virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;
  1099. virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;
  1100. virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;
  1101. virtual void canvas_light_set_height(RID p_light, float p_height) = 0;
  1102. virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;
  1103. virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;
  1104. virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;
  1105. virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;
  1106. virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;
  1107. virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;
  1108. virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;
  1109. virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;
  1110. virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;
  1111. enum CanvasLightBlendMode {
  1112. CANVAS_LIGHT_BLEND_MODE_ADD,
  1113. CANVAS_LIGHT_BLEND_MODE_SUB,
  1114. CANVAS_LIGHT_BLEND_MODE_MIX,
  1115. };
  1116. virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;
  1117. enum CanvasLightShadowFilter {
  1118. CANVAS_LIGHT_FILTER_NONE,
  1119. CANVAS_LIGHT_FILTER_PCF5,
  1120. CANVAS_LIGHT_FILTER_PCF13,
  1121. CANVAS_LIGHT_FILTER_MAX
  1122. };
  1123. virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;
  1124. virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;
  1125. virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;
  1126. virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;
  1127. /* CANVAS LIGHT OCCLUDER */
  1128. virtual RID canvas_light_occluder_create() = 0;
  1129. virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;
  1130. virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;
  1131. virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;
  1132. virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;
  1133. virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;
  1134. virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;
  1135. /* CANVAS LIGHT OCCLUDER POLYGON */
  1136. virtual RID canvas_occluder_polygon_create() = 0;
  1137. virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;
  1138. enum CanvasOccluderPolygonCullMode {
  1139. CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,
  1140. CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,
  1141. CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,
  1142. };
  1143. virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;
  1144. virtual void canvas_set_shadow_texture_size(int p_size) = 0;
  1145. /* GLOBAL SHADER UNIFORMS */
  1146. enum GlobalShaderParameterType {
  1147. GLOBAL_VAR_TYPE_BOOL,
  1148. GLOBAL_VAR_TYPE_BVEC2,
  1149. GLOBAL_VAR_TYPE_BVEC3,
  1150. GLOBAL_VAR_TYPE_BVEC4,
  1151. GLOBAL_VAR_TYPE_INT,
  1152. GLOBAL_VAR_TYPE_IVEC2,
  1153. GLOBAL_VAR_TYPE_IVEC3,
  1154. GLOBAL_VAR_TYPE_IVEC4,
  1155. GLOBAL_VAR_TYPE_RECT2I,
  1156. GLOBAL_VAR_TYPE_UINT,
  1157. GLOBAL_VAR_TYPE_UVEC2,
  1158. GLOBAL_VAR_TYPE_UVEC3,
  1159. GLOBAL_VAR_TYPE_UVEC4,
  1160. GLOBAL_VAR_TYPE_FLOAT,
  1161. GLOBAL_VAR_TYPE_VEC2,
  1162. GLOBAL_VAR_TYPE_VEC3,
  1163. GLOBAL_VAR_TYPE_VEC4,
  1164. GLOBAL_VAR_TYPE_COLOR,
  1165. GLOBAL_VAR_TYPE_RECT2,
  1166. GLOBAL_VAR_TYPE_MAT2,
  1167. GLOBAL_VAR_TYPE_MAT3,
  1168. GLOBAL_VAR_TYPE_MAT4,
  1169. GLOBAL_VAR_TYPE_TRANSFORM_2D,
  1170. GLOBAL_VAR_TYPE_TRANSFORM,
  1171. GLOBAL_VAR_TYPE_SAMPLER2D,
  1172. GLOBAL_VAR_TYPE_SAMPLER2DARRAY,
  1173. GLOBAL_VAR_TYPE_SAMPLER3D,
  1174. GLOBAL_VAR_TYPE_SAMPLERCUBE,
  1175. GLOBAL_VAR_TYPE_MAX
  1176. };
  1177. virtual void global_shader_parameter_add(const StringName &p_name, GlobalShaderParameterType p_type, const Variant &p_value) = 0;
  1178. virtual void global_shader_parameter_remove(const StringName &p_name) = 0;
  1179. virtual Vector<StringName> global_shader_parameter_get_list() const = 0;
  1180. virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;
  1181. virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;
  1182. virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;
  1183. virtual GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;
  1184. virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;
  1185. virtual void global_shader_parameters_clear() = 0;
  1186. static int global_shader_uniform_type_get_shader_datatype(GlobalShaderParameterType p_type);
  1187. /* FREE */
  1188. virtual void free(RID p_rid) = 0; // Free RIDs associated with the rendering server.
  1189. /* EVENT QUEUING */
  1190. virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;
  1191. virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;
  1192. virtual void sync() = 0;
  1193. virtual bool has_changed() const = 0;
  1194. virtual void init();
  1195. virtual void finish() = 0;
  1196. /* STATUS INFORMATION */
  1197. enum RenderingInfo {
  1198. RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME,
  1199. RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME,
  1200. RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME,
  1201. RENDERING_INFO_TEXTURE_MEM_USED,
  1202. RENDERING_INFO_BUFFER_MEM_USED,
  1203. RENDERING_INFO_VIDEO_MEM_USED,
  1204. RENDERING_INFO_MAX
  1205. };
  1206. virtual uint64_t get_rendering_info(RenderingInfo p_info) = 0;
  1207. virtual String get_video_adapter_name() const = 0;
  1208. virtual String get_video_adapter_vendor() const = 0;
  1209. virtual RenderingDevice::DeviceType get_video_adapter_type() const = 0;
  1210. virtual String get_video_adapter_api_version() const = 0;
  1211. struct FrameProfileArea {
  1212. String name;
  1213. double gpu_msec;
  1214. double cpu_msec;
  1215. };
  1216. virtual void set_frame_profiling_enabled(bool p_enable) = 0;
  1217. virtual Vector<FrameProfileArea> get_frame_profile() = 0;
  1218. virtual uint64_t get_frame_profile_frame() = 0;
  1219. virtual double get_frame_setup_time_cpu() const = 0;
  1220. virtual void gi_set_use_half_resolution(bool p_enable) = 0;
  1221. /* TESTING */
  1222. virtual RID get_test_cube() = 0;
  1223. virtual RID get_test_texture();
  1224. virtual RID get_white_texture();
  1225. virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
  1226. virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);
  1227. virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);
  1228. virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);
  1229. virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;
  1230. virtual void set_default_clear_color(const Color &p_color) = 0;
  1231. enum Features {
  1232. FEATURE_SHADERS,
  1233. FEATURE_MULTITHREADED,
  1234. };
  1235. virtual bool has_feature(Features p_feature) const = 0;
  1236. virtual bool has_os_feature(const String &p_feature) const = 0;
  1237. virtual void set_debug_generate_wireframes(bool p_generate) = 0;
  1238. virtual void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window) = 0;
  1239. virtual bool is_low_end() const = 0;
  1240. virtual void set_print_gpu_profile(bool p_enable) = 0;
  1241. virtual Size2i get_maximum_viewport_size() const = 0;
  1242. RenderingDevice *get_rendering_device() const;
  1243. RenderingDevice *create_local_rendering_device() const;
  1244. bool is_render_loop_enabled() const;
  1245. void set_render_loop_enabled(bool p_enabled);
  1246. RenderingServer();
  1247. virtual ~RenderingServer();
  1248. private:
  1249. // Binder helpers
  1250. RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, TextureLayeredType p_layered_type);
  1251. RID _texture_3d_create(Image::Format p_format, int p_width, int p_height, int p_depth, bool p_mipmaps, const TypedArray<Image> &p_data);
  1252. void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);
  1253. TypedArray<Image> _texture_3d_get(RID p_texture) const;
  1254. TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;
  1255. RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);
  1256. void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);
  1257. Dictionary _mesh_get_surface(RID p_mesh, int p_idx);
  1258. TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;
  1259. TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);
  1260. void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);
  1261. };
  1262. // Make variant understand the enums.
  1263. VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);
  1264. VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);
  1265. VARIANT_ENUM_CAST(RenderingServer::ShaderMode);
  1266. VARIANT_ENUM_CAST(RenderingServer::ArrayType);
  1267. VARIANT_ENUM_CAST(RenderingServer::ArrayFormat);
  1268. VARIANT_ENUM_CAST(RenderingServer::ArrayCustomFormat);
  1269. VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);
  1270. VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);
  1271. VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);
  1272. VARIANT_ENUM_CAST(RenderingServer::LightType);
  1273. VARIANT_ENUM_CAST(RenderingServer::LightParam);
  1274. VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);
  1275. VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);
  1276. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);
  1277. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalSkyMode);
  1278. VARIANT_ENUM_CAST(RenderingServer::LightProjectorFilter);
  1279. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);
  1280. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);
  1281. VARIANT_ENUM_CAST(RenderingServer::VoxelGIQuality);
  1282. VARIANT_ENUM_CAST(RenderingServer::DecalTexture);
  1283. VARIANT_ENUM_CAST(RenderingServer::DecalFilter);
  1284. VARIANT_ENUM_CAST(RenderingServer::ParticlesMode);
  1285. VARIANT_ENUM_CAST(RenderingServer::ParticlesTransformAlign);
  1286. VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);
  1287. VARIANT_ENUM_CAST(RenderingServer::ParticlesEmitFlags);
  1288. VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionType);
  1289. VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionHeightfieldResolution);
  1290. VARIANT_ENUM_CAST(RenderingServer::FogVolumeShape);
  1291. VARIANT_ENUM_CAST(RenderingServer::ViewportScaling3DMode);
  1292. VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);
  1293. VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);
  1294. VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);
  1295. VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);
  1296. VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);
  1297. VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfoType);
  1298. VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);
  1299. VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);
  1300. VARIANT_ENUM_CAST(RenderingServer::ViewportSDFOversize);
  1301. VARIANT_ENUM_CAST(RenderingServer::ViewportSDFScale);
  1302. VARIANT_ENUM_CAST(RenderingServer::ViewportVRSMode);
  1303. VARIANT_ENUM_CAST(RenderingServer::SkyMode);
  1304. VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);
  1305. VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);
  1306. VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);
  1307. VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);
  1308. VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);
  1309. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);
  1310. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);
  1311. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSILQuality);
  1312. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToConverge);
  1313. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIRayCount);
  1314. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToUpdateLight);
  1315. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIYScale);
  1316. VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);
  1317. VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);
  1318. VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);
  1319. VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);
  1320. VARIANT_ENUM_CAST(RenderingServer::InstanceType);
  1321. VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);
  1322. VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);
  1323. VARIANT_ENUM_CAST(RenderingServer::VisibilityRangeFadeMode);
  1324. VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);
  1325. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);
  1326. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);
  1327. VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);
  1328. VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);
  1329. VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);
  1330. VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);
  1331. VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);
  1332. VARIANT_ENUM_CAST(RenderingServer::GlobalShaderParameterType);
  1333. VARIANT_ENUM_CAST(RenderingServer::RenderingInfo);
  1334. VARIANT_ENUM_CAST(RenderingServer::Features);
  1335. VARIANT_ENUM_CAST(RenderingServer::CanvasTextureChannel);
  1336. VARIANT_ENUM_CAST(RenderingServer::BakeChannels);
  1337. // Alias to make it easier to use.
  1338. #define RS RenderingServer
  1339. #endif // RENDERING_SERVER_H