rendering_server.h 87 KB

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