rendering_server.h 63 KB

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