rendering_server.h 88 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002
  1. /**************************************************************************/
  2. /* rendering_server.h */
  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. #pragma once
  31. #include "core/io/image.h"
  32. #include "core/math/geometry_3d.h"
  33. #include "core/math/transform_2d.h"
  34. #include "core/templates/rid.h"
  35. #include "core/variant/typed_array.h"
  36. #include "core/variant/variant.h"
  37. #include "servers/display_server.h"
  38. #include "servers/rendering/rendering_device.h"
  39. // Helper macros for code outside of the rendering server, but that is
  40. // called by the rendering server.
  41. #ifdef DEBUG_ENABLED
  42. #define ERR_NOT_ON_RENDER_THREAD \
  43. RenderingServer *rendering_server = RenderingServer::get_singleton(); \
  44. ERR_FAIL_NULL(rendering_server); \
  45. ERR_FAIL_COND(!rendering_server->is_on_render_thread());
  46. #define ERR_NOT_ON_RENDER_THREAD_V(m_ret) \
  47. RenderingServer *rendering_server = RenderingServer::get_singleton(); \
  48. ERR_FAIL_NULL_V(rendering_server, m_ret); \
  49. ERR_FAIL_COND_V(!rendering_server->is_on_render_thread(), m_ret);
  50. #else
  51. #define ERR_NOT_ON_RENDER_THREAD
  52. #define ERR_NOT_ON_RENDER_THREAD_V(m_ret)
  53. #endif
  54. class RenderingServer : public Object {
  55. GDCLASS(RenderingServer, Object);
  56. static RenderingServer *singleton;
  57. int mm_policy = 0;
  58. bool render_loop_enabled = true;
  59. Array _get_array_from_surface(uint64_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 AABB &p_aabb, const Vector4 &p_uv_scale) const;
  60. const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);
  61. const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);
  62. virtual TypedArray<StringName> _global_shader_parameter_get_list() const;
  63. protected:
  64. RID _make_test_cube();
  65. void _free_internal_rids();
  66. RID test_texture;
  67. RID white_texture;
  68. RID test_material;
  69. Error _surface_set_data(Array p_arrays, uint64_t p_format, uint32_t *p_offsets, uint32_t p_vertex_stride, uint32_t p_normal_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, Vector4 &r_uv_scale);
  70. static RenderingServer *(*create_func)();
  71. static void _bind_methods();
  72. #ifndef DISABLE_DEPRECATED
  73. void _environment_set_fog_bind_compat_84792(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);
  74. void _canvas_item_add_multiline_bind_compat_84523(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0);
  75. void _canvas_item_add_rect_bind_compat_84523(RID p_item, const Rect2 &p_rect, const Color &p_color);
  76. void _canvas_item_add_circle_bind_compat_84523(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color);
  77. void _instance_set_interpolated_bind_compat_104269(RID p_instance, bool p_interpolated);
  78. void _instance_reset_physics_interpolation_bind_compat_104269(RID p_instance);
  79. static void _bind_compatibility_methods();
  80. #endif
  81. public:
  82. static RenderingServer *get_singleton();
  83. static RenderingServer *create();
  84. enum {
  85. NO_INDEX_ARRAY = -1,
  86. ARRAY_WEIGHTS_SIZE = 4,
  87. CANVAS_ITEM_Z_MIN = -4096,
  88. CANVAS_ITEM_Z_MAX = 4096,
  89. CANVAS_LAYER_MIN = -2147483648,
  90. CANVAS_LAYER_MAX = 2147483647,
  91. MAX_GLOW_LEVELS = 7,
  92. MAX_CURSORS = 8,
  93. MAX_2D_DIRECTIONAL_LIGHTS = 8,
  94. MAX_MESH_SURFACES = 256
  95. };
  96. /* TEXTURE API */
  97. enum TextureType {
  98. TEXTURE_TYPE_2D,
  99. TEXTURE_TYPE_LAYERED,
  100. TEXTURE_TYPE_3D,
  101. };
  102. enum TextureLayeredType {
  103. TEXTURE_LAYERED_2D_ARRAY,
  104. TEXTURE_LAYERED_CUBEMAP,
  105. TEXTURE_LAYERED_CUBEMAP_ARRAY,
  106. };
  107. enum CubeMapLayer {
  108. CUBEMAP_LAYER_LEFT,
  109. CUBEMAP_LAYER_RIGHT,
  110. CUBEMAP_LAYER_BOTTOM,
  111. CUBEMAP_LAYER_TOP,
  112. CUBEMAP_LAYER_FRONT,
  113. CUBEMAP_LAYER_BACK
  114. };
  115. virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
  116. virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;
  117. 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
  118. virtual RID texture_external_create(int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
  119. virtual RID texture_proxy_create(RID p_base) = 0;
  120. virtual RID texture_create_from_native_handle(TextureType p_type, Image::Format p_format, uint64_t p_native_handle, int p_width, int p_height, int p_depth, int p_layers = 1, TextureLayeredType p_layered_type = TEXTURE_LAYERED_2D_ARRAY) = 0;
  121. virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
  122. virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
  123. virtual void texture_external_update(RID p_texture, int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
  124. virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;
  125. // These two APIs can be used together or in combination with the others.
  126. virtual RID texture_2d_placeholder_create() = 0;
  127. virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;
  128. virtual RID texture_3d_placeholder_create() = 0;
  129. virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
  130. virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
  131. virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
  132. virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
  133. virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
  134. virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
  135. virtual String texture_get_path(RID p_texture) const = 0;
  136. virtual Image::Format texture_get_format(RID p_texture) const = 0;
  137. typedef void (*TextureDetectCallback)(void *);
  138. virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  139. virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  140. enum TextureDetectRoughnessChannel {
  141. TEXTURE_DETECT_ROUGHNESS_R,
  142. TEXTURE_DETECT_ROUGHNESS_G,
  143. TEXTURE_DETECT_ROUGHNESS_B,
  144. TEXTURE_DETECT_ROUGHNESS_A,
  145. TEXTURE_DETECT_ROUGHNESS_GRAY,
  146. };
  147. typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);
  148. virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
  149. struct TextureInfo {
  150. RID texture;
  151. uint32_t width;
  152. uint32_t height;
  153. uint32_t depth;
  154. Image::Format format;
  155. int64_t bytes;
  156. String path;
  157. TextureType type;
  158. };
  159. virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;
  160. Array _texture_debug_usage_bind();
  161. virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
  162. virtual RID texture_rd_create(const RID &p_rd_texture, const RenderingServer::TextureLayeredType p_layer_type = RenderingServer::TEXTURE_LAYERED_2D_ARRAY) = 0;
  163. virtual RID texture_get_rd_texture(RID p_texture, bool p_srgb = false) const = 0;
  164. virtual uint64_t texture_get_native_handle(RID p_texture, bool p_srgb = false) const = 0;
  165. /* PIPELINES API */
  166. enum PipelineSource {
  167. PIPELINE_SOURCE_CANVAS,
  168. PIPELINE_SOURCE_MESH,
  169. PIPELINE_SOURCE_SURFACE,
  170. PIPELINE_SOURCE_DRAW,
  171. PIPELINE_SOURCE_SPECIALIZATION,
  172. PIPELINE_SOURCE_MAX
  173. };
  174. /* SHADER API */
  175. enum ShaderMode {
  176. SHADER_SPATIAL,
  177. SHADER_CANVAS_ITEM,
  178. SHADER_PARTICLES,
  179. SHADER_SKY,
  180. SHADER_FOG,
  181. SHADER_MAX
  182. };
  183. enum CullMode {
  184. CULL_MODE_DISABLED,
  185. CULL_MODE_FRONT,
  186. CULL_MODE_BACK,
  187. };
  188. virtual RID shader_create() = 0;
  189. virtual RID shader_create_from_code(const String &p_code, const String &p_path_hint = String()) = 0;
  190. virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
  191. virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;
  192. virtual String shader_get_code(RID p_shader) const = 0;
  193. virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
  194. virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;
  195. virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;
  196. virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;
  197. struct ShaderNativeSourceCode {
  198. struct Version {
  199. struct Stage {
  200. String name;
  201. String code;
  202. };
  203. Vector<Stage> stages;
  204. };
  205. Vector<Version> versions;
  206. };
  207. virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;
  208. /* COMMON MATERIAL API */
  209. enum {
  210. MATERIAL_RENDER_PRIORITY_MIN = -128,
  211. MATERIAL_RENDER_PRIORITY_MAX = 127,
  212. };
  213. virtual RID material_create() = 0;
  214. virtual RID material_create_from_shader(RID p_next_pass, int p_render_priority, RID p_shader) = 0;
  215. virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
  216. virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
  217. virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
  218. virtual void material_set_render_priority(RID p_material, int priority) = 0;
  219. virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
  220. /* MESH API */
  221. enum ArrayType {
  222. ARRAY_VERTEX = 0, // RG32F (2D), RGB32F, RGBA16 (compressed)
  223. ARRAY_NORMAL = 1, // RG16
  224. ARRAY_TANGENT = 2, // BA16 (with normal) or A16 (with vertex, when compressed)
  225. ARRAY_COLOR = 3, // RGBA8
  226. ARRAY_TEX_UV = 4, // RG32F or RG16
  227. ARRAY_TEX_UV2 = 5, // RG32F or RG16
  228. ARRAY_CUSTOM0 = 6, // Depends on ArrayCustomFormat.
  229. ARRAY_CUSTOM1 = 7,
  230. ARRAY_CUSTOM2 = 8,
  231. ARRAY_CUSTOM3 = 9,
  232. ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)
  233. ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)
  234. ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF.
  235. ARRAY_MAX = 13
  236. };
  237. enum {
  238. ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0
  239. };
  240. enum ArrayCustomFormat {
  241. ARRAY_CUSTOM_RGBA8_UNORM,
  242. ARRAY_CUSTOM_RGBA8_SNORM,
  243. ARRAY_CUSTOM_RG_HALF,
  244. ARRAY_CUSTOM_RGBA_HALF,
  245. ARRAY_CUSTOM_R_FLOAT,
  246. ARRAY_CUSTOM_RG_FLOAT,
  247. ARRAY_CUSTOM_RGB_FLOAT,
  248. ARRAY_CUSTOM_RGBA_FLOAT,
  249. ARRAY_CUSTOM_MAX
  250. };
  251. enum ArrayFormat : uint64_t {
  252. /* ARRAY FORMAT FLAGS */
  253. ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX,
  254. ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,
  255. ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,
  256. ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,
  257. ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,
  258. ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,
  259. ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,
  260. ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,
  261. ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,
  262. ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,
  263. ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,
  264. ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,
  265. ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,
  266. ARRAY_FORMAT_BLEND_SHAPE_MASK = ARRAY_FORMAT_VERTEX | ARRAY_FORMAT_NORMAL | ARRAY_FORMAT_TANGENT,
  267. ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),
  268. ARRAY_FORMAT_CUSTOM_BITS = 3,
  269. ARRAY_FORMAT_CUSTOM_MASK = 0x7,
  270. ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),
  271. ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),
  272. ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),
  273. ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),
  274. ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),
  275. ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),
  276. ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),
  277. ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),
  278. ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 3),
  279. ARRAY_FLAG_COMPRESS_ATTRIBUTES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 4),
  280. // We leave enough room for up to 5 more compression flags.
  281. ARRAY_FLAG_FORMAT_VERSION_BASE = ARRAY_COMPRESS_FLAGS_BASE + 10,
  282. ARRAY_FLAG_FORMAT_VERSION_SHIFT = ARRAY_FLAG_FORMAT_VERSION_BASE,
  283. // When changes are made to the mesh format, add a new version and use it for the CURRENT_VERSION.
  284. ARRAY_FLAG_FORMAT_VERSION_1 = 0,
  285. ARRAY_FLAG_FORMAT_VERSION_2 = 1ULL << ARRAY_FLAG_FORMAT_VERSION_SHIFT,
  286. ARRAY_FLAG_FORMAT_CURRENT_VERSION = ARRAY_FLAG_FORMAT_VERSION_2,
  287. ARRAY_FLAG_FORMAT_VERSION_MASK = 0xFF, // 8 bits version
  288. };
  289. static_assert(sizeof(ArrayFormat) == 8, "ArrayFormat should be 64 bits long.");
  290. enum PrimitiveType {
  291. PRIMITIVE_POINTS,
  292. PRIMITIVE_LINES,
  293. PRIMITIVE_LINE_STRIP,
  294. PRIMITIVE_TRIANGLES,
  295. PRIMITIVE_TRIANGLE_STRIP,
  296. PRIMITIVE_MAX,
  297. };
  298. struct SurfaceData {
  299. PrimitiveType primitive = PRIMITIVE_MAX;
  300. uint64_t format = ARRAY_FLAG_FORMAT_CURRENT_VERSION;
  301. Vector<uint8_t> vertex_data; // Vertex, Normal, Tangent (change with skinning, blendshape).
  302. Vector<uint8_t> attribute_data; // Color, UV, UV2, Custom0-3.
  303. Vector<uint8_t> skin_data; // Bone index, Bone weight.
  304. uint32_t vertex_count = 0;
  305. Vector<uint8_t> index_data;
  306. uint32_t index_count = 0;
  307. AABB aabb;
  308. struct LOD {
  309. float edge_length = 0.0f;
  310. Vector<uint8_t> index_data;
  311. };
  312. Vector<LOD> lods;
  313. Vector<AABB> bone_aabbs;
  314. // Transforms used in runtime bone AABBs compute.
  315. // Since bone AABBs is saved in Mesh space, but bones is in Skeleton space.
  316. Transform3D mesh_to_skeleton_xform;
  317. Vector<uint8_t> blend_shape_data;
  318. Vector4 uv_scale;
  319. RID material;
  320. };
  321. virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;
  322. virtual RID mesh_create() = 0;
  323. virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;
  324. virtual uint32_t mesh_surface_get_format_offset(BitField<ArrayFormat> p_format, int p_vertex_len, int p_array_index) const;
  325. virtual uint32_t mesh_surface_get_format_vertex_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
  326. virtual uint32_t mesh_surface_get_format_normal_tangent_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
  327. virtual uint32_t mesh_surface_get_format_attribute_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
  328. virtual uint32_t mesh_surface_get_format_skin_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
  329. virtual uint32_t mesh_surface_get_format_index_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
  330. /// Returns stride
  331. virtual void mesh_surface_make_offsets_from_format(uint64_t p_format, int p_vertex_len, int p_index_len, uint32_t *r_offsets, uint32_t &r_vertex_element_size, uint32_t &r_normal_element_size, uint32_t &r_attrib_element_size, uint32_t &r_skin_element_size) const;
  332. 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(), uint64_t p_compress_format = 0);
  333. Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;
  334. Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;
  335. TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;
  336. Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;
  337. 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(), BitField<ArrayFormat> p_compress_format = 0);
  338. virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;
  339. virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
  340. enum BlendShapeMode {
  341. BLEND_SHAPE_MODE_NORMALIZED,
  342. BLEND_SHAPE_MODE_RELATIVE,
  343. };
  344. virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;
  345. virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
  346. virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  347. virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  348. virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  349. virtual void mesh_surface_update_index_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  350. virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
  351. virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
  352. virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
  353. virtual int mesh_get_surface_count(RID p_mesh) const = 0;
  354. virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
  355. virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
  356. virtual void mesh_set_path(RID p_mesh, const String &p_path) = 0;
  357. virtual String mesh_get_path(RID p_mesh) const = 0;
  358. virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;
  359. virtual void mesh_surface_remove(RID p_mesh, int p_surface) = 0;
  360. virtual void mesh_clear(RID p_mesh) = 0;
  361. struct MeshInfo {
  362. RID mesh;
  363. String path;
  364. uint32_t vertex_buffer_size = 0;
  365. uint32_t attribute_buffer_size = 0;
  366. uint32_t skin_buffer_size = 0;
  367. uint32_t index_buffer_size = 0;
  368. uint32_t blend_shape_buffer_size = 0;
  369. uint32_t lod_index_buffers_size = 0;
  370. uint64_t vertex_count = 0;
  371. };
  372. virtual void mesh_debug_usage(List<MeshInfo> *r_info) = 0;
  373. /* MULTIMESH API */
  374. virtual RID multimesh_create() = 0;
  375. enum MultimeshTransformFormat {
  376. MULTIMESH_TRANSFORM_2D,
  377. MULTIMESH_TRANSFORM_3D,
  378. };
  379. enum MultimeshPhysicsInterpolationQuality {
  380. MULTIMESH_INTERP_QUALITY_FAST,
  381. MULTIMESH_INTERP_QUALITY_HIGH,
  382. };
  383. protected:
  384. #ifndef DISABLE_DEPRECATED
  385. void _multimesh_allocate_data_bind_compat_99455(RID p_multimesh, int p_instances, MultimeshTransformFormat p_transform_format, bool p_use_colors, bool p_use_custom_data);
  386. #endif
  387. public:
  388. 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, bool p_use_indirect = false) = 0;
  389. virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
  390. virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
  391. virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;
  392. virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
  393. virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
  394. virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
  395. virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
  396. virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
  397. virtual void multimesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
  398. virtual AABB multimesh_get_custom_aabb(RID p_mesh) const = 0;
  399. virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
  400. virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
  401. virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
  402. virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
  403. virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
  404. virtual RID multimesh_get_command_buffer_rd_rid(RID p_multimesh) const = 0;
  405. virtual RID multimesh_get_buffer_rd_rid(RID p_multimesh) const = 0;
  406. virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
  407. // Interpolation.
  408. virtual void multimesh_set_buffer_interpolated(RID p_multimesh, const Vector<float> &p_buffer_curr, const Vector<float> &p_buffer_prev) = 0;
  409. virtual void multimesh_set_physics_interpolated(RID p_multimesh, bool p_interpolated) = 0;
  410. virtual void multimesh_set_physics_interpolation_quality(RID p_multimesh, MultimeshPhysicsInterpolationQuality p_quality) = 0;
  411. virtual void multimesh_instance_reset_physics_interpolation(RID p_multimesh, int p_index) = 0;
  412. virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
  413. virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
  414. /* SKELETON API */
  415. virtual RID skeleton_create() = 0;
  416. virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
  417. virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
  418. virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;
  419. virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
  420. virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
  421. virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
  422. virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
  423. /* Light API */
  424. enum LightType {
  425. LIGHT_DIRECTIONAL,
  426. LIGHT_OMNI,
  427. LIGHT_SPOT
  428. };
  429. enum LightParam {
  430. LIGHT_PARAM_ENERGY,
  431. LIGHT_PARAM_INDIRECT_ENERGY,
  432. LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY,
  433. LIGHT_PARAM_SPECULAR,
  434. LIGHT_PARAM_RANGE,
  435. LIGHT_PARAM_SIZE,
  436. LIGHT_PARAM_ATTENUATION,
  437. LIGHT_PARAM_SPOT_ANGLE,
  438. LIGHT_PARAM_SPOT_ATTENUATION,
  439. LIGHT_PARAM_SHADOW_MAX_DISTANCE,
  440. LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,
  441. LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,
  442. LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,
  443. LIGHT_PARAM_SHADOW_FADE_START,
  444. LIGHT_PARAM_SHADOW_NORMAL_BIAS,
  445. LIGHT_PARAM_SHADOW_BIAS,
  446. LIGHT_PARAM_SHADOW_PANCAKE_SIZE,
  447. LIGHT_PARAM_SHADOW_OPACITY,
  448. LIGHT_PARAM_SHADOW_BLUR,
  449. LIGHT_PARAM_TRANSMITTANCE_BIAS,
  450. LIGHT_PARAM_INTENSITY,
  451. LIGHT_PARAM_MAX
  452. };
  453. virtual RID directional_light_create() = 0;
  454. virtual RID omni_light_create() = 0;
  455. virtual RID spot_light_create() = 0;
  456. virtual void light_set_color(RID p_light, const Color &p_color) = 0;
  457. virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;
  458. virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
  459. virtual void light_set_projector(RID p_light, RID p_texture) = 0;
  460. virtual void light_set_negative(RID p_light, bool p_enable) = 0;
  461. virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
  462. virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;
  463. virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
  464. virtual void light_set_shadow_caster_mask(RID p_light, uint32_t p_caster_mask) = 0;
  465. enum LightBakeMode {
  466. LIGHT_BAKE_DISABLED,
  467. LIGHT_BAKE_STATIC,
  468. LIGHT_BAKE_DYNAMIC,
  469. };
  470. virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;
  471. virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
  472. // Omni light
  473. enum LightOmniShadowMode {
  474. LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,
  475. LIGHT_OMNI_SHADOW_CUBE,
  476. };
  477. virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;
  478. // Directional light
  479. enum LightDirectionalShadowMode {
  480. LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,
  481. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,
  482. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,
  483. };
  484. enum LightDirectionalSkyMode {
  485. LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY,
  486. LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY,
  487. LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY,
  488. };
  489. virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;
  490. virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
  491. virtual void light_directional_set_sky_mode(RID p_light, LightDirectionalSkyMode p_mode) = 0;
  492. // Shadow atlas
  493. virtual RID shadow_atlas_create() = 0;
  494. virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;
  495. virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
  496. virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;
  497. enum ShadowQuality {
  498. SHADOW_QUALITY_HARD,
  499. SHADOW_QUALITY_SOFT_VERY_LOW,
  500. SHADOW_QUALITY_SOFT_LOW,
  501. SHADOW_QUALITY_SOFT_MEDIUM,
  502. SHADOW_QUALITY_SOFT_HIGH,
  503. SHADOW_QUALITY_SOFT_ULTRA,
  504. SHADOW_QUALITY_MAX
  505. };
  506. virtual void positional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
  507. virtual void directional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
  508. enum LightProjectorFilter {
  509. LIGHT_PROJECTOR_FILTER_NEAREST,
  510. LIGHT_PROJECTOR_FILTER_LINEAR,
  511. LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS,
  512. LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS,
  513. LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
  514. LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
  515. };
  516. virtual void light_projectors_set_filter(LightProjectorFilter p_filter) = 0;
  517. /* PROBE API */
  518. virtual RID reflection_probe_create() = 0;
  519. enum ReflectionProbeUpdateMode {
  520. REFLECTION_PROBE_UPDATE_ONCE,
  521. REFLECTION_PROBE_UPDATE_ALWAYS,
  522. };
  523. virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;
  524. virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
  525. virtual void reflection_probe_set_blend_distance(RID p_probe, float p_blend_distance) = 0;
  526. enum ReflectionProbeAmbientMode {
  527. REFLECTION_PROBE_AMBIENT_DISABLED,
  528. REFLECTION_PROBE_AMBIENT_ENVIRONMENT,
  529. REFLECTION_PROBE_AMBIENT_COLOR,
  530. };
  531. virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;
  532. virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
  533. virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
  534. virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
  535. virtual void reflection_probe_set_size(RID p_probe, const Vector3 &p_size) = 0;
  536. virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
  537. virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
  538. virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
  539. virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
  540. virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
  541. virtual void reflection_probe_set_reflection_mask(RID p_probe, uint32_t p_layers) = 0;
  542. virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
  543. virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;
  544. /* DECAL API */
  545. enum DecalTexture {
  546. DECAL_TEXTURE_ALBEDO,
  547. DECAL_TEXTURE_NORMAL,
  548. DECAL_TEXTURE_ORM,
  549. DECAL_TEXTURE_EMISSION,
  550. DECAL_TEXTURE_MAX
  551. };
  552. virtual RID decal_create() = 0;
  553. virtual void decal_set_size(RID p_decal, const Vector3 &p_size) = 0;
  554. virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;
  555. virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
  556. virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
  557. virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
  558. virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
  559. virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
  560. virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
  561. virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
  562. enum DecalFilter {
  563. DECAL_FILTER_NEAREST,
  564. DECAL_FILTER_LINEAR,
  565. DECAL_FILTER_NEAREST_MIPMAPS,
  566. DECAL_FILTER_LINEAR_MIPMAPS,
  567. DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
  568. DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
  569. };
  570. virtual void decals_set_filter(DecalFilter p_quality) = 0;
  571. /* VOXEL GI API */
  572. virtual RID voxel_gi_create() = 0;
  573. 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;
  574. virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;
  575. virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;
  576. virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;
  577. virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;
  578. virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;
  579. virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;
  580. virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;
  581. virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;
  582. virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;
  583. virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;
  584. virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;
  585. virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;
  586. virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;
  587. virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;
  588. virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;
  589. enum VoxelGIQuality {
  590. VOXEL_GI_QUALITY_LOW,
  591. VOXEL_GI_QUALITY_HIGH,
  592. };
  593. virtual void voxel_gi_set_quality(VoxelGIQuality) = 0;
  594. virtual void sdfgi_reset() = 0;
  595. /* LIGHTMAP */
  596. enum ShadowmaskMode {
  597. SHADOWMASK_MODE_NONE,
  598. SHADOWMASK_MODE_REPLACE,
  599. SHADOWMASK_MODE_OVERLAY,
  600. SHADOWMASK_MODE_ONLY,
  601. };
  602. virtual RID lightmap_create() = 0;
  603. virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
  604. virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
  605. virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
  606. 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;
  607. virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;
  608. virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
  609. virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
  610. virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
  611. virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
  612. virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
  613. virtual void lightmaps_set_bicubic_filter(bool p_enable) = 0;
  614. virtual void lightmap_set_shadowmask_textures(RID p_lightmap, RID p_shadow) = 0;
  615. virtual ShadowmaskMode lightmap_get_shadowmask_mode(RID p_lightmap) = 0;
  616. virtual void lightmap_set_shadowmask_mode(RID p_lightmap, ShadowmaskMode p_mode) = 0;
  617. /* PARTICLES API */
  618. virtual RID particles_create() = 0;
  619. enum ParticlesMode {
  620. PARTICLES_MODE_2D,
  621. PARTICLES_MODE_3D
  622. };
  623. virtual void particles_set_mode(RID p_particles, ParticlesMode p_mode) = 0;
  624. virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;
  625. virtual bool particles_get_emitting(RID p_particles) = 0;
  626. virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
  627. virtual void particles_set_amount_ratio(RID p_particles, float p_amount_ratio) = 0;
  628. virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;
  629. virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
  630. virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;
  631. virtual void particles_request_process_time(RID p_particles, real_t p_request_process_time) = 0;
  632. virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
  633. virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
  634. virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
  635. virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;
  636. virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
  637. virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
  638. virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
  639. virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;
  640. virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
  641. virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
  642. virtual void particles_set_seed(RID p_particles, uint32_t p_seed) = 0;
  643. enum ParticlesTransformAlign {
  644. PARTICLES_TRANSFORM_ALIGN_DISABLED,
  645. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,
  646. PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,
  647. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,
  648. };
  649. virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;
  650. virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;
  651. virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;
  652. virtual bool particles_is_inactive(RID p_particles) = 0;
  653. virtual void particles_request_process(RID p_particles) = 0;
  654. virtual void particles_restart(RID p_particles) = 0;
  655. virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
  656. enum ParticlesEmitFlags {
  657. PARTICLES_EMIT_FLAG_POSITION = 1,
  658. PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,
  659. PARTICLES_EMIT_FLAG_VELOCITY = 4,
  660. PARTICLES_EMIT_FLAG_COLOR = 8,
  661. PARTICLES_EMIT_FLAG_CUSTOM = 16
  662. };
  663. 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;
  664. enum ParticlesDrawOrder {
  665. PARTICLES_DRAW_ORDER_INDEX,
  666. PARTICLES_DRAW_ORDER_LIFETIME,
  667. PARTICLES_DRAW_ORDER_REVERSE_LIFETIME,
  668. PARTICLES_DRAW_ORDER_VIEW_DEPTH,
  669. };
  670. virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;
  671. virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
  672. virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
  673. virtual AABB particles_get_current_aabb(RID p_particles) = 0;
  674. 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.
  675. virtual void particles_set_emitter_velocity(RID p_particles, const Vector3 &p_velocity) = 0;
  676. virtual void particles_set_interp_to_end(RID p_particles, float p_interp) = 0;
  677. /* PARTICLES COLLISION API */
  678. virtual RID particles_collision_create() = 0;
  679. enum ParticlesCollisionType {
  680. PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,
  681. PARTICLES_COLLISION_TYPE_BOX_ATTRACT,
  682. PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,
  683. PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,
  684. PARTICLES_COLLISION_TYPE_BOX_COLLIDE,
  685. PARTICLES_COLLISION_TYPE_SDF_COLLIDE,
  686. PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,
  687. };
  688. virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;
  689. virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
  690. virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.
  691. virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.
  692. virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;
  693. virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;
  694. virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;
  695. virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.
  696. virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.
  697. enum ParticlesCollisionHeightfieldResolution { // Longest axis resolution.
  698. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,
  699. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,
  700. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,
  701. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,
  702. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,
  703. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,
  704. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,
  705. };
  706. virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.
  707. virtual void particles_collision_set_height_field_mask(RID p_particles_collision, uint32_t p_heightfield_mask) = 0;
  708. /* FOG VOLUME API */
  709. virtual RID fog_volume_create() = 0;
  710. enum FogVolumeShape {
  711. FOG_VOLUME_SHAPE_ELLIPSOID,
  712. FOG_VOLUME_SHAPE_CONE,
  713. FOG_VOLUME_SHAPE_CYLINDER,
  714. FOG_VOLUME_SHAPE_BOX,
  715. FOG_VOLUME_SHAPE_WORLD,
  716. FOG_VOLUME_SHAPE_MAX,
  717. };
  718. virtual void fog_volume_set_shape(RID p_fog_volume, FogVolumeShape p_shape) = 0;
  719. virtual void fog_volume_set_size(RID p_fog_volume, const Vector3 &p_size) = 0;
  720. virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;
  721. /* VISIBILITY NOTIFIER API */
  722. virtual RID visibility_notifier_create() = 0;
  723. virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;
  724. virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
  725. /* OCCLUDER API */
  726. virtual RID occluder_create() = 0;
  727. virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;
  728. /* CAMERA API */
  729. virtual RID camera_create() = 0;
  730. virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;
  731. virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;
  732. virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;
  733. virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;
  734. virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;
  735. virtual void camera_set_environment(RID p_camera, RID p_env) = 0;
  736. virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;
  737. virtual void camera_set_compositor(RID p_camera, RID p_compositor) = 0;
  738. virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;
  739. /* VIEWPORT API */
  740. enum CanvasItemTextureFilter {
  741. CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
  742. CANVAS_ITEM_TEXTURE_FILTER_NEAREST,
  743. CANVAS_ITEM_TEXTURE_FILTER_LINEAR,
  744. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,
  745. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,
  746. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,
  747. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,
  748. CANVAS_ITEM_TEXTURE_FILTER_MAX
  749. };
  750. enum CanvasItemTextureRepeat {
  751. CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
  752. CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,
  753. CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,
  754. CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,
  755. CANVAS_ITEM_TEXTURE_REPEAT_MAX,
  756. };
  757. virtual RID viewport_create() = 0;
  758. enum ViewportScaling3DMode {
  759. VIEWPORT_SCALING_3D_MODE_BILINEAR,
  760. VIEWPORT_SCALING_3D_MODE_FSR,
  761. VIEWPORT_SCALING_3D_MODE_FSR2,
  762. VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL,
  763. VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL,
  764. VIEWPORT_SCALING_3D_MODE_MAX,
  765. VIEWPORT_SCALING_3D_MODE_OFF = 255, // for internal use only
  766. };
  767. enum ViewportAnisotropicFiltering {
  768. VIEWPORT_ANISOTROPY_DISABLED,
  769. VIEWPORT_ANISOTROPY_2X,
  770. VIEWPORT_ANISOTROPY_4X,
  771. VIEWPORT_ANISOTROPY_8X,
  772. VIEWPORT_ANISOTROPY_16X,
  773. VIEWPORT_ANISOTROPY_MAX
  774. };
  775. enum ViewportScaling3DType {
  776. VIEWPORT_SCALING_3D_TYPE_NONE,
  777. VIEWPORT_SCALING_3D_TYPE_TEMPORAL,
  778. VIEWPORT_SCALING_3D_TYPE_SPATIAL,
  779. VIEWPORT_SCALING_3D_TYPE_MAX,
  780. };
  781. _ALWAYS_INLINE_ static ViewportScaling3DType scaling_3d_mode_type(ViewportScaling3DMode p_mode) {
  782. if (p_mode == VIEWPORT_SCALING_3D_MODE_BILINEAR || p_mode == VIEWPORT_SCALING_3D_MODE_FSR || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL) {
  783. return VIEWPORT_SCALING_3D_TYPE_SPATIAL;
  784. } else if (p_mode == VIEWPORT_SCALING_3D_MODE_FSR2 || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL) {
  785. return VIEWPORT_SCALING_3D_TYPE_TEMPORAL;
  786. }
  787. return VIEWPORT_SCALING_3D_TYPE_NONE;
  788. }
  789. virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;
  790. virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;
  791. virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;
  792. virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;
  793. virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;
  794. virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;
  795. virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;
  796. virtual void viewport_set_scaling_3d_mode(RID p_viewport, ViewportScaling3DMode p_scaling_3d_mode) = 0;
  797. virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;
  798. virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;
  799. virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;
  800. virtual void viewport_set_anisotropic_filtering_level(RID p_viewport, ViewportAnisotropicFiltering p_anisotropic_filtering_level) = 0;
  801. enum ViewportUpdateMode {
  802. VIEWPORT_UPDATE_DISABLED,
  803. VIEWPORT_UPDATE_ONCE, // Then goes to disabled, must be manually updated.
  804. VIEWPORT_UPDATE_WHEN_VISIBLE, // Default
  805. VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,
  806. VIEWPORT_UPDATE_ALWAYS
  807. };
  808. virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;
  809. virtual ViewportUpdateMode viewport_get_update_mode(RID p_viewport) const = 0;
  810. enum ViewportClearMode {
  811. VIEWPORT_CLEAR_ALWAYS,
  812. VIEWPORT_CLEAR_NEVER,
  813. VIEWPORT_CLEAR_ONLY_NEXT_FRAME
  814. };
  815. virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;
  816. virtual RID viewport_get_render_target(RID p_viewport) const = 0;
  817. virtual RID viewport_get_texture(RID p_viewport) const = 0;
  818. enum ViewportEnvironmentMode {
  819. VIEWPORT_ENVIRONMENT_DISABLED,
  820. VIEWPORT_ENVIRONMENT_ENABLED,
  821. VIEWPORT_ENVIRONMENT_INHERIT,
  822. VIEWPORT_ENVIRONMENT_MAX,
  823. };
  824. virtual void viewport_set_environment_mode(RID p_viewport, ViewportEnvironmentMode p_mode) = 0;
  825. virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;
  826. virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;
  827. virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;
  828. virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;
  829. virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;
  830. virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;
  831. virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;
  832. virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;
  833. virtual void viewport_set_use_hdr_2d(RID p_viewport, bool p_use_hdr) = 0;
  834. virtual bool viewport_is_using_hdr_2d(RID p_viewport) const = 0;
  835. virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;
  836. virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;
  837. virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;
  838. virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;
  839. virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;
  840. virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;
  841. enum ViewportSDFOversize {
  842. VIEWPORT_SDF_OVERSIZE_100_PERCENT,
  843. VIEWPORT_SDF_OVERSIZE_120_PERCENT,
  844. VIEWPORT_SDF_OVERSIZE_150_PERCENT,
  845. VIEWPORT_SDF_OVERSIZE_200_PERCENT,
  846. VIEWPORT_SDF_OVERSIZE_MAX
  847. };
  848. enum ViewportSDFScale {
  849. VIEWPORT_SDF_SCALE_100_PERCENT,
  850. VIEWPORT_SDF_SCALE_50_PERCENT,
  851. VIEWPORT_SDF_SCALE_25_PERCENT,
  852. VIEWPORT_SDF_SCALE_MAX
  853. };
  854. virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;
  855. virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;
  856. virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;
  857. enum ViewportMSAA {
  858. VIEWPORT_MSAA_DISABLED,
  859. VIEWPORT_MSAA_2X,
  860. VIEWPORT_MSAA_4X,
  861. VIEWPORT_MSAA_8X,
  862. VIEWPORT_MSAA_MAX,
  863. };
  864. virtual void viewport_set_msaa_3d(RID p_viewport, ViewportMSAA p_msaa) = 0;
  865. virtual void viewport_set_msaa_2d(RID p_viewport, ViewportMSAA p_msaa) = 0;
  866. enum ViewportScreenSpaceAA {
  867. VIEWPORT_SCREEN_SPACE_AA_DISABLED,
  868. VIEWPORT_SCREEN_SPACE_AA_FXAA,
  869. VIEWPORT_SCREEN_SPACE_AA_SMAA,
  870. VIEWPORT_SCREEN_SPACE_AA_MAX,
  871. };
  872. virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;
  873. virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;
  874. virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;
  875. virtual void viewport_set_force_motion_vectors(RID p_viewport, bool p_force_motion_vectors) = 0;
  876. virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;
  877. virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;
  878. virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;
  879. enum ViewportOcclusionCullingBuildQuality {
  880. VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,
  881. VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,
  882. VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,
  883. };
  884. virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;
  885. enum ViewportRenderInfo {
  886. VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,
  887. VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME,
  888. VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,
  889. VIEWPORT_RENDER_INFO_MAX,
  890. };
  891. enum ViewportRenderInfoType {
  892. VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  893. VIEWPORT_RENDER_INFO_TYPE_SHADOW,
  894. VIEWPORT_RENDER_INFO_TYPE_CANVAS,
  895. VIEWPORT_RENDER_INFO_TYPE_MAX
  896. };
  897. virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfoType p_type, ViewportRenderInfo p_info) = 0;
  898. enum ViewportDebugDraw {
  899. VIEWPORT_DEBUG_DRAW_DISABLED,
  900. VIEWPORT_DEBUG_DRAW_UNSHADED,
  901. VIEWPORT_DEBUG_DRAW_LIGHTING,
  902. VIEWPORT_DEBUG_DRAW_OVERDRAW,
  903. VIEWPORT_DEBUG_DRAW_WIREFRAME,
  904. VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,
  905. VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO,
  906. VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING,
  907. VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION,
  908. VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,
  909. VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,
  910. VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,
  911. VIEWPORT_DEBUG_DRAW_SSAO,
  912. VIEWPORT_DEBUG_DRAW_SSIL,
  913. VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,
  914. VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,
  915. VIEWPORT_DEBUG_DRAW_SDFGI,
  916. VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,
  917. VIEWPORT_DEBUG_DRAW_GI_BUFFER,
  918. VIEWPORT_DEBUG_DRAW_DISABLE_LOD,
  919. VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,
  920. VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,
  921. VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,
  922. VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,
  923. VIEWPORT_DEBUG_DRAW_OCCLUDERS,
  924. VIEWPORT_DEBUG_DRAW_MOTION_VECTORS,
  925. VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER,
  926. };
  927. virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;
  928. virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;
  929. virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;
  930. virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;
  931. virtual RID viewport_find_from_screen_attachment(DisplayServer::WindowID p_id = DisplayServer::MAIN_WINDOW_ID) const = 0;
  932. enum ViewportVRSMode {
  933. VIEWPORT_VRS_DISABLED,
  934. VIEWPORT_VRS_TEXTURE,
  935. VIEWPORT_VRS_XR,
  936. VIEWPORT_VRS_MAX,
  937. };
  938. enum ViewportVRSUpdateMode {
  939. VIEWPORT_VRS_UPDATE_DISABLED,
  940. VIEWPORT_VRS_UPDATE_ONCE,
  941. VIEWPORT_VRS_UPDATE_ALWAYS,
  942. VIEWPORT_VRS_UPDATE_MAX,
  943. };
  944. virtual void viewport_set_vrs_mode(RID p_viewport, ViewportVRSMode p_mode) = 0;
  945. virtual void viewport_set_vrs_update_mode(RID p_viewport, ViewportVRSUpdateMode p_mode) = 0;
  946. virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;
  947. /* SKY API */
  948. enum SkyMode {
  949. SKY_MODE_AUTOMATIC,
  950. SKY_MODE_QUALITY,
  951. SKY_MODE_INCREMENTAL,
  952. SKY_MODE_REALTIME
  953. };
  954. virtual RID sky_create() = 0;
  955. virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
  956. virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;
  957. virtual void sky_set_material(RID p_sky, RID p_material) = 0;
  958. virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
  959. /* COMPOSITOR EFFECTS API */
  960. enum CompositorEffectFlags {
  961. COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR = 1,
  962. COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH = 2,
  963. COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS = 4,
  964. COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS = 8,
  965. COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR = 16,
  966. };
  967. enum CompositorEffectCallbackType {
  968. COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE,
  969. COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE,
  970. COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY,
  971. COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT,
  972. COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT,
  973. COMPOSITOR_EFFECT_CALLBACK_TYPE_MAX,
  974. COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY = -1,
  975. };
  976. virtual RID compositor_effect_create() = 0;
  977. virtual void compositor_effect_set_enabled(RID p_effect, bool p_enabled) = 0;
  978. virtual void compositor_effect_set_callback(RID p_effect, CompositorEffectCallbackType p_callback_type, const Callable &p_callback) = 0;
  979. virtual void compositor_effect_set_flag(RID p_effect, CompositorEffectFlags p_flag, bool p_set) = 0;
  980. /* COMPOSITOR API */
  981. virtual RID compositor_create() = 0;
  982. virtual void compositor_set_compositor_effects(RID p_compositor, const TypedArray<RID> &p_effects) = 0;
  983. /* ENVIRONMENT API */
  984. virtual RID environment_create() = 0;
  985. enum EnvironmentBG {
  986. ENV_BG_CLEAR_COLOR,
  987. ENV_BG_COLOR,
  988. ENV_BG_SKY,
  989. ENV_BG_CANVAS,
  990. ENV_BG_KEEP,
  991. ENV_BG_CAMERA_FEED,
  992. ENV_BG_MAX
  993. };
  994. enum EnvironmentAmbientSource {
  995. ENV_AMBIENT_SOURCE_BG,
  996. ENV_AMBIENT_SOURCE_DISABLED,
  997. ENV_AMBIENT_SOURCE_COLOR,
  998. ENV_AMBIENT_SOURCE_SKY,
  999. };
  1000. enum EnvironmentReflectionSource {
  1001. ENV_REFLECTION_SOURCE_BG,
  1002. ENV_REFLECTION_SOURCE_DISABLED,
  1003. ENV_REFLECTION_SOURCE_SKY,
  1004. };
  1005. virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;
  1006. virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
  1007. virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
  1008. virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
  1009. virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
  1010. virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;
  1011. virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
  1012. 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;
  1013. virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;
  1014. enum EnvironmentGlowBlendMode {
  1015. ENV_GLOW_BLEND_MODE_ADDITIVE,
  1016. ENV_GLOW_BLEND_MODE_SCREEN,
  1017. ENV_GLOW_BLEND_MODE_SOFTLIGHT,
  1018. ENV_GLOW_BLEND_MODE_REPLACE,
  1019. ENV_GLOW_BLEND_MODE_MIX,
  1020. };
  1021. 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;
  1022. virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
  1023. enum EnvironmentToneMapper {
  1024. ENV_TONE_MAPPER_LINEAR,
  1025. ENV_TONE_MAPPER_REINHARD,
  1026. ENV_TONE_MAPPER_FILMIC,
  1027. ENV_TONE_MAPPER_ACES,
  1028. ENV_TONE_MAPPER_AGX,
  1029. };
  1030. virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;
  1031. 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;
  1032. 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;
  1033. enum EnvironmentSSRRoughnessQuality {
  1034. ENV_SSR_ROUGHNESS_QUALITY_DISABLED,
  1035. ENV_SSR_ROUGHNESS_QUALITY_LOW,
  1036. ENV_SSR_ROUGHNESS_QUALITY_MEDIUM,
  1037. ENV_SSR_ROUGHNESS_QUALITY_HIGH,
  1038. };
  1039. virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;
  1040. 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;
  1041. enum EnvironmentSSAOQuality {
  1042. ENV_SSAO_QUALITY_VERY_LOW,
  1043. ENV_SSAO_QUALITY_LOW,
  1044. ENV_SSAO_QUALITY_MEDIUM,
  1045. ENV_SSAO_QUALITY_HIGH,
  1046. ENV_SSAO_QUALITY_ULTRA,
  1047. };
  1048. 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;
  1049. 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;
  1050. enum EnvironmentSSILQuality {
  1051. ENV_SSIL_QUALITY_VERY_LOW,
  1052. ENV_SSIL_QUALITY_LOW,
  1053. ENV_SSIL_QUALITY_MEDIUM,
  1054. ENV_SSIL_QUALITY_HIGH,
  1055. ENV_SSIL_QUALITY_ULTRA,
  1056. };
  1057. 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;
  1058. enum EnvironmentSDFGIYScale {
  1059. ENV_SDFGI_Y_SCALE_50_PERCENT,
  1060. ENV_SDFGI_Y_SCALE_75_PERCENT,
  1061. ENV_SDFGI_Y_SCALE_100_PERCENT,
  1062. };
  1063. 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;
  1064. enum EnvironmentSDFGIRayCount {
  1065. ENV_SDFGI_RAY_COUNT_4,
  1066. ENV_SDFGI_RAY_COUNT_8,
  1067. ENV_SDFGI_RAY_COUNT_16,
  1068. ENV_SDFGI_RAY_COUNT_32,
  1069. ENV_SDFGI_RAY_COUNT_64,
  1070. ENV_SDFGI_RAY_COUNT_96,
  1071. ENV_SDFGI_RAY_COUNT_128,
  1072. ENV_SDFGI_RAY_COUNT_MAX,
  1073. };
  1074. virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;
  1075. enum EnvironmentSDFGIFramesToConverge {
  1076. ENV_SDFGI_CONVERGE_IN_5_FRAMES,
  1077. ENV_SDFGI_CONVERGE_IN_10_FRAMES,
  1078. ENV_SDFGI_CONVERGE_IN_15_FRAMES,
  1079. ENV_SDFGI_CONVERGE_IN_20_FRAMES,
  1080. ENV_SDFGI_CONVERGE_IN_25_FRAMES,
  1081. ENV_SDFGI_CONVERGE_IN_30_FRAMES,
  1082. ENV_SDFGI_CONVERGE_MAX
  1083. };
  1084. virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;
  1085. enum EnvironmentSDFGIFramesToUpdateLight {
  1086. ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,
  1087. ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,
  1088. ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,
  1089. ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,
  1090. ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,
  1091. ENV_SDFGI_UPDATE_LIGHT_MAX,
  1092. };
  1093. virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;
  1094. enum EnvironmentFogMode {
  1095. ENV_FOG_MODE_EXPONENTIAL,
  1096. ENV_FOG_MODE_DEPTH,
  1097. };
  1098. 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, EnvironmentFogMode p_mode = EnvironmentFogMode::ENV_FOG_MODE_EXPONENTIAL) = 0;
  1099. virtual void environment_set_fog_depth(RID p_env, float p_curve, float p_begin, float p_end) = 0;
  1100. 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;
  1101. virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
  1102. virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
  1103. virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
  1104. virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
  1105. enum SubSurfaceScatteringQuality {
  1106. SUB_SURFACE_SCATTERING_QUALITY_DISABLED,
  1107. SUB_SURFACE_SCATTERING_QUALITY_LOW,
  1108. SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,
  1109. SUB_SURFACE_SCATTERING_QUALITY_HIGH,
  1110. };
  1111. virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;
  1112. virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
  1113. /* CAMERA EFFECTS */
  1114. virtual RID camera_attributes_create() = 0;
  1115. enum DOFBlurQuality {
  1116. DOF_BLUR_QUALITY_VERY_LOW,
  1117. DOF_BLUR_QUALITY_LOW,
  1118. DOF_BLUR_QUALITY_MEDIUM,
  1119. DOF_BLUR_QUALITY_HIGH,
  1120. };
  1121. virtual void camera_attributes_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;
  1122. enum DOFBokehShape {
  1123. DOF_BOKEH_BOX,
  1124. DOF_BOKEH_HEXAGON,
  1125. DOF_BOKEH_CIRCLE
  1126. };
  1127. virtual void camera_attributes_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;
  1128. 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;
  1129. virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;
  1130. 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;
  1131. /* SCENARIO API */
  1132. virtual RID scenario_create() = 0;
  1133. virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;
  1134. virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;
  1135. virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;
  1136. virtual void scenario_set_compositor(RID p_scenario, RID p_compositor) = 0;
  1137. /* INSTANCING API */
  1138. enum InstanceType {
  1139. INSTANCE_NONE,
  1140. INSTANCE_MESH,
  1141. INSTANCE_MULTIMESH,
  1142. INSTANCE_PARTICLES,
  1143. INSTANCE_PARTICLES_COLLISION,
  1144. INSTANCE_LIGHT,
  1145. INSTANCE_REFLECTION_PROBE,
  1146. INSTANCE_DECAL,
  1147. INSTANCE_VOXEL_GI,
  1148. INSTANCE_LIGHTMAP,
  1149. INSTANCE_OCCLUDER,
  1150. INSTANCE_VISIBLITY_NOTIFIER, // TODO: Fix typo in "VISIBILITY" (in 5.0).
  1151. INSTANCE_FOG_VOLUME,
  1152. INSTANCE_MAX,
  1153. INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_PARTICLES)
  1154. };
  1155. virtual RID instance_create2(RID p_base, RID p_scenario);
  1156. virtual RID instance_create() = 0;
  1157. virtual void instance_set_base(RID p_instance, RID p_base) = 0;
  1158. virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;
  1159. virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;
  1160. virtual void instance_set_pivot_data(RID p_instance, float p_sorting_offset, bool p_use_aabb_center) = 0;
  1161. virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;
  1162. virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;
  1163. virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;
  1164. virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;
  1165. virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;
  1166. virtual void instance_teleport(RID p_instance) = 0;
  1167. virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;
  1168. virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;
  1169. virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;
  1170. virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;
  1171. virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;
  1172. // Don't use these in a game!
  1173. virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;
  1174. virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;
  1175. virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;
  1176. PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;
  1177. PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;
  1178. PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;
  1179. enum InstanceFlags {
  1180. INSTANCE_FLAG_USE_BAKED_LIGHT,
  1181. INSTANCE_FLAG_USE_DYNAMIC_GI,
  1182. INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,
  1183. INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,
  1184. INSTANCE_FLAG_MAX
  1185. };
  1186. enum ShadowCastingSetting {
  1187. SHADOW_CASTING_SETTING_OFF,
  1188. SHADOW_CASTING_SETTING_ON,
  1189. SHADOW_CASTING_SETTING_DOUBLE_SIDED,
  1190. SHADOW_CASTING_SETTING_SHADOWS_ONLY,
  1191. };
  1192. enum VisibilityRangeFadeMode {
  1193. VISIBILITY_RANGE_FADE_DISABLED,
  1194. VISIBILITY_RANGE_FADE_SELF,
  1195. VISIBILITY_RANGE_FADE_DEPENDENCIES,
  1196. };
  1197. virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;
  1198. virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;
  1199. virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;
  1200. virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;
  1201. 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;
  1202. virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;
  1203. virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;
  1204. virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;
  1205. virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;
  1206. virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;
  1207. virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;
  1208. virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;
  1209. /* Bake 3D objects */
  1210. enum BakeChannels {
  1211. BAKE_CHANNEL_ALBEDO_ALPHA,
  1212. BAKE_CHANNEL_NORMAL,
  1213. BAKE_CHANNEL_ORM,
  1214. BAKE_CHANNEL_EMISSION
  1215. };
  1216. virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
  1217. /* CANVAS (2D) */
  1218. virtual RID canvas_create() = 0;
  1219. virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;
  1220. virtual void canvas_set_item_repeat(RID p_item, const Point2 &p_repeat_size, int p_repeat_times) = 0;
  1221. virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;
  1222. virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;
  1223. virtual void canvas_set_disable_scale(bool p_disable) = 0;
  1224. /* CANVAS TEXTURE */
  1225. virtual RID canvas_texture_create() = 0;
  1226. enum CanvasTextureChannel {
  1227. CANVAS_TEXTURE_CHANNEL_DIFFUSE,
  1228. CANVAS_TEXTURE_CHANNEL_NORMAL,
  1229. CANVAS_TEXTURE_CHANNEL_SPECULAR,
  1230. };
  1231. virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;
  1232. virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;
  1233. // Takes effect only for new draw commands.
  1234. virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;
  1235. virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;
  1236. /* CANVAS ITEM */
  1237. virtual RID canvas_item_create() = 0;
  1238. virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;
  1239. virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;
  1240. virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;
  1241. virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;
  1242. virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;
  1243. virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;
  1244. virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  1245. virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;
  1246. virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;
  1247. virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;
  1248. virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;
  1249. virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;
  1250. virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;
  1251. virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;
  1252. virtual void canvas_item_set_use_identity_transform(RID p_item, bool p_enabled) = 0;
  1253. enum NinePatchAxisMode {
  1254. NINE_PATCH_STRETCH,
  1255. NINE_PATCH_TILE,
  1256. NINE_PATCH_TILE_FIT,
  1257. };
  1258. 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;
  1259. 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;
  1260. virtual void canvas_item_add_multiline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0, bool p_antialiased = false) = 0;
  1261. virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color, bool p_antialiased = false) = 0;
  1262. virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color, bool p_antialiased = false) = 0;
  1263. 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;
  1264. 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;
  1265. 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, float p_scale = 1.0) = 0;
  1266. 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;
  1267. 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;
  1268. 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) = 0;
  1269. 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;
  1270. 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;
  1271. 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;
  1272. virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;
  1273. virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;
  1274. virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  1275. virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;
  1276. 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;
  1277. virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;
  1278. virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;
  1279. virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;
  1280. virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;
  1281. virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;
  1282. virtual void canvas_item_clear(RID p_item) = 0;
  1283. virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;
  1284. virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;
  1285. virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;
  1286. virtual void canvas_item_set_instance_shader_parameter(RID p_item, const StringName &, const Variant &p_value) = 0;
  1287. virtual Variant canvas_item_get_instance_shader_parameter(RID p_item, const StringName &) const = 0;
  1288. virtual Variant canvas_item_get_instance_shader_parameter_default_value(RID p_item, const StringName &) const = 0;
  1289. virtual void canvas_item_get_instance_shader_parameter_list(RID p_item, List<PropertyInfo> *p_parameters) const = 0;
  1290. 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;
  1291. enum CanvasGroupMode {
  1292. CANVAS_GROUP_MODE_DISABLED,
  1293. CANVAS_GROUP_MODE_CLIP_ONLY,
  1294. CANVAS_GROUP_MODE_CLIP_AND_DRAW,
  1295. CANVAS_GROUP_MODE_TRANSPARENT,
  1296. };
  1297. 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;
  1298. virtual void canvas_item_set_debug_redraw(bool p_enabled) = 0;
  1299. virtual bool canvas_item_get_debug_redraw() const = 0;
  1300. virtual void canvas_item_set_interpolated(RID p_item, bool p_interpolated) = 0;
  1301. virtual void canvas_item_reset_physics_interpolation(RID p_item) = 0;
  1302. virtual void canvas_item_transform_physics_interpolation(RID p_item, const Transform2D &p_transform) = 0;
  1303. /* CANVAS LIGHT */
  1304. virtual RID canvas_light_create() = 0;
  1305. enum CanvasLightMode {
  1306. CANVAS_LIGHT_MODE_POINT,
  1307. CANVAS_LIGHT_MODE_DIRECTIONAL,
  1308. };
  1309. virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;
  1310. virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;
  1311. virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;
  1312. virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;
  1313. virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;
  1314. virtual void canvas_light_set_height(RID p_light, float p_height) = 0;
  1315. virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;
  1316. virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;
  1317. virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;
  1318. virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;
  1319. virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;
  1320. virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;
  1321. virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;
  1322. virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;
  1323. virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;
  1324. enum CanvasLightBlendMode {
  1325. CANVAS_LIGHT_BLEND_MODE_ADD,
  1326. CANVAS_LIGHT_BLEND_MODE_SUB,
  1327. CANVAS_LIGHT_BLEND_MODE_MIX,
  1328. };
  1329. virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;
  1330. enum CanvasLightShadowFilter {
  1331. CANVAS_LIGHT_FILTER_NONE,
  1332. CANVAS_LIGHT_FILTER_PCF5,
  1333. CANVAS_LIGHT_FILTER_PCF13,
  1334. CANVAS_LIGHT_FILTER_MAX
  1335. };
  1336. virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;
  1337. virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;
  1338. virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;
  1339. virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;
  1340. virtual void canvas_light_set_interpolated(RID p_light, bool p_interpolated) = 0;
  1341. virtual void canvas_light_reset_physics_interpolation(RID p_light) = 0;
  1342. virtual void canvas_light_transform_physics_interpolation(RID p_light, const Transform2D &p_transform) = 0;
  1343. /* CANVAS LIGHT OCCLUDER */
  1344. virtual RID canvas_light_occluder_create() = 0;
  1345. virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;
  1346. virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;
  1347. virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;
  1348. virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;
  1349. virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;
  1350. virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;
  1351. virtual void canvas_light_occluder_set_interpolated(RID p_occluder, bool p_interpolated) = 0;
  1352. virtual void canvas_light_occluder_reset_physics_interpolation(RID p_occluder) = 0;
  1353. virtual void canvas_light_occluder_transform_physics_interpolation(RID p_occluder, const Transform2D &p_transform) = 0;
  1354. /* CANVAS LIGHT OCCLUDER POLYGON */
  1355. virtual RID canvas_occluder_polygon_create() = 0;
  1356. virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;
  1357. enum CanvasOccluderPolygonCullMode {
  1358. CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,
  1359. CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,
  1360. CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,
  1361. };
  1362. virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;
  1363. virtual void canvas_set_shadow_texture_size(int p_size) = 0;
  1364. Rect2 debug_canvas_item_get_rect(RID p_item);
  1365. virtual Rect2 _debug_canvas_item_get_rect(RID p_item) = 0;
  1366. /* GLOBAL SHADER UNIFORMS */
  1367. enum GlobalShaderParameterType {
  1368. GLOBAL_VAR_TYPE_BOOL,
  1369. GLOBAL_VAR_TYPE_BVEC2,
  1370. GLOBAL_VAR_TYPE_BVEC3,
  1371. GLOBAL_VAR_TYPE_BVEC4,
  1372. GLOBAL_VAR_TYPE_INT,
  1373. GLOBAL_VAR_TYPE_IVEC2,
  1374. GLOBAL_VAR_TYPE_IVEC3,
  1375. GLOBAL_VAR_TYPE_IVEC4,
  1376. GLOBAL_VAR_TYPE_RECT2I,
  1377. GLOBAL_VAR_TYPE_UINT,
  1378. GLOBAL_VAR_TYPE_UVEC2,
  1379. GLOBAL_VAR_TYPE_UVEC3,
  1380. GLOBAL_VAR_TYPE_UVEC4,
  1381. GLOBAL_VAR_TYPE_FLOAT,
  1382. GLOBAL_VAR_TYPE_VEC2,
  1383. GLOBAL_VAR_TYPE_VEC3,
  1384. GLOBAL_VAR_TYPE_VEC4,
  1385. GLOBAL_VAR_TYPE_COLOR,
  1386. GLOBAL_VAR_TYPE_RECT2,
  1387. GLOBAL_VAR_TYPE_MAT2,
  1388. GLOBAL_VAR_TYPE_MAT3,
  1389. GLOBAL_VAR_TYPE_MAT4,
  1390. GLOBAL_VAR_TYPE_TRANSFORM_2D,
  1391. GLOBAL_VAR_TYPE_TRANSFORM,
  1392. GLOBAL_VAR_TYPE_SAMPLER2D,
  1393. GLOBAL_VAR_TYPE_SAMPLER2DARRAY,
  1394. GLOBAL_VAR_TYPE_SAMPLER3D,
  1395. GLOBAL_VAR_TYPE_SAMPLERCUBE,
  1396. GLOBAL_VAR_TYPE_SAMPLEREXT,
  1397. GLOBAL_VAR_TYPE_MAX
  1398. };
  1399. virtual void global_shader_parameter_add(const StringName &p_name, GlobalShaderParameterType p_type, const Variant &p_value) = 0;
  1400. virtual void global_shader_parameter_remove(const StringName &p_name) = 0;
  1401. virtual Vector<StringName> global_shader_parameter_get_list() const = 0;
  1402. virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;
  1403. virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;
  1404. virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;
  1405. virtual GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;
  1406. virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;
  1407. virtual void global_shader_parameters_clear() = 0;
  1408. static int global_shader_uniform_type_get_shader_datatype(GlobalShaderParameterType p_type);
  1409. /* FREE */
  1410. virtual void free(RID p_rid) = 0; // Free RIDs associated with the rendering server.
  1411. /* INTERPOLATION */
  1412. virtual void set_physics_interpolation_enabled(bool p_enabled) = 0;
  1413. /* EVENT QUEUING */
  1414. virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;
  1415. virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;
  1416. virtual void sync() = 0;
  1417. virtual bool has_changed() const = 0;
  1418. virtual void init();
  1419. virtual void finish() = 0;
  1420. virtual void tick() = 0;
  1421. virtual void pre_draw(bool p_will_draw) = 0;
  1422. /* STATUS INFORMATION */
  1423. enum RenderingInfo {
  1424. RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME,
  1425. RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME,
  1426. RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME,
  1427. RENDERING_INFO_TEXTURE_MEM_USED,
  1428. RENDERING_INFO_BUFFER_MEM_USED,
  1429. RENDERING_INFO_VIDEO_MEM_USED,
  1430. RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS,
  1431. RENDERING_INFO_PIPELINE_COMPILATIONS_MESH,
  1432. RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE,
  1433. RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW,
  1434. RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION,
  1435. RENDERING_INFO_MAX
  1436. };
  1437. virtual uint64_t get_rendering_info(RenderingInfo p_info) = 0;
  1438. virtual String get_video_adapter_name() const = 0;
  1439. virtual String get_video_adapter_vendor() const = 0;
  1440. virtual RenderingDevice::DeviceType get_video_adapter_type() const = 0;
  1441. virtual String get_video_adapter_api_version() const = 0;
  1442. struct FrameProfileArea {
  1443. String name;
  1444. double gpu_msec;
  1445. double cpu_msec;
  1446. };
  1447. virtual void set_frame_profiling_enabled(bool p_enable) = 0;
  1448. virtual Vector<FrameProfileArea> get_frame_profile() = 0;
  1449. virtual uint64_t get_frame_profile_frame() = 0;
  1450. virtual double get_frame_setup_time_cpu() const = 0;
  1451. virtual void gi_set_use_half_resolution(bool p_enable) = 0;
  1452. /* TESTING */
  1453. virtual RID get_test_cube() = 0;
  1454. virtual RID get_test_texture();
  1455. virtual RID get_white_texture();
  1456. virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
  1457. virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);
  1458. virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);
  1459. virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);
  1460. virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;
  1461. virtual Color get_default_clear_color() = 0;
  1462. virtual void set_default_clear_color(const Color &p_color) = 0;
  1463. #ifndef DISABLE_DEPRECATED
  1464. // Never actually used, should be removed when we can break compatibility.
  1465. enum Features {
  1466. FEATURE_SHADERS,
  1467. FEATURE_MULTITHREADED,
  1468. };
  1469. virtual bool has_feature(Features p_feature) const = 0;
  1470. #endif
  1471. virtual bool has_os_feature(const String &p_feature) const = 0;
  1472. virtual void set_debug_generate_wireframes(bool p_generate) = 0;
  1473. virtual void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window) = 0;
  1474. virtual bool is_low_end() const = 0;
  1475. virtual void set_print_gpu_profile(bool p_enable) = 0;
  1476. virtual Size2i get_maximum_viewport_size() const = 0;
  1477. RenderingDevice *get_rendering_device() const;
  1478. RenderingDevice *create_local_rendering_device() const;
  1479. bool is_render_loop_enabled() const;
  1480. void set_render_loop_enabled(bool p_enabled);
  1481. virtual bool is_on_render_thread() = 0;
  1482. virtual void call_on_render_thread(const Callable &p_callable) = 0;
  1483. String get_current_rendering_driver_name() const;
  1484. String get_current_rendering_method() const;
  1485. #ifdef TOOLS_ENABLED
  1486. virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;
  1487. #endif
  1488. RenderingServer();
  1489. virtual ~RenderingServer();
  1490. #ifdef TOOLS_ENABLED
  1491. typedef void (*SurfaceUpgradeCallback)();
  1492. void set_surface_upgrade_callback(SurfaceUpgradeCallback p_callback);
  1493. void set_warn_on_surface_upgrade(bool p_warn);
  1494. #endif
  1495. #ifndef DISABLE_DEPRECATED
  1496. void fix_surface_compatibility(SurfaceData &p_surface, const String &p_path = "");
  1497. #endif
  1498. private:
  1499. // Binder helpers
  1500. RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, TextureLayeredType p_layered_type);
  1501. 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);
  1502. void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);
  1503. TypedArray<Image> _texture_3d_get(RID p_texture) const;
  1504. TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;
  1505. RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);
  1506. void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);
  1507. Dictionary _mesh_get_surface(RID p_mesh, int p_idx);
  1508. TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;
  1509. TypedArray<Dictionary> _canvas_item_get_instance_shader_parameter_list(RID p_item) const;
  1510. TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);
  1511. void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);
  1512. #ifdef TOOLS_ENABLED
  1513. SurfaceUpgradeCallback surface_upgrade_callback = nullptr;
  1514. bool warn_on_surface_upgrade = true;
  1515. #endif
  1516. };
  1517. // Make variant understand the enums.
  1518. VARIANT_ENUM_CAST(RenderingServer::TextureType);
  1519. VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);
  1520. VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);
  1521. VARIANT_ENUM_CAST(RenderingServer::PipelineSource);
  1522. VARIANT_ENUM_CAST(RenderingServer::ShaderMode);
  1523. VARIANT_ENUM_CAST(RenderingServer::ArrayType);
  1524. VARIANT_BITFIELD_CAST(RenderingServer::ArrayFormat);
  1525. VARIANT_ENUM_CAST(RenderingServer::ArrayCustomFormat);
  1526. VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);
  1527. VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);
  1528. VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);
  1529. VARIANT_ENUM_CAST(RenderingServer::MultimeshPhysicsInterpolationQuality);
  1530. VARIANT_ENUM_CAST(RenderingServer::LightType);
  1531. VARIANT_ENUM_CAST(RenderingServer::LightParam);
  1532. VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);
  1533. VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);
  1534. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);
  1535. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalSkyMode);
  1536. VARIANT_ENUM_CAST(RenderingServer::LightProjectorFilter);
  1537. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);
  1538. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);
  1539. VARIANT_ENUM_CAST(RenderingServer::VoxelGIQuality);
  1540. VARIANT_ENUM_CAST(RenderingServer::DecalTexture);
  1541. VARIANT_ENUM_CAST(RenderingServer::DecalFilter);
  1542. VARIANT_ENUM_CAST(RenderingServer::ParticlesMode);
  1543. VARIANT_ENUM_CAST(RenderingServer::ParticlesTransformAlign);
  1544. VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);
  1545. VARIANT_ENUM_CAST(RenderingServer::ParticlesEmitFlags);
  1546. VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionType);
  1547. VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionHeightfieldResolution);
  1548. VARIANT_ENUM_CAST(RenderingServer::FogVolumeShape);
  1549. VARIANT_ENUM_CAST(RenderingServer::ViewportScaling3DMode);
  1550. VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);
  1551. VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);
  1552. VARIANT_ENUM_CAST(RenderingServer::ViewportEnvironmentMode);
  1553. VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);
  1554. VARIANT_ENUM_CAST(RenderingServer::ViewportAnisotropicFiltering);
  1555. VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);
  1556. VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);
  1557. VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfoType);
  1558. VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);
  1559. VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);
  1560. VARIANT_ENUM_CAST(RenderingServer::ViewportSDFOversize);
  1561. VARIANT_ENUM_CAST(RenderingServer::ViewportSDFScale);
  1562. VARIANT_ENUM_CAST(RenderingServer::ViewportVRSMode);
  1563. VARIANT_ENUM_CAST(RenderingServer::ViewportVRSUpdateMode);
  1564. VARIANT_ENUM_CAST(RenderingServer::SkyMode);
  1565. VARIANT_ENUM_CAST(RenderingServer::CompositorEffectCallbackType);
  1566. VARIANT_ENUM_CAST(RenderingServer::CompositorEffectFlags);
  1567. VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);
  1568. VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);
  1569. VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);
  1570. VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);
  1571. VARIANT_ENUM_CAST(RenderingServer::EnvironmentFogMode);
  1572. VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);
  1573. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);
  1574. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);
  1575. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSILQuality);
  1576. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToConverge);
  1577. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIRayCount);
  1578. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToUpdateLight);
  1579. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIYScale);
  1580. VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);
  1581. VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);
  1582. VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);
  1583. VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);
  1584. VARIANT_ENUM_CAST(RenderingServer::InstanceType);
  1585. VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);
  1586. VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);
  1587. VARIANT_ENUM_CAST(RenderingServer::VisibilityRangeFadeMode);
  1588. VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);
  1589. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);
  1590. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);
  1591. VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);
  1592. VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);
  1593. VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);
  1594. VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);
  1595. VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);
  1596. VARIANT_ENUM_CAST(RenderingServer::GlobalShaderParameterType);
  1597. VARIANT_ENUM_CAST(RenderingServer::RenderingInfo);
  1598. VARIANT_ENUM_CAST(RenderingServer::CanvasTextureChannel);
  1599. VARIANT_ENUM_CAST(RenderingServer::BakeChannels);
  1600. #ifndef DISABLE_DEPRECATED
  1601. VARIANT_ENUM_CAST(RenderingServer::Features);
  1602. #endif
  1603. // Alias to make it easier to use.
  1604. #define RS RenderingServer