rendering_server.h 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573
  1. /*************************************************************************/
  2. /* rendering_server.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef RENDERING_SERVER_H
  31. #define RENDERING_SERVER_H
  32. #include "core/io/image.h"
  33. #include "core/math/geometry_3d.h"
  34. #include "core/math/transform_2d.h"
  35. #include "core/object/class_db.h"
  36. #include "core/templates/rid.h"
  37. #include "core/variant/typed_array.h"
  38. #include "core/variant/variant.h"
  39. #include "servers/display_server.h"
  40. #include "servers/rendering/renderer_thread_pool.h"
  41. #include "servers/rendering/rendering_device.h"
  42. #include "servers/rendering/shader_language.h"
  43. class RenderingServer : public Object {
  44. GDCLASS(RenderingServer, Object);
  45. static RenderingServer *singleton;
  46. int mm_policy;
  47. bool render_loop_enabled = true;
  48. Array _get_array_from_surface(uint32_t p_format, Vector<uint8_t> p_vertex_data, Vector<uint8_t> p_attrib_data, Vector<uint8_t> p_skin_data, int p_vertex_len, Vector<uint8_t> p_index_data, int p_index_len) const;
  49. RendererThreadPool *thread_pool = nullptr;
  50. protected:
  51. RID _make_test_cube();
  52. void _free_internal_rids();
  53. RID test_texture;
  54. RID white_texture;
  55. RID test_material;
  56. Error _surface_set_data(Array p_arrays, uint32_t p_format, uint32_t *p_offsets, uint32_t p_vertex_stride, uint32_t p_attrib_stride, uint32_t p_skin_stride, Vector<uint8_t> &r_vertex_array, Vector<uint8_t> &r_attrib_array, Vector<uint8_t> &r_skin_array, int p_vertex_array_len, Vector<uint8_t> &r_index_array, int p_index_array_len, AABB &r_aabb, Vector<AABB> &r_bone_aabb);
  57. static RenderingServer *(*create_func)();
  58. static void _bind_methods();
  59. public:
  60. static RenderingServer *get_singleton();
  61. static RenderingServer *create();
  62. enum {
  63. NO_INDEX_ARRAY = -1,
  64. ARRAY_WEIGHTS_SIZE = 4,
  65. CANVAS_ITEM_Z_MIN = -4096,
  66. CANVAS_ITEM_Z_MAX = 4096,
  67. MAX_GLOW_LEVELS = 7,
  68. MAX_CURSORS = 8,
  69. MAX_2D_DIRECTIONAL_LIGHTS = 8
  70. };
  71. /* TEXTURE API */
  72. enum TextureLayeredType {
  73. TEXTURE_LAYERED_2D_ARRAY,
  74. TEXTURE_LAYERED_CUBEMAP,
  75. TEXTURE_LAYERED_CUBEMAP_ARRAY,
  76. };
  77. enum CubeMapLayer {
  78. CUBEMAP_LAYER_LEFT,
  79. CUBEMAP_LAYER_RIGHT,
  80. CUBEMAP_LAYER_BOTTOM,
  81. CUBEMAP_LAYER_TOP,
  82. CUBEMAP_LAYER_FRONT,
  83. CUBEMAP_LAYER_BACK
  84. };
  85. virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
  86. virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;
  87. 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
  88. virtual RID texture_proxy_create(RID p_base) = 0;
  89. virtual void texture_2d_update_immediate(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0; //mostly used for video and streaming
  90. virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
  91. virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
  92. virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;
  93. //these two APIs can be used together or in combination with the others.
  94. virtual RID texture_2d_placeholder_create() = 0;
  95. virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;
  96. virtual RID texture_3d_placeholder_create() = 0;
  97. virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
  98. virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
  99. virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
  100. virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
  101. virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
  102. // FIXME: Disabled during Vulkan refactoring, should be ported.
  103. #if 0
  104. virtual void texture_bind(RID p_texture, uint32_t p_texture_no) = 0;
  105. #endif
  106. virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
  107. virtual String texture_get_path(RID p_texture) const = 0;
  108. typedef void (*TextureDetectCallback)(void *);
  109. virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  110. virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
  111. enum TextureDetectRoughnessChannel {
  112. TEXTURE_DETECT_ROUGHNESS_R,
  113. TEXTURE_DETECT_ROUGHNESS_G,
  114. TEXTURE_DETECT_ROUGHNESS_B,
  115. TEXTURE_DETECT_ROUGHNESS_A,
  116. TEXTURE_DETECT_ROUGHNESS_GRAY,
  117. };
  118. typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);
  119. virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
  120. struct TextureInfo {
  121. RID texture;
  122. uint32_t width;
  123. uint32_t height;
  124. uint32_t depth;
  125. Image::Format format;
  126. int bytes;
  127. String path;
  128. };
  129. virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;
  130. Array _texture_debug_usage_bind();
  131. virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
  132. /* SHADER API */
  133. enum ShaderMode {
  134. SHADER_SPATIAL,
  135. SHADER_CANVAS_ITEM,
  136. SHADER_PARTICLES,
  137. SHADER_SKY,
  138. SHADER_MAX
  139. };
  140. virtual RID shader_create() = 0;
  141. virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
  142. virtual String shader_get_code(RID p_shader) const = 0;
  143. virtual void shader_get_param_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
  144. Array _shader_get_param_list_bind(RID p_shader) const;
  145. virtual Variant shader_get_param_default(RID p_shader, const StringName &p_param) const = 0;
  146. virtual void shader_set_default_texture_param(RID p_shader, const StringName &p_name, RID p_texture) = 0;
  147. virtual RID shader_get_default_texture_param(RID p_shader, const StringName &p_name) const = 0;
  148. struct ShaderNativeSourceCode {
  149. struct Version {
  150. struct Stage {
  151. String name;
  152. String code;
  153. };
  154. Vector<Stage> stages;
  155. };
  156. Vector<Version> versions;
  157. };
  158. virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;
  159. /* COMMON MATERIAL API */
  160. enum {
  161. MATERIAL_RENDER_PRIORITY_MIN = -128,
  162. MATERIAL_RENDER_PRIORITY_MAX = 127,
  163. };
  164. virtual RID material_create() = 0;
  165. virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
  166. virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
  167. virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
  168. virtual void material_set_render_priority(RID p_material, int priority) = 0;
  169. virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
  170. /* MESH API */
  171. enum ArrayType {
  172. ARRAY_VERTEX = 0, // RG32F or RGB32F (depending on 2D bit)
  173. ARRAY_NORMAL = 1, // A2B10G10R10
  174. ARRAY_TANGENT = 2, // A2B10G10R10, A flips sign of binormal
  175. ARRAY_COLOR = 3, // RGBA16F
  176. ARRAY_TEX_UV = 4, // RG32F
  177. ARRAY_TEX_UV2 = 5, // RG32F
  178. ARRAY_CUSTOM0 = 6, // depends on ArrayCustomFormat
  179. ARRAY_CUSTOM1 = 7,
  180. ARRAY_CUSTOM2 = 8,
  181. ARRAY_CUSTOM3 = 9,
  182. ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)
  183. ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)
  184. ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF
  185. ARRAY_MAX = 13
  186. };
  187. enum {
  188. ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0
  189. };
  190. enum ArrayCustomFormat {
  191. ARRAY_CUSTOM_RGBA8_UNORM,
  192. ARRAY_CUSTOM_RGBA8_SNORM,
  193. ARRAY_CUSTOM_RG_HALF,
  194. ARRAY_CUSTOM_RGBA_HALF,
  195. ARRAY_CUSTOM_R_FLOAT,
  196. ARRAY_CUSTOM_RG_FLOAT,
  197. ARRAY_CUSTOM_RGB_FLOAT,
  198. ARRAY_CUSTOM_RGBA_FLOAT,
  199. ARRAY_CUSTOM_MAX
  200. };
  201. enum ArrayFormat {
  202. /* ARRAY FORMAT FLAGS */
  203. ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX, // mandatory
  204. ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,
  205. ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,
  206. ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,
  207. ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,
  208. ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,
  209. ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,
  210. ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,
  211. ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,
  212. ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,
  213. ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,
  214. ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,
  215. ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,
  216. ARRAY_FORMAT_BLEND_SHAPE_MASK = (~(ARRAY_FORMAT_COLOR | ARRAY_FORMAT_TEX_UV | ARRAY_FORMAT_TEX_UV2 | ARRAY_FORMAT_BONES | ARRAY_FORMAT_WEIGHTS | ARRAY_FORMAT_CUSTOM0 | ARRAY_FORMAT_CUSTOM1 | ARRAY_FORMAT_CUSTOM2 | ARRAY_FORMAT_CUSTOM3 | ARRAY_FORMAT_INDEX)) & 0x7FFFFFFF,
  217. ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),
  218. ARRAY_FORMAT_CUSTOM_BITS = 3,
  219. ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),
  220. ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),
  221. ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),
  222. ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),
  223. ARRAY_FORMAT_CUSTOM_MASK = 0x7,
  224. ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),
  225. ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),
  226. ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),
  227. ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),
  228. };
  229. enum PrimitiveType {
  230. PRIMITIVE_POINTS,
  231. PRIMITIVE_LINES,
  232. PRIMITIVE_LINE_STRIP,
  233. PRIMITIVE_TRIANGLES,
  234. PRIMITIVE_TRIANGLE_STRIP,
  235. PRIMITIVE_MAX,
  236. };
  237. struct SurfaceData {
  238. PrimitiveType primitive = PRIMITIVE_MAX;
  239. uint32_t format = 0;
  240. Vector<uint8_t> vertex_data; // vertex, normal, tangent (change with skinning, blendshape)
  241. Vector<uint8_t> attribute_data; // color,uv, uv2, custom0-3
  242. Vector<uint8_t> skin_data; // bone index, bone weight
  243. uint32_t vertex_count = 0;
  244. Vector<uint8_t> index_data;
  245. uint32_t index_count = 0;
  246. AABB aabb;
  247. struct LOD {
  248. float edge_length;
  249. Vector<uint8_t> index_data;
  250. };
  251. Vector<LOD> lods;
  252. Vector<AABB> bone_aabbs;
  253. Vector<uint8_t> blend_shape_data;
  254. RID material;
  255. };
  256. virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;
  257. virtual RID mesh_create() = 0;
  258. virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;
  259. virtual uint32_t mesh_surface_get_format_offset(uint32_t p_format, int p_vertex_len, int p_array_index) const;
  260. virtual uint32_t mesh_surface_get_format_vertex_stride(uint32_t p_format, int p_vertex_len) const;
  261. virtual uint32_t mesh_surface_get_format_attribute_stride(uint32_t p_format, int p_vertex_len) const;
  262. virtual uint32_t mesh_surface_get_format_skin_stride(uint32_t p_format, int p_vertex_len) const;
  263. /// Returns stride
  264. virtual void mesh_surface_make_offsets_from_format(uint32_t p_format, int p_vertex_len, int p_index_len, uint32_t *r_offsets, uint32_t &r_vertex_element_size, uint32_t &r_attrib_element_size, uint32_t &r_skin_element_size) const;
  265. virtual Error mesh_create_surface_data_from_arrays(SurfaceData *r_surface_data, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint32_t p_compress_format = 0);
  266. Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;
  267. Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;
  268. Array mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;
  269. Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;
  270. virtual void mesh_add_surface_from_arrays(RID p_mesh, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint32_t p_compress_format = 0);
  271. virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;
  272. virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
  273. enum BlendShapeMode {
  274. BLEND_SHAPE_MODE_NORMALIZED,
  275. BLEND_SHAPE_MODE_RELATIVE,
  276. };
  277. virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;
  278. virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
  279. virtual void mesh_surface_update_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
  280. virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
  281. virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
  282. virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
  283. virtual int mesh_get_surface_count(RID p_mesh) const = 0;
  284. virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
  285. virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
  286. virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;
  287. virtual void mesh_clear(RID p_mesh) = 0;
  288. /* MULTIMESH API */
  289. virtual RID multimesh_create() = 0;
  290. enum MultimeshTransformFormat {
  291. MULTIMESH_TRANSFORM_2D,
  292. MULTIMESH_TRANSFORM_3D,
  293. };
  294. virtual void multimesh_allocate_data(RID p_multimesh, int p_instances, MultimeshTransformFormat p_transform_format, bool p_use_colors = false, bool p_use_custom_data = false) = 0;
  295. virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
  296. virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
  297. virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform &p_transform) = 0;
  298. virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
  299. virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
  300. virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
  301. virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
  302. virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
  303. virtual Transform multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
  304. virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
  305. virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
  306. virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
  307. virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
  308. virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
  309. virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
  310. virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
  311. /* IMMEDIATE API */
  312. virtual RID immediate_create() = 0;
  313. virtual void immediate_begin(RID p_immediate, PrimitiveType p_rimitive, RID p_texture = RID()) = 0;
  314. virtual void immediate_vertex(RID p_immediate, const Vector3 &p_vertex) = 0;
  315. virtual void immediate_vertex_2d(RID p_immediate, const Vector2 &p_vertex);
  316. virtual void immediate_normal(RID p_immediate, const Vector3 &p_normal) = 0;
  317. virtual void immediate_tangent(RID p_immediate, const Plane &p_tangent) = 0;
  318. virtual void immediate_color(RID p_immediate, const Color &p_color) = 0;
  319. virtual void immediate_uv(RID p_immediate, const Vector2 &tex_uv) = 0;
  320. virtual void immediate_uv2(RID p_immediate, const Vector2 &tex_uv) = 0;
  321. virtual void immediate_end(RID p_immediate) = 0;
  322. virtual void immediate_clear(RID p_immediate) = 0;
  323. virtual void immediate_set_material(RID p_immediate, RID p_material) = 0;
  324. virtual RID immediate_get_material(RID p_immediate) const = 0;
  325. /* SKELETON API */
  326. virtual RID skeleton_create() = 0;
  327. virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
  328. virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
  329. virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform &p_transform) = 0;
  330. virtual Transform skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
  331. virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
  332. virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
  333. virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
  334. /* Light API */
  335. enum LightType {
  336. LIGHT_DIRECTIONAL,
  337. LIGHT_OMNI,
  338. LIGHT_SPOT
  339. };
  340. enum LightParam {
  341. LIGHT_PARAM_ENERGY,
  342. LIGHT_PARAM_INDIRECT_ENERGY,
  343. LIGHT_PARAM_SPECULAR,
  344. LIGHT_PARAM_RANGE,
  345. LIGHT_PARAM_SIZE,
  346. LIGHT_PARAM_ATTENUATION,
  347. LIGHT_PARAM_SPOT_ANGLE,
  348. LIGHT_PARAM_SPOT_ATTENUATION,
  349. LIGHT_PARAM_SHADOW_MAX_DISTANCE,
  350. LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,
  351. LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,
  352. LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,
  353. LIGHT_PARAM_SHADOW_FADE_START,
  354. LIGHT_PARAM_SHADOW_NORMAL_BIAS,
  355. LIGHT_PARAM_SHADOW_BIAS,
  356. LIGHT_PARAM_SHADOW_PANCAKE_SIZE,
  357. LIGHT_PARAM_SHADOW_BLUR,
  358. LIGHT_PARAM_SHADOW_VOLUMETRIC_FOG_FADE,
  359. LIGHT_PARAM_TRANSMITTANCE_BIAS,
  360. LIGHT_PARAM_MAX
  361. };
  362. virtual RID directional_light_create() = 0;
  363. virtual RID omni_light_create() = 0;
  364. virtual RID spot_light_create() = 0;
  365. virtual void light_set_color(RID p_light, const Color &p_color) = 0;
  366. virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;
  367. virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
  368. virtual void light_set_shadow_color(RID p_light, const Color &p_color) = 0;
  369. virtual void light_set_projector(RID p_light, RID p_texture) = 0;
  370. virtual void light_set_negative(RID p_light, bool p_enable) = 0;
  371. virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
  372. virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
  373. enum LightBakeMode {
  374. LIGHT_BAKE_DISABLED,
  375. LIGHT_BAKE_DYNAMIC,
  376. LIGHT_BAKE_STATIC,
  377. };
  378. virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;
  379. virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
  380. // omni light
  381. enum LightOmniShadowMode {
  382. LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,
  383. LIGHT_OMNI_SHADOW_CUBE,
  384. };
  385. virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;
  386. // directional light
  387. enum LightDirectionalShadowMode {
  388. LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,
  389. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,
  390. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,
  391. };
  392. virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;
  393. virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
  394. virtual void light_directional_set_sky_only(RID p_light, bool p_sky_only) = 0;
  395. enum LightDirectionalShadowDepthRangeMode {
  396. LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE,
  397. LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED,
  398. };
  399. virtual void light_directional_set_shadow_depth_range_mode(RID p_light, LightDirectionalShadowDepthRangeMode p_range_mode) = 0;
  400. /* PROBE API */
  401. virtual RID reflection_probe_create() = 0;
  402. enum ReflectionProbeUpdateMode {
  403. REFLECTION_PROBE_UPDATE_ONCE,
  404. REFLECTION_PROBE_UPDATE_ALWAYS,
  405. };
  406. virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;
  407. virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
  408. enum ReflectionProbeAmbientMode {
  409. REFLECTION_PROBE_AMBIENT_DISABLED,
  410. REFLECTION_PROBE_AMBIENT_ENVIRONMENT,
  411. REFLECTION_PROBE_AMBIENT_COLOR,
  412. };
  413. virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;
  414. virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
  415. virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
  416. virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
  417. virtual void reflection_probe_set_extents(RID p_probe, const Vector3 &p_extents) = 0;
  418. virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
  419. virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
  420. virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
  421. virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
  422. virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
  423. virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
  424. virtual void reflection_probe_set_lod_threshold(RID p_probe, float p_pixels) = 0;
  425. /* DECAL API */
  426. enum DecalTexture {
  427. DECAL_TEXTURE_ALBEDO,
  428. DECAL_TEXTURE_NORMAL,
  429. DECAL_TEXTURE_ORM,
  430. DECAL_TEXTURE_EMISSION,
  431. DECAL_TEXTURE_MAX
  432. };
  433. virtual RID decal_create() = 0;
  434. virtual void decal_set_extents(RID p_decal, const Vector3 &p_extents) = 0;
  435. virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;
  436. virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
  437. virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
  438. virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
  439. virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
  440. virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
  441. virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
  442. virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
  443. /* GI PROBE API */
  444. virtual RID gi_probe_create() = 0;
  445. virtual void gi_probe_allocate_data(RID p_gi_probe, const Transform &p_to_cell_xform, const AABB &p_aabb, const Vector3i &p_octree_size, const Vector<uint8_t> &p_octree_cells, const Vector<uint8_t> &p_data_cells, const Vector<uint8_t> &p_distance_field, const Vector<int> &p_level_counts) = 0;
  446. virtual AABB gi_probe_get_bounds(RID p_gi_probe) const = 0;
  447. virtual Vector3i gi_probe_get_octree_size(RID p_gi_probe) const = 0;
  448. virtual Vector<uint8_t> gi_probe_get_octree_cells(RID p_gi_probe) const = 0;
  449. virtual Vector<uint8_t> gi_probe_get_data_cells(RID p_gi_probe) const = 0;
  450. virtual Vector<uint8_t> gi_probe_get_distance_field(RID p_gi_probe) const = 0;
  451. virtual Vector<int> gi_probe_get_level_counts(RID p_gi_probe) const = 0;
  452. virtual Transform gi_probe_get_to_cell_xform(RID p_gi_probe) const = 0;
  453. virtual void gi_probe_set_dynamic_range(RID p_gi_probe, float p_range) = 0;
  454. virtual float gi_probe_get_dynamic_range(RID p_gi_probe) const = 0;
  455. virtual void gi_probe_set_propagation(RID p_gi_probe, float p_range) = 0;
  456. virtual float gi_probe_get_propagation(RID p_gi_probe) const = 0;
  457. virtual void gi_probe_set_energy(RID p_gi_probe, float p_energy) = 0;
  458. virtual float gi_probe_get_energy(RID p_gi_probe) const = 0;
  459. virtual void gi_probe_set_ao(RID p_gi_probe, float p_ao) = 0;
  460. virtual float gi_probe_get_ao(RID p_gi_probe) const = 0;
  461. virtual void gi_probe_set_ao_size(RID p_gi_probe, float p_strength) = 0;
  462. virtual float gi_probe_get_ao_size(RID p_gi_probe) const = 0;
  463. virtual void gi_probe_set_bias(RID p_gi_probe, float p_bias) = 0;
  464. virtual float gi_probe_get_bias(RID p_gi_probe) const = 0;
  465. virtual void gi_probe_set_normal_bias(RID p_gi_probe, float p_range) = 0;
  466. virtual float gi_probe_get_normal_bias(RID p_gi_probe) const = 0;
  467. virtual void gi_probe_set_interior(RID p_gi_probe, bool p_enable) = 0;
  468. virtual bool gi_probe_is_interior(RID p_gi_probe) const = 0;
  469. virtual void gi_probe_set_use_two_bounces(RID p_gi_probe, bool p_enable) = 0;
  470. virtual bool gi_probe_is_using_two_bounces(RID p_gi_probe) const = 0;
  471. virtual void gi_probe_set_anisotropy_strength(RID p_gi_probe, float p_strength) = 0;
  472. virtual float gi_probe_get_anisotropy_strength(RID p_gi_probe) const = 0;
  473. enum GIProbeQuality {
  474. GI_PROBE_QUALITY_LOW,
  475. GI_PROBE_QUALITY_HIGH,
  476. };
  477. virtual void gi_probe_set_quality(GIProbeQuality) = 0;
  478. /* LIGHTMAP */
  479. virtual RID lightmap_create() = 0;
  480. virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
  481. virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
  482. virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
  483. 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;
  484. virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
  485. virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
  486. virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
  487. virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
  488. virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
  489. /* PARTICLES API */
  490. virtual RID particles_create() = 0;
  491. virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;
  492. virtual bool particles_get_emitting(RID p_particles) = 0;
  493. virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
  494. virtual void particles_set_lifetime(RID p_particles, float p_lifetime) = 0;
  495. virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
  496. virtual void particles_set_pre_process_time(RID p_particles, float p_time) = 0;
  497. virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
  498. virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
  499. virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
  500. virtual void particles_set_speed_scale(RID p_particles, float p_scale) = 0;
  501. virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
  502. virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
  503. virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
  504. virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;
  505. virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
  506. virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
  507. enum ParticlesTransformAlign {
  508. PARTICLES_TRANSFORM_ALIGN_DISABLED,
  509. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,
  510. PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,
  511. PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,
  512. };
  513. virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;
  514. virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;
  515. virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform> &p_bind_poses) = 0;
  516. virtual bool particles_is_inactive(RID p_particles) = 0;
  517. virtual void particles_request_process(RID p_particles) = 0;
  518. virtual void particles_restart(RID p_particles) = 0;
  519. virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
  520. enum ParticlesEmitFlags {
  521. PARTICLES_EMIT_FLAG_POSITION = 1,
  522. PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,
  523. PARTICLES_EMIT_FLAG_VELOCITY = 4,
  524. PARTICLES_EMIT_FLAG_COLOR = 8,
  525. PARTICLES_EMIT_FLAG_CUSTOM = 16
  526. };
  527. virtual void particles_emit(RID p_particles, const Transform &p_transform, const Vector3 &p_velocity, const Color &p_color, const Color &p_custom, uint32_t p_emit_flags) = 0;
  528. enum ParticlesDrawOrder {
  529. PARTICLES_DRAW_ORDER_INDEX,
  530. PARTICLES_DRAW_ORDER_LIFETIME,
  531. PARTICLES_DRAW_ORDER_VIEW_DEPTH,
  532. };
  533. virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;
  534. virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
  535. virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
  536. virtual AABB particles_get_current_aabb(RID p_particles) = 0;
  537. virtual void particles_set_emission_transform(RID p_particles, const Transform &p_transform) = 0; //this is only used for 2D, in 3D it's automatic
  538. /* PARTICLES COLLISION API */
  539. virtual RID particles_collision_create() = 0;
  540. enum ParticlesCollisionType {
  541. PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,
  542. PARTICLES_COLLISION_TYPE_BOX_ATTRACT,
  543. PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,
  544. PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,
  545. PARTICLES_COLLISION_TYPE_BOX_COLLIDE,
  546. PARTICLES_COLLISION_TYPE_SDF_COLLIDE,
  547. PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,
  548. };
  549. virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;
  550. virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
  551. virtual void particles_collision_set_sphere_radius(RID p_particles_collision, float p_radius) = 0; //for spheres
  552. virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; //for non-spheres
  553. virtual void particles_collision_set_attractor_strength(RID p_particles_collision, float p_strength) = 0;
  554. virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, float p_directionality) = 0;
  555. virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, float p_curve) = 0;
  556. virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; //for SDF and vector field, heightfield is dynamic
  557. virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; //for SDF and vector field
  558. enum ParticlesCollisionHeightfieldResolution { //longest axis resolution
  559. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,
  560. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,
  561. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,
  562. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,
  563. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,
  564. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,
  565. PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,
  566. };
  567. virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; //for SDF and vector field
  568. /* CAMERA API */
  569. virtual RID camera_create() = 0;
  570. virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;
  571. virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;
  572. virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;
  573. virtual void camera_set_transform(RID p_camera, const Transform &p_transform) = 0;
  574. virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;
  575. virtual void camera_set_environment(RID p_camera, RID p_env) = 0;
  576. virtual void camera_set_camera_effects(RID p_camera, RID p_camera_effects) = 0;
  577. virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;
  578. /* OCCLUDER API */
  579. virtual RID occluder_create() = 0;
  580. virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;
  581. /* VIEWPORT TARGET API */
  582. enum CanvasItemTextureFilter {
  583. CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, //uses canvas item setting for draw command, uses global setting for canvas item
  584. CANVAS_ITEM_TEXTURE_FILTER_NEAREST,
  585. CANVAS_ITEM_TEXTURE_FILTER_LINEAR,
  586. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,
  587. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,
  588. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,
  589. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,
  590. CANVAS_ITEM_TEXTURE_FILTER_MAX
  591. };
  592. enum CanvasItemTextureRepeat {
  593. CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, //uses canvas item setting for draw command, uses global setting for canvas item
  594. CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,
  595. CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,
  596. CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,
  597. CANVAS_ITEM_TEXTURE_REPEAT_MAX,
  598. };
  599. virtual RID viewport_create() = 0;
  600. virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;
  601. virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;
  602. virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;
  603. virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;
  604. virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;
  605. virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;
  606. enum ViewportUpdateMode {
  607. VIEWPORT_UPDATE_DISABLED,
  608. VIEWPORT_UPDATE_ONCE, //then goes to disabled, must be manually updated
  609. VIEWPORT_UPDATE_WHEN_VISIBLE, // default
  610. VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,
  611. VIEWPORT_UPDATE_ALWAYS
  612. };
  613. virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;
  614. enum ViewportClearMode {
  615. VIEWPORT_CLEAR_ALWAYS,
  616. VIEWPORT_CLEAR_NEVER,
  617. VIEWPORT_CLEAR_ONLY_NEXT_FRAME
  618. };
  619. virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;
  620. virtual RID viewport_get_texture(RID p_viewport) const = 0;
  621. virtual void viewport_set_hide_scenario(RID p_viewport, bool p_hide) = 0;
  622. virtual void viewport_set_hide_canvas(RID p_viewport, bool p_hide) = 0;
  623. virtual void viewport_set_disable_environment(RID p_viewport, bool p_disable) = 0;
  624. virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;
  625. virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;
  626. virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;
  627. virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;
  628. virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;
  629. virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;
  630. virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;
  631. virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;
  632. virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;
  633. virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;
  634. virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;
  635. virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;
  636. enum ViewportSDFOversize {
  637. VIEWPORT_SDF_OVERSIZE_100_PERCENT,
  638. VIEWPORT_SDF_OVERSIZE_120_PERCENT,
  639. VIEWPORT_SDF_OVERSIZE_150_PERCENT,
  640. VIEWPORT_SDF_OVERSIZE_200_PERCENT,
  641. VIEWPORT_SDF_OVERSIZE_MAX
  642. };
  643. enum ViewportSDFScale {
  644. VIEWPORT_SDF_SCALE_100_PERCENT,
  645. VIEWPORT_SDF_SCALE_50_PERCENT,
  646. VIEWPORT_SDF_SCALE_25_PERCENT,
  647. VIEWPORT_SDF_SCALE_MAX
  648. };
  649. virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;
  650. virtual void viewport_set_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = false) = 0;
  651. virtual void viewport_set_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;
  652. enum ViewportMSAA {
  653. VIEWPORT_MSAA_DISABLED,
  654. VIEWPORT_MSAA_2X,
  655. VIEWPORT_MSAA_4X,
  656. VIEWPORT_MSAA_8X,
  657. VIEWPORT_MSAA_16X,
  658. VIEWPORT_MSAA_MAX,
  659. };
  660. virtual void viewport_set_msaa(RID p_viewport, ViewportMSAA p_msaa) = 0;
  661. enum ViewportScreenSpaceAA {
  662. VIEWPORT_SCREEN_SPACE_AA_DISABLED,
  663. VIEWPORT_SCREEN_SPACE_AA_FXAA,
  664. VIEWPORT_SCREEN_SPACE_AA_MAX,
  665. };
  666. virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;
  667. virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;
  668. virtual void viewport_set_lod_threshold(RID p_viewport, float p_pixels) = 0;
  669. virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_debanding) = 0;
  670. virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;
  671. enum ViewportOcclusionCullingBuildQuality {
  672. VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,
  673. VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,
  674. VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,
  675. };
  676. virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;
  677. enum ViewportRenderInfo {
  678. VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,
  679. VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME,
  680. VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME,
  681. VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME,
  682. VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME,
  683. VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,
  684. VIEWPORT_RENDER_INFO_MAX,
  685. };
  686. virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfo p_info) = 0;
  687. enum ViewportDebugDraw {
  688. VIEWPORT_DEBUG_DRAW_DISABLED,
  689. VIEWPORT_DEBUG_DRAW_UNSHADED,
  690. VIEWPORT_DEBUG_DRAW_LIGHTING,
  691. VIEWPORT_DEBUG_DRAW_OVERDRAW,
  692. VIEWPORT_DEBUG_DRAW_WIREFRAME,
  693. VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,
  694. VIEWPORT_DEBUG_DRAW_GI_PROBE_ALBEDO,
  695. VIEWPORT_DEBUG_DRAW_GI_PROBE_LIGHTING,
  696. VIEWPORT_DEBUG_DRAW_GI_PROBE_EMISSION,
  697. VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,
  698. VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,
  699. VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,
  700. VIEWPORT_DEBUG_DRAW_SSAO,
  701. VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,
  702. VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,
  703. VIEWPORT_DEBUG_DRAW_SDFGI,
  704. VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,
  705. VIEWPORT_DEBUG_DRAW_GI_BUFFER,
  706. VIEWPORT_DEBUG_DRAW_DISABLE_LOD,
  707. VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,
  708. VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,
  709. VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,
  710. VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,
  711. VIEWPORT_DEBUG_DRAW_OCCLUDERS,
  712. };
  713. virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;
  714. virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;
  715. virtual float viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;
  716. virtual float viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;
  717. virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = false) = 0;
  718. /* SKY API */
  719. enum SkyMode {
  720. SKY_MODE_AUTOMATIC,
  721. SKY_MODE_QUALITY,
  722. SKY_MODE_INCREMENTAL,
  723. SKY_MODE_REALTIME
  724. };
  725. virtual RID sky_create() = 0;
  726. virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
  727. virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;
  728. virtual void sky_set_material(RID p_sky, RID p_material) = 0;
  729. virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
  730. /* ENVIRONMENT API */
  731. virtual RID environment_create() = 0;
  732. enum EnvironmentBG {
  733. ENV_BG_CLEAR_COLOR,
  734. ENV_BG_COLOR,
  735. ENV_BG_SKY,
  736. ENV_BG_CANVAS,
  737. ENV_BG_KEEP,
  738. ENV_BG_CAMERA_FEED,
  739. ENV_BG_MAX
  740. };
  741. enum EnvironmentAmbientSource {
  742. ENV_AMBIENT_SOURCE_BG,
  743. ENV_AMBIENT_SOURCE_DISABLED,
  744. ENV_AMBIENT_SOURCE_COLOR,
  745. ENV_AMBIENT_SOURCE_SKY,
  746. };
  747. enum EnvironmentReflectionSource {
  748. ENV_REFLECTION_SOURCE_BG,
  749. ENV_REFLECTION_SOURCE_DISABLED,
  750. ENV_REFLECTION_SOURCE_SKY,
  751. };
  752. virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;
  753. virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
  754. virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
  755. virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
  756. virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
  757. virtual void environment_set_bg_energy(RID p_env, float p_energy) = 0;
  758. virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
  759. 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, const Color &p_ao_color = Color()) = 0;
  760. // FIXME: Disabled during Vulkan refactoring, should be ported.
  761. #if 0
  762. virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;
  763. #endif
  764. enum EnvironmentGlowBlendMode {
  765. ENV_GLOW_BLEND_MODE_ADDITIVE,
  766. ENV_GLOW_BLEND_MODE_SCREEN,
  767. ENV_GLOW_BLEND_MODE_SOFTLIGHT,
  768. ENV_GLOW_BLEND_MODE_REPLACE,
  769. ENV_GLOW_BLEND_MODE_MIX,
  770. };
  771. 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) = 0;
  772. virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
  773. virtual void environment_glow_set_use_high_quality(bool p_enable) = 0;
  774. enum EnvironmentToneMapper {
  775. ENV_TONE_MAPPER_LINEAR,
  776. ENV_TONE_MAPPER_REINHARD,
  777. ENV_TONE_MAPPER_FILMIC,
  778. ENV_TONE_MAPPER_ACES
  779. };
  780. virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white, bool p_auto_exposure, float p_min_luminance, float p_max_luminance, float p_auto_exp_speed, float p_auto_exp_grey) = 0;
  781. 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;
  782. 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;
  783. enum EnvironmentSSRRoughnessQuality {
  784. ENV_SSR_ROUGNESS_QUALITY_DISABLED,
  785. ENV_SSR_ROUGNESS_QUALITY_LOW,
  786. ENV_SSR_ROUGNESS_QUALITY_MEDIUM,
  787. ENV_SSR_ROUGNESS_QUALITY_HIGH,
  788. };
  789. virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;
  790. 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;
  791. enum EnvironmentSSAOQuality {
  792. ENV_SSAO_QUALITY_VERY_LOW,
  793. ENV_SSAO_QUALITY_LOW,
  794. ENV_SSAO_QUALITY_MEDIUM,
  795. ENV_SSAO_QUALITY_HIGH,
  796. ENV_SSAO_QUALITY_ULTRA,
  797. };
  798. 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;
  799. enum EnvironmentSDFGICascades {
  800. ENV_SDFGI_CASCADES_4,
  801. ENV_SDFGI_CASCADES_6,
  802. ENV_SDFGI_CASCADES_8,
  803. };
  804. enum EnvironmentSDFGIYScale {
  805. ENV_SDFGI_Y_SCALE_DISABLED,
  806. ENV_SDFGI_Y_SCALE_75_PERCENT,
  807. ENV_SDFGI_Y_SCALE_50_PERCENT
  808. };
  809. virtual void environment_set_sdfgi(RID p_env, bool p_enable, EnvironmentSDFGICascades 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;
  810. enum EnvironmentSDFGIRayCount {
  811. ENV_SDFGI_RAY_COUNT_4,
  812. ENV_SDFGI_RAY_COUNT_8,
  813. ENV_SDFGI_RAY_COUNT_16,
  814. ENV_SDFGI_RAY_COUNT_32,
  815. ENV_SDFGI_RAY_COUNT_64,
  816. ENV_SDFGI_RAY_COUNT_96,
  817. ENV_SDFGI_RAY_COUNT_128,
  818. ENV_SDFGI_RAY_COUNT_MAX,
  819. };
  820. virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;
  821. enum EnvironmentSDFGIFramesToConverge {
  822. ENV_SDFGI_CONVERGE_IN_5_FRAMES,
  823. ENV_SDFGI_CONVERGE_IN_10_FRAMES,
  824. ENV_SDFGI_CONVERGE_IN_15_FRAMES,
  825. ENV_SDFGI_CONVERGE_IN_20_FRAMES,
  826. ENV_SDFGI_CONVERGE_IN_25_FRAMES,
  827. ENV_SDFGI_CONVERGE_IN_30_FRAMES,
  828. ENV_SDFGI_CONVERGE_MAX
  829. };
  830. virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;
  831. enum EnvironmentSDFGIFramesToUpdateLight {
  832. ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,
  833. ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,
  834. ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,
  835. ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,
  836. ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,
  837. ENV_SDFGI_UPDATE_LIGHT_MAX,
  838. };
  839. virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;
  840. virtual void environment_set_fog(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective) = 0;
  841. virtual void environment_set_volumetric_fog(RID p_env, bool p_enable, float p_density, const Color &p_light, float p_light_energy, float p_length, float p_detail_spread, float p_gi_inject, bool p_temporal_reprojection, float p_temporal_reprojection_amount) = 0;
  842. virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
  843. virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
  844. virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
  845. virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
  846. enum SubSurfaceScatteringQuality {
  847. SUB_SURFACE_SCATTERING_QUALITY_DISABLED,
  848. SUB_SURFACE_SCATTERING_QUALITY_LOW,
  849. SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,
  850. SUB_SURFACE_SCATTERING_QUALITY_HIGH,
  851. };
  852. virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;
  853. virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
  854. /* CAMERA EFFECTS */
  855. virtual RID camera_effects_create() = 0;
  856. enum DOFBlurQuality {
  857. DOF_BLUR_QUALITY_VERY_LOW,
  858. DOF_BLUR_QUALITY_LOW,
  859. DOF_BLUR_QUALITY_MEDIUM,
  860. DOF_BLUR_QUALITY_HIGH,
  861. };
  862. virtual void camera_effects_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;
  863. enum DOFBokehShape {
  864. DOF_BOKEH_BOX,
  865. DOF_BOKEH_HEXAGON,
  866. DOF_BOKEH_CIRCLE
  867. };
  868. virtual void camera_effects_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;
  869. virtual void camera_effects_set_dof_blur(RID p_camera_effects, bool p_far_enable, float p_far_distance, float p_far_transition, bool p_near_enable, float p_near_distance, float p_near_transition, float p_amount) = 0;
  870. virtual void camera_effects_set_custom_exposure(RID p_camera_effects, bool p_enable, float p_exposure) = 0;
  871. enum ShadowQuality {
  872. SHADOW_QUALITY_HARD,
  873. SHADOW_QUALITY_SOFT_LOW,
  874. SHADOW_QUALITY_SOFT_MEDIUM,
  875. SHADOW_QUALITY_SOFT_HIGH,
  876. SHADOW_QUALITY_SOFT_ULTRA,
  877. SHADOW_QUALITY_MAX
  878. };
  879. virtual void shadows_quality_set(ShadowQuality p_quality) = 0;
  880. virtual void directional_shadow_quality_set(ShadowQuality p_quality) = 0;
  881. /* SCENARIO API */
  882. virtual RID scenario_create() = 0;
  883. enum ScenarioDebugMode {
  884. SCENARIO_DEBUG_DISABLED,
  885. SCENARIO_DEBUG_WIREFRAME,
  886. SCENARIO_DEBUG_OVERDRAW,
  887. SCENARIO_DEBUG_SHADELESS,
  888. };
  889. virtual void scenario_set_debug(RID p_scenario, ScenarioDebugMode p_debug_mode) = 0;
  890. virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;
  891. virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;
  892. virtual void scenario_set_camera_effects(RID p_scenario, RID p_camera_effects) = 0;
  893. /* INSTANCING API */
  894. enum InstanceType {
  895. INSTANCE_NONE,
  896. INSTANCE_MESH,
  897. INSTANCE_MULTIMESH,
  898. INSTANCE_IMMEDIATE,
  899. INSTANCE_PARTICLES,
  900. INSTANCE_PARTICLES_COLLISION,
  901. INSTANCE_LIGHT,
  902. INSTANCE_REFLECTION_PROBE,
  903. INSTANCE_DECAL,
  904. INSTANCE_GI_PROBE,
  905. INSTANCE_LIGHTMAP,
  906. INSTANCE_OCCLUDER,
  907. INSTANCE_MAX,
  908. INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_IMMEDIATE) | (1 << INSTANCE_PARTICLES)
  909. };
  910. virtual RID instance_create2(RID p_base, RID p_scenario);
  911. virtual RID instance_create() = 0;
  912. virtual void instance_set_base(RID p_instance, RID p_base) = 0;
  913. virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;
  914. virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;
  915. virtual void instance_set_transform(RID p_instance, const Transform &p_transform) = 0;
  916. virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;
  917. virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;
  918. virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;
  919. virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;
  920. virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;
  921. virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;
  922. virtual void instance_set_exterior(RID p_instance, bool p_enabled) = 0;
  923. virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;
  924. // don't use these in a game!
  925. virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;
  926. virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;
  927. virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;
  928. Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;
  929. Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;
  930. Array _instances_cull_convex_bind(const Array &p_convex, RID p_scenario = RID()) const;
  931. enum InstanceFlags {
  932. INSTANCE_FLAG_USE_BAKED_LIGHT,
  933. INSTANCE_FLAG_USE_DYNAMIC_GI,
  934. INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,
  935. INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,
  936. INSTANCE_FLAG_MAX
  937. };
  938. enum ShadowCastingSetting {
  939. SHADOW_CASTING_SETTING_OFF,
  940. SHADOW_CASTING_SETTING_ON,
  941. SHADOW_CASTING_SETTING_DOUBLE_SIDED,
  942. SHADOW_CASTING_SETTING_SHADOWS_ONLY,
  943. };
  944. virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;
  945. virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;
  946. virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;
  947. virtual void instance_geometry_set_draw_range(RID p_instance, float p_min, float p_max, float p_min_margin, float p_max_margin) = 0;
  948. virtual void instance_geometry_set_as_instance_lod(RID p_instance, RID p_as_lod_of_instance) = 0;
  949. virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;
  950. virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;
  951. virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;
  952. virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;
  953. virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;
  954. virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;
  955. /* Bake 3D objects */
  956. enum BakeChannels {
  957. BAKE_CHANNEL_ALBEDO_ALPHA,
  958. BAKE_CHANNEL_NORMAL,
  959. BAKE_CHANNEL_ORM,
  960. BAKE_CHANNEL_EMISSION
  961. };
  962. virtual TypedArray<Image> bake_render_uv2(RID p_base, const Vector<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
  963. /* CANVAS (2D) */
  964. virtual RID canvas_create() = 0;
  965. virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;
  966. virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;
  967. virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;
  968. virtual void canvas_set_disable_scale(bool p_disable) = 0;
  969. virtual RID canvas_texture_create() = 0;
  970. enum CanvasTextureChannel {
  971. CANVAS_TEXTURE_CHANNEL_DIFFUSE,
  972. CANVAS_TEXTURE_CHANNEL_NORMAL,
  973. CANVAS_TEXTURE_CHANNEL_SPECULAR,
  974. };
  975. virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;
  976. virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;
  977. //takes effect only for new draw commands
  978. virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;
  979. virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;
  980. virtual RID canvas_item_create() = 0;
  981. virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;
  982. virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;
  983. virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;
  984. virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;
  985. virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;
  986. virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;
  987. virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  988. virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;
  989. virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;
  990. virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;
  991. virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;
  992. virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;
  993. virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;
  994. enum NinePatchAxisMode {
  995. NINE_PATCH_STRETCH,
  996. NINE_PATCH_TILE,
  997. NINE_PATCH_TILE_FIT,
  998. };
  999. 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) = 0;
  1000. 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;
  1001. virtual void canvas_item_add_multiline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = 1.0) = 0;
  1002. virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color) = 0;
  1003. virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color) = 0;
  1004. 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;
  1005. 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;
  1006. 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;
  1007. virtual void canvas_item_add_primitive(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs, RID p_texture, float p_width = 1.0) = 0;
  1008. 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;
  1009. 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;
  1010. 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;
  1011. virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;
  1012. virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;
  1013. virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;
  1014. virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;
  1015. virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;
  1016. virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;
  1017. virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;
  1018. virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;
  1019. virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;
  1020. virtual void canvas_item_clear(RID p_item) = 0;
  1021. virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;
  1022. virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;
  1023. virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;
  1024. enum CanvasGroupMode {
  1025. CANVAS_GROUP_MODE_DISABLED,
  1026. CANVAS_GROUP_MODE_OPAQUE,
  1027. CANVAS_GROUP_MODE_TRANSPARENT,
  1028. };
  1029. 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;
  1030. virtual RID canvas_light_create() = 0;
  1031. enum CanvasLightMode {
  1032. CANVAS_LIGHT_MODE_POINT,
  1033. CANVAS_LIGHT_MODE_DIRECTIONAL,
  1034. };
  1035. virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;
  1036. virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;
  1037. virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;
  1038. virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;
  1039. virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;
  1040. virtual void canvas_light_set_height(RID p_light, float p_height) = 0;
  1041. virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;
  1042. virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;
  1043. virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;
  1044. virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;
  1045. virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;
  1046. virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;
  1047. virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;
  1048. virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;
  1049. virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;
  1050. enum CanvasLightBlendMode {
  1051. CANVAS_LIGHT_BLEND_MODE_ADD,
  1052. CANVAS_LIGHT_BLEND_MODE_SUB,
  1053. CANVAS_LIGHT_BLEND_MODE_MIX,
  1054. };
  1055. virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;
  1056. enum CanvasLightShadowFilter {
  1057. CANVAS_LIGHT_FILTER_NONE,
  1058. CANVAS_LIGHT_FILTER_PCF5,
  1059. CANVAS_LIGHT_FILTER_PCF13,
  1060. CANVAS_LIGHT_FILTER_MAX
  1061. };
  1062. virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;
  1063. virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;
  1064. virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;
  1065. virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;
  1066. virtual RID canvas_light_occluder_create() = 0;
  1067. virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;
  1068. virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;
  1069. virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;
  1070. virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;
  1071. virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;
  1072. virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;
  1073. virtual RID canvas_occluder_polygon_create() = 0;
  1074. virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;
  1075. enum CanvasOccluderPolygonCullMode {
  1076. CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,
  1077. CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,
  1078. CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,
  1079. };
  1080. virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;
  1081. virtual void canvas_set_shadow_texture_size(int p_size) = 0;
  1082. /* GLOBAL VARIABLES */
  1083. enum GlobalVariableType {
  1084. GLOBAL_VAR_TYPE_BOOL,
  1085. GLOBAL_VAR_TYPE_BVEC2,
  1086. GLOBAL_VAR_TYPE_BVEC3,
  1087. GLOBAL_VAR_TYPE_BVEC4,
  1088. GLOBAL_VAR_TYPE_INT,
  1089. GLOBAL_VAR_TYPE_IVEC2,
  1090. GLOBAL_VAR_TYPE_IVEC3,
  1091. GLOBAL_VAR_TYPE_IVEC4,
  1092. GLOBAL_VAR_TYPE_RECT2I,
  1093. GLOBAL_VAR_TYPE_UINT,
  1094. GLOBAL_VAR_TYPE_UVEC2,
  1095. GLOBAL_VAR_TYPE_UVEC3,
  1096. GLOBAL_VAR_TYPE_UVEC4,
  1097. GLOBAL_VAR_TYPE_FLOAT,
  1098. GLOBAL_VAR_TYPE_VEC2,
  1099. GLOBAL_VAR_TYPE_VEC3,
  1100. GLOBAL_VAR_TYPE_VEC4,
  1101. GLOBAL_VAR_TYPE_COLOR,
  1102. GLOBAL_VAR_TYPE_RECT2,
  1103. GLOBAL_VAR_TYPE_MAT2,
  1104. GLOBAL_VAR_TYPE_MAT3,
  1105. GLOBAL_VAR_TYPE_MAT4,
  1106. GLOBAL_VAR_TYPE_TRANSFORM_2D,
  1107. GLOBAL_VAR_TYPE_TRANSFORM,
  1108. GLOBAL_VAR_TYPE_SAMPLER2D,
  1109. GLOBAL_VAR_TYPE_SAMPLER2DARRAY,
  1110. GLOBAL_VAR_TYPE_SAMPLER3D,
  1111. GLOBAL_VAR_TYPE_SAMPLERCUBE,
  1112. GLOBAL_VAR_TYPE_MAX
  1113. };
  1114. virtual void global_variable_add(const StringName &p_name, GlobalVariableType p_type, const Variant &p_value) = 0;
  1115. virtual void global_variable_remove(const StringName &p_name) = 0;
  1116. virtual Vector<StringName> global_variable_get_list() const = 0;
  1117. virtual void global_variable_set(const StringName &p_name, const Variant &p_value) = 0;
  1118. virtual void global_variable_set_override(const StringName &p_name, const Variant &p_value) = 0;
  1119. virtual Variant global_variable_get(const StringName &p_name) const = 0;
  1120. virtual GlobalVariableType global_variable_get_type(const StringName &p_name) const = 0;
  1121. virtual void global_variables_load_settings(bool p_load_textures) = 0;
  1122. virtual void global_variables_clear() = 0;
  1123. static ShaderLanguage::DataType global_variable_type_get_shader_datatype(GlobalVariableType p_type);
  1124. /* BLACK BARS */
  1125. virtual void black_bars_set_margins(int p_left, int p_top, int p_right, int p_bottom) = 0;
  1126. virtual void black_bars_set_images(RID p_left, RID p_top, RID p_right, RID p_bottom) = 0;
  1127. /* FREE */
  1128. virtual void free(RID p_rid) = 0; ///< free RIDs associated with the visual server
  1129. virtual void request_frame_drawn_callback(Object *p_where, const StringName &p_method, const Variant &p_userdata) = 0;
  1130. /* EVENT QUEUING */
  1131. virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;
  1132. virtual void sync() = 0;
  1133. virtual bool has_changed() const = 0;
  1134. virtual void init() = 0;
  1135. virtual void finish() = 0;
  1136. /* STATUS INFORMATION */
  1137. enum RenderInfo {
  1138. INFO_OBJECTS_IN_FRAME,
  1139. INFO_VERTICES_IN_FRAME,
  1140. INFO_MATERIAL_CHANGES_IN_FRAME,
  1141. INFO_SHADER_CHANGES_IN_FRAME,
  1142. INFO_SURFACE_CHANGES_IN_FRAME,
  1143. INFO_DRAW_CALLS_IN_FRAME,
  1144. INFO_USAGE_VIDEO_MEM_TOTAL,
  1145. INFO_VIDEO_MEM_USED,
  1146. INFO_TEXTURE_MEM_USED,
  1147. INFO_VERTEX_MEM_USED,
  1148. };
  1149. virtual uint64_t get_render_info(RenderInfo p_info) = 0;
  1150. virtual String get_video_adapter_name() const = 0;
  1151. virtual String get_video_adapter_vendor() const = 0;
  1152. struct FrameProfileArea {
  1153. String name;
  1154. float gpu_msec;
  1155. float cpu_msec;
  1156. };
  1157. virtual void set_frame_profiling_enabled(bool p_enable) = 0;
  1158. virtual Vector<FrameProfileArea> get_frame_profile() = 0;
  1159. virtual uint64_t get_frame_profile_frame() = 0;
  1160. virtual float get_frame_setup_time_cpu() const = 0;
  1161. virtual void gi_set_use_half_resolution(bool p_enable) = 0;
  1162. /* TESTING */
  1163. virtual RID get_test_cube() = 0;
  1164. virtual RID get_test_texture();
  1165. virtual RID get_white_texture();
  1166. virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
  1167. virtual RID make_sphere_mesh(int p_lats, int p_lons, float p_radius);
  1168. virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);
  1169. virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);
  1170. virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;
  1171. virtual void set_default_clear_color(const Color &p_color) = 0;
  1172. enum Features {
  1173. FEATURE_SHADERS,
  1174. FEATURE_MULTITHREADED,
  1175. };
  1176. virtual bool has_feature(Features p_feature) const = 0;
  1177. virtual bool has_os_feature(const String &p_feature) const = 0;
  1178. virtual void set_debug_generate_wireframes(bool p_generate) = 0;
  1179. virtual void call_set_use_vsync(bool p_enable) = 0;
  1180. virtual bool is_low_end() const = 0;
  1181. virtual void set_print_gpu_profile(bool p_enable) = 0;
  1182. RenderingDevice *create_local_rendering_device() const;
  1183. bool is_render_loop_enabled() const;
  1184. void set_render_loop_enabled(bool p_enabled);
  1185. RenderingServer();
  1186. virtual ~RenderingServer();
  1187. };
  1188. // make variant understand the enums
  1189. VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);
  1190. VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);
  1191. VARIANT_ENUM_CAST(RenderingServer::ShaderMode);
  1192. VARIANT_ENUM_CAST(RenderingServer::ArrayType);
  1193. VARIANT_ENUM_CAST(RenderingServer::ArrayFormat);
  1194. VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);
  1195. VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);
  1196. VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);
  1197. VARIANT_ENUM_CAST(RenderingServer::LightType);
  1198. VARIANT_ENUM_CAST(RenderingServer::LightParam);
  1199. VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);
  1200. VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);
  1201. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);
  1202. VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowDepthRangeMode);
  1203. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);
  1204. VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);
  1205. VARIANT_ENUM_CAST(RenderingServer::DecalTexture);
  1206. VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);
  1207. VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);
  1208. VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);
  1209. VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);
  1210. VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);
  1211. VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);
  1212. VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);
  1213. VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);
  1214. VARIANT_ENUM_CAST(RenderingServer::SkyMode);
  1215. VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);
  1216. VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);
  1217. VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);
  1218. VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);
  1219. VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);
  1220. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);
  1221. VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);
  1222. VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);
  1223. VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);
  1224. VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);
  1225. VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);
  1226. VARIANT_ENUM_CAST(RenderingServer::ScenarioDebugMode);
  1227. VARIANT_ENUM_CAST(RenderingServer::InstanceType);
  1228. VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);
  1229. VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);
  1230. VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);
  1231. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);
  1232. VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);
  1233. VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);
  1234. VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);
  1235. VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);
  1236. VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);
  1237. VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);
  1238. VARIANT_ENUM_CAST(RenderingServer::GlobalVariableType);
  1239. VARIANT_ENUM_CAST(RenderingServer::RenderInfo);
  1240. VARIANT_ENUM_CAST(RenderingServer::Features);
  1241. // Alias to make it easier to use.
  1242. #define RS RenderingServer
  1243. #endif // RENDERING_SERVER_H