visual_server.h 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180
  1. /*************************************************************************/
  2. /* visual_server.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* http://www.godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2015 Juan Linietsky, Ariel Manzur. */
  9. /* */
  10. /* Permission is hereby granted, free of charge, to any person obtaining */
  11. /* a copy of this software and associated documentation files (the */
  12. /* "Software"), to deal in the Software without restriction, including */
  13. /* without limitation the rights to use, copy, modify, merge, publish, */
  14. /* distribute, sublicense, and/or sell copies of the Software, and to */
  15. /* permit persons to whom the Software is furnished to do so, subject to */
  16. /* the following conditions: */
  17. /* */
  18. /* The above copyright notice and this permission notice shall be */
  19. /* included in all copies or substantial portions of the Software. */
  20. /* */
  21. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  22. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  23. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  24. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  25. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  26. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  27. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  28. /*************************************************************************/
  29. #ifndef VISUAL_SERVER_H
  30. #define VISUAL_SERVER_H
  31. #include "rid.h"
  32. #include "variant.h"
  33. #include "math_2d.h"
  34. #include "bsp_tree.h"
  35. #include "geometry.h"
  36. #include "object.h"
  37. /**
  38. @author Juan Linietsky <reduzio@gmail.com>
  39. */
  40. class VisualServer : public Object {
  41. OBJ_TYPE( VisualServer, Object );
  42. static VisualServer *singleton;
  43. int mm_policy;
  44. DVector<String> _shader_get_param_list(RID p_shader) const;
  45. void _camera_set_orthogonal(RID p_camera,float p_size,float p_z_near,float p_z_far);
  46. void _viewport_set_rect(RID p_viewport,const Rect2& p_rect);
  47. Rect2 _viewport_get_rect(RID p_viewport) const;
  48. void _canvas_item_add_style_box(RID p_item, const Rect2& p_rect, RID p_texture,const Vector<float>& p_margins, const Color& p_modulate=Color(1,1,1));
  49. protected:
  50. RID _make_test_cube();
  51. void _free_internal_rids();
  52. RID test_texture;
  53. RID white_texture;
  54. RID test_material;
  55. RID material_2d[16];
  56. static VisualServer* (*create_func)();
  57. static void _bind_methods();
  58. public:
  59. static VisualServer *get_singleton();
  60. static VisualServer *create();
  61. enum MipMapPolicy {
  62. MIPMAPS_ENABLED,
  63. MIPMAPS_ENABLED_FOR_PO2,
  64. MIPMAPS_DISABLED
  65. };
  66. virtual void set_mipmap_policy(MipMapPolicy p_policy);
  67. virtual MipMapPolicy get_mipmap_policy() const;
  68. enum {
  69. NO_INDEX_ARRAY=-1,
  70. CUSTOM_ARRAY_SIZE=8,
  71. ARRAY_WEIGHTS_SIZE=4,
  72. MAX_PARTICLE_COLOR_PHASES=4,
  73. MAX_PARTICLE_ATTRACTORS=4,
  74. CANVAS_ITEM_Z_MIN=-4096,
  75. CANVAS_ITEM_Z_MAX=4096,
  76. MAX_CURSORS = 8,
  77. };
  78. /* TEXTURE API */
  79. enum TextureFlags {
  80. TEXTURE_FLAG_MIPMAPS=1, /// Enable automatic mipmap generation - when available
  81. TEXTURE_FLAG_REPEAT=2, /// Repeat texture (Tiling), otherwise Clamping
  82. TEXTURE_FLAG_FILTER=4, /// Create texure with linear (or available) filter
  83. TEXTURE_FLAG_ANISOTROPIC_FILTER=8,
  84. TEXTURE_FLAG_CONVERT_TO_LINEAR=16,
  85. TEXTURE_FLAG_CUBEMAP=2048,
  86. TEXTURE_FLAG_VIDEO_SURFACE=4096,
  87. TEXTURE_FLAGS_DEFAULT=TEXTURE_FLAG_REPEAT|TEXTURE_FLAG_MIPMAPS|TEXTURE_FLAG_FILTER
  88. };
  89. enum CubeMapSide {
  90. CUBEMAP_LEFT,
  91. CUBEMAP_RIGHT,
  92. CUBEMAP_BOTTOM,
  93. CUBEMAP_TOP,
  94. CUBEMAP_FRONT,
  95. CUBEMAP_BACK
  96. };
  97. virtual RID texture_create()=0;
  98. RID texture_create_from_image(const Image& p_image,uint32_t p_flags=TEXTURE_FLAGS_DEFAULT); // helper
  99. virtual void texture_allocate(RID p_texture,int p_width, int p_height,Image::Format p_format,uint32_t p_flags=TEXTURE_FLAGS_DEFAULT)=0;
  100. virtual void texture_set_data(RID p_texture,const Image& p_image,CubeMapSide p_cube_side=CUBEMAP_LEFT)=0;
  101. virtual Image texture_get_data(RID p_texture,CubeMapSide p_cube_side=CUBEMAP_LEFT) const=0;
  102. virtual void texture_set_flags(RID p_texture,uint32_t p_flags) =0;
  103. virtual uint32_t texture_get_flags(RID p_texture) const=0;
  104. virtual Image::Format texture_get_format(RID p_texture) const=0;
  105. virtual uint32_t texture_get_width(RID p_texture) const=0;
  106. virtual uint32_t texture_get_height(RID p_texture) const=0;
  107. virtual void texture_set_size_override(RID p_texture,int p_width, int p_height)=0;
  108. virtual bool texture_can_stream(RID p_texture) const=0;
  109. virtual void texture_set_reload_hook(RID p_texture,ObjectID p_owner,const StringName& p_function) const=0;
  110. /* SHADER API */
  111. enum ShaderMode {
  112. SHADER_MATERIAL,
  113. SHADER_CANVAS_ITEM,
  114. SHADER_POST_PROCESS,
  115. };
  116. virtual RID shader_create(ShaderMode p_mode=SHADER_MATERIAL)=0;
  117. virtual void shader_set_mode(RID p_shader,ShaderMode p_mode)=0;
  118. virtual ShaderMode shader_get_mode(RID p_shader) const=0;
  119. virtual void shader_set_code(RID p_shader, const String& p_vertex, const String& p_fragment,const String& p_light, int p_vertex_ofs=0,int p_fragment_ofs=0,int p_light_ofs=0)=0;
  120. virtual String shader_get_fragment_code(RID p_shader) const=0;
  121. virtual String shader_get_vertex_code(RID p_shader) const=0;
  122. virtual String shader_get_light_code(RID p_shader) const=0;
  123. virtual void shader_get_param_list(RID p_shader, List<PropertyInfo> *p_param_list) const=0;
  124. virtual void shader_set_default_texture_param(RID p_shader, const StringName& p_name, RID p_texture)=0;
  125. virtual RID shader_get_default_texture_param(RID p_shader, const StringName& p_name) const=0;
  126. /* COMMON MATERIAL API */
  127. virtual RID material_create()=0;
  128. virtual void material_set_shader(RID p_shader_material, RID p_shader)=0;
  129. virtual RID material_get_shader(RID p_shader_material) const=0;
  130. virtual void material_set_param(RID p_material, const StringName& p_param, const Variant& p_value)=0;
  131. virtual Variant material_get_param(RID p_material, const StringName& p_param) const=0;
  132. enum MaterialFlag {
  133. MATERIAL_FLAG_VISIBLE,
  134. MATERIAL_FLAG_DOUBLE_SIDED,
  135. MATERIAL_FLAG_INVERT_FACES, ///< Invert front/back of the object
  136. MATERIAL_FLAG_UNSHADED,
  137. MATERIAL_FLAG_ONTOP,
  138. MATERIAL_FLAG_LIGHTMAP_ON_UV2,
  139. MATERIAL_FLAG_COLOR_ARRAY_SRGB,
  140. MATERIAL_FLAG_MAX,
  141. };
  142. virtual void material_set_flag(RID p_material, MaterialFlag p_flag,bool p_enabled)=0;
  143. virtual bool material_get_flag(RID p_material,MaterialFlag p_flag) const=0;
  144. enum MaterialDepthDrawMode {
  145. MATERIAL_DEPTH_DRAW_ALWAYS,
  146. MATERIAL_DEPTH_DRAW_OPAQUE_ONLY,
  147. MATERIAL_DEPTH_DRAW_OPAQUE_PRE_PASS_ALPHA,
  148. MATERIAL_DEPTH_DRAW_NEVER
  149. };
  150. virtual void material_set_depth_draw_mode(RID p_material, MaterialDepthDrawMode p_mode)=0;
  151. virtual MaterialDepthDrawMode material_get_depth_draw_mode(RID p_material) const=0;
  152. enum MaterialBlendMode {
  153. MATERIAL_BLEND_MODE_MIX, //default
  154. MATERIAL_BLEND_MODE_ADD,
  155. MATERIAL_BLEND_MODE_SUB,
  156. MATERIAL_BLEND_MODE_MUL,
  157. MATERIAL_BLEND_MODE_PREMULT_ALPHA
  158. };
  159. virtual void material_set_blend_mode(RID p_material,MaterialBlendMode p_mode)=0;
  160. virtual MaterialBlendMode material_get_blend_mode(RID p_material) const=0;
  161. virtual void material_set_line_width(RID p_material,float p_line_width)=0;
  162. virtual float material_get_line_width(RID p_material) const=0;
  163. //fixed material api
  164. virtual RID fixed_material_create()=0;
  165. enum FixedMaterialParam {
  166. FIXED_MATERIAL_PARAM_DIFFUSE,
  167. FIXED_MATERIAL_PARAM_DETAIL,
  168. FIXED_MATERIAL_PARAM_SPECULAR,
  169. FIXED_MATERIAL_PARAM_EMISSION,
  170. FIXED_MATERIAL_PARAM_SPECULAR_EXP,
  171. FIXED_MATERIAL_PARAM_GLOW,
  172. FIXED_MATERIAL_PARAM_NORMAL,
  173. FIXED_MATERIAL_PARAM_SHADE_PARAM,
  174. FIXED_MATERIAL_PARAM_MAX
  175. };
  176. enum FixedMaterialTexCoordMode {
  177. FIXED_MATERIAL_TEXCOORD_UV,
  178. FIXED_MATERIAL_TEXCOORD_UV_TRANSFORM,
  179. FIXED_MATERIAL_TEXCOORD_UV2,
  180. FIXED_MATERIAL_TEXCOORD_SPHERE
  181. };
  182. enum FixedMaterialFlags {
  183. FIXED_MATERIAL_FLAG_USE_ALPHA,
  184. FIXED_MATERIAL_FLAG_USE_COLOR_ARRAY,
  185. FIXED_MATERIAL_FLAG_USE_POINT_SIZE,
  186. FIXED_MATERIAL_FLAG_DISCARD_ALPHA,
  187. FIXED_MATERIAL_FLAG_USE_XY_NORMALMAP,
  188. FIXED_MATERIAL_FLAG_MAX,
  189. };
  190. virtual void fixed_material_set_flag(RID p_material, FixedMaterialFlags p_flag, bool p_enabled)=0;
  191. virtual bool fixed_material_get_flag(RID p_material, FixedMaterialFlags p_flag) const=0;
  192. virtual void fixed_material_set_param(RID p_material, FixedMaterialParam p_parameter, const Variant& p_value)=0;
  193. virtual Variant fixed_material_get_param(RID p_material,FixedMaterialParam p_parameter) const=0;
  194. virtual void fixed_material_set_texture(RID p_material,FixedMaterialParam p_parameter, RID p_texture)=0;
  195. virtual RID fixed_material_get_texture(RID p_material,FixedMaterialParam p_parameter) const=0;
  196. enum FixedMaterialLightShader {
  197. FIXED_MATERIAL_LIGHT_SHADER_LAMBERT,
  198. FIXED_MATERIAL_LIGHT_SHADER_WRAP,
  199. FIXED_MATERIAL_LIGHT_SHADER_VELVET,
  200. FIXED_MATERIAL_LIGHT_SHADER_TOON,
  201. };
  202. virtual void fixed_material_set_light_shader(RID p_material,FixedMaterialLightShader p_shader)=0;
  203. virtual FixedMaterialLightShader fixed_material_get_light_shader(RID p_material) const=0;
  204. virtual void fixed_material_set_texcoord_mode(RID p_material,FixedMaterialParam p_parameter, FixedMaterialTexCoordMode p_mode)=0;
  205. virtual FixedMaterialTexCoordMode fixed_material_get_texcoord_mode(RID p_material,FixedMaterialParam p_parameter) const=0;
  206. virtual void fixed_material_set_uv_transform(RID p_material,const Transform& p_transform)=0;
  207. virtual Transform fixed_material_get_uv_transform(RID p_material) const=0;
  208. virtual void fixed_material_set_point_size(RID p_material,float p_size)=0;
  209. virtual float fixed_material_get_point_size(RID p_material) const=0;
  210. /* MESH API */
  211. enum ArrayType {
  212. ARRAY_VERTEX=0,
  213. ARRAY_NORMAL=1,
  214. ARRAY_TANGENT=2,
  215. ARRAY_COLOR=3,
  216. ARRAY_TEX_UV=4,
  217. ARRAY_TEX_UV2=5,
  218. ARRAY_BONES=6,
  219. ARRAY_WEIGHTS=7,
  220. ARRAY_INDEX=8,
  221. ARRAY_MAX=9
  222. };
  223. enum ArrayFormat {
  224. /* ARRAY FORMAT FLAGS */
  225. ARRAY_FORMAT_VERTEX=1<<ARRAY_VERTEX, // mandatory
  226. ARRAY_FORMAT_NORMAL=1<<ARRAY_NORMAL,
  227. ARRAY_FORMAT_TANGENT=1<<ARRAY_TANGENT,
  228. ARRAY_FORMAT_COLOR=1<<ARRAY_COLOR,
  229. ARRAY_FORMAT_TEX_UV=1<<ARRAY_TEX_UV,
  230. ARRAY_FORMAT_TEX_UV2=1<<ARRAY_TEX_UV2,
  231. ARRAY_FORMAT_BONES=1<<ARRAY_BONES,
  232. ARRAY_FORMAT_WEIGHTS=1<<ARRAY_WEIGHTS,
  233. ARRAY_FORMAT_INDEX=1<<ARRAY_INDEX,
  234. };
  235. enum PrimitiveType {
  236. PRIMITIVE_POINTS=0,
  237. PRIMITIVE_LINES=1,
  238. PRIMITIVE_LINE_STRIP=2,
  239. PRIMITIVE_LINE_LOOP=3,
  240. PRIMITIVE_TRIANGLES=4,
  241. PRIMITIVE_TRIANGLE_STRIP=5,
  242. PRIMITIVE_TRIANGLE_FAN=6,
  243. PRIMITIVE_MAX=7,
  244. };
  245. virtual RID mesh_create()=0;
  246. virtual void mesh_add_surface(RID p_mesh,PrimitiveType p_primitive,const Array& p_arrays,const Array& p_blend_shapes=Array(),bool p_alpha_sort=false)=0;
  247. virtual Array mesh_get_surface_arrays(RID p_mesh,int p_surface) const=0;
  248. virtual Array mesh_get_surface_morph_arrays(RID p_mesh,int p_surface) const=0;
  249. virtual void mesh_add_custom_surface(RID p_mesh,const Variant& p_dat)=0; //this is used by each platform in a different way
  250. virtual void mesh_set_morph_target_count(RID p_mesh,int p_amount)=0;
  251. virtual int mesh_get_morph_target_count(RID p_mesh) const=0;
  252. enum MorphTargetMode {
  253. MORPH_MODE_NORMALIZED,
  254. MORPH_MODE_RELATIVE,
  255. };
  256. virtual void mesh_set_morph_target_mode(RID p_mesh,MorphTargetMode p_mode)=0;
  257. virtual MorphTargetMode mesh_get_morph_target_mode(RID p_mesh) const=0;
  258. virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material,bool p_owned=false)=0;
  259. virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const=0;
  260. virtual int mesh_surface_get_array_len(RID p_mesh, int p_surface) const=0;
  261. virtual int mesh_surface_get_array_index_len(RID p_mesh, int p_surface) const=0;
  262. virtual uint32_t mesh_surface_get_format(RID p_mesh, int p_surface) const=0;
  263. virtual PrimitiveType mesh_surface_get_primitive_type(RID p_mesh, int p_surface) const=0;
  264. virtual void mesh_remove_surface(RID p_mesh,int p_index)=0;
  265. virtual int mesh_get_surface_count(RID p_mesh) const=0;
  266. virtual void mesh_set_custom_aabb(RID p_mesh,const AABB& p_aabb)=0;
  267. virtual AABB mesh_get_custom_aabb(RID p_mesh) const=0;
  268. /* MULTIMESH API */
  269. virtual RID multimesh_create()=0;
  270. virtual void multimesh_set_instance_count(RID p_multimesh,int p_count)=0;
  271. virtual int multimesh_get_instance_count(RID p_multimesh) const=0;
  272. virtual void multimesh_set_mesh(RID p_multimesh,RID p_mesh)=0;
  273. virtual void multimesh_set_aabb(RID p_multimesh,const AABB& p_aabb)=0;
  274. virtual void multimesh_instance_set_transform(RID p_multimesh,int p_index,const Transform& p_transform)=0;
  275. virtual void multimesh_instance_set_color(RID p_multimesh,int p_index,const Color& p_color)=0;
  276. virtual RID multimesh_get_mesh(RID p_multimesh) const=0;
  277. virtual AABB multimesh_get_aabb(RID p_multimesh,const AABB& p_aabb) const=0;;
  278. virtual Transform multimesh_instance_get_transform(RID p_multimesh,int p_index) const=0;
  279. virtual Color multimesh_instance_get_color(RID p_multimesh,int p_index) const=0;
  280. virtual void multimesh_set_visible_instances(RID p_multimesh,int p_visible)=0;
  281. virtual int multimesh_get_visible_instances(RID p_multimesh) const=0;
  282. /* IMMEDIATE API */
  283. virtual RID immediate_create()=0;
  284. virtual void immediate_begin(RID p_immediate,PrimitiveType p_rimitive,RID p_texture=RID())=0;
  285. virtual void immediate_vertex(RID p_immediate,const Vector3& p_vertex)=0;
  286. virtual void immediate_normal(RID p_immediate,const Vector3& p_normal)=0;
  287. virtual void immediate_tangent(RID p_immediate,const Plane& p_tangent)=0;
  288. virtual void immediate_color(RID p_immediate,const Color& p_color)=0;
  289. virtual void immediate_uv(RID p_immediate,const Vector2& tex_uv)=0;
  290. virtual void immediate_uv2(RID p_immediate,const Vector2& tex_uv)=0;
  291. virtual void immediate_end(RID p_immediate)=0;
  292. virtual void immediate_clear(RID p_immediate)=0;
  293. virtual void immediate_set_material(RID p_immediate,RID p_material)=0;
  294. virtual RID immediate_get_material(RID p_immediate) const=0;
  295. /* PARTICLES API */
  296. virtual RID particles_create()=0;
  297. enum ParticleVariable {
  298. PARTICLE_LIFETIME,
  299. PARTICLE_SPREAD,
  300. PARTICLE_GRAVITY,
  301. PARTICLE_LINEAR_VELOCITY,
  302. PARTICLE_ANGULAR_VELOCITY,
  303. PARTICLE_LINEAR_ACCELERATION,
  304. PARTICLE_RADIAL_ACCELERATION,
  305. PARTICLE_TANGENTIAL_ACCELERATION,
  306. PARTICLE_DAMPING,
  307. PARTICLE_INITIAL_SIZE,
  308. PARTICLE_FINAL_SIZE,
  309. PARTICLE_INITIAL_ANGLE,
  310. PARTICLE_HEIGHT,
  311. PARTICLE_HEIGHT_SPEED_SCALE,
  312. PARTICLE_VAR_MAX
  313. };
  314. virtual void particles_set_amount(RID p_particles, int p_amount)=0;
  315. virtual int particles_get_amount(RID p_particles) const=0;
  316. virtual void particles_set_emitting(RID p_particles, bool p_emitting)=0;
  317. virtual bool particles_is_emitting(RID p_particles) const=0;
  318. virtual void particles_set_visibility_aabb(RID p_particles, const AABB& p_visibility)=0;
  319. virtual AABB particles_get_visibility_aabb(RID p_particles) const=0;
  320. virtual void particles_set_emission_half_extents(RID p_particles, const Vector3& p_half_extents)=0;
  321. virtual Vector3 particles_get_emission_half_extents(RID p_particles) const=0;
  322. virtual void particles_set_emission_base_velocity(RID p_particles, const Vector3& p_base_velocity)=0;
  323. virtual Vector3 particles_get_emission_base_velocity(RID p_particles) const=0;
  324. virtual void particles_set_emission_points(RID p_particles, const DVector<Vector3>& p_points)=0;
  325. virtual DVector<Vector3> particles_get_emission_points(RID p_particles) const=0;
  326. virtual void particles_set_gravity_normal(RID p_particles, const Vector3& p_normal)=0;
  327. virtual Vector3 particles_get_gravity_normal(RID p_particles) const=0;
  328. virtual void particles_set_variable(RID p_particles, ParticleVariable p_variable,float p_value)=0;
  329. virtual float particles_get_variable(RID p_particles, ParticleVariable p_variable) const=0;
  330. virtual void particles_set_randomness(RID p_particles, ParticleVariable p_variable,float p_randomness)=0;
  331. virtual float particles_get_randomness(RID p_particles, ParticleVariable p_variable) const=0;
  332. virtual void particles_set_color_phases(RID p_particles, int p_phases)=0;
  333. virtual int particles_get_color_phases(RID p_particles) const=0;
  334. virtual void particles_set_color_phase_pos(RID p_particles, int p_phase, float p_pos)=0;
  335. virtual float particles_get_color_phase_pos(RID p_particles, int p_phase) const=0;
  336. virtual void particles_set_color_phase_color(RID p_particles, int p_phase, const Color& p_color)=0;
  337. virtual Color particles_get_color_phase_color(RID p_particles, int p_phase) const=0;
  338. virtual void particles_set_attractors(RID p_particles, int p_attractors)=0;
  339. virtual int particles_get_attractors(RID p_particles) const=0;
  340. virtual void particles_set_attractor_pos(RID p_particles, int p_attractor, const Vector3& p_pos)=0;
  341. virtual Vector3 particles_get_attractor_pos(RID p_particles,int p_attractor) const=0;
  342. virtual void particles_set_attractor_strength(RID p_particles, int p_attractor, float p_force)=0;
  343. virtual float particles_get_attractor_strength(RID p_particles,int p_attractor) const=0;
  344. virtual void particles_set_material(RID p_particles, RID p_material,bool p_owned=false)=0;
  345. virtual RID particles_get_material(RID p_particles) const=0;
  346. virtual void particles_set_height_from_velocity(RID p_particles, bool p_enable)=0;
  347. virtual bool particles_has_height_from_velocity(RID p_particles) const=0;
  348. virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable)=0;
  349. virtual bool particles_is_using_local_coordinates(RID p_particles) const=0;
  350. /* Light API */
  351. enum LightType {
  352. LIGHT_DIRECTIONAL,
  353. LIGHT_OMNI,
  354. LIGHT_SPOT
  355. };
  356. enum LightColor {
  357. LIGHT_COLOR_DIFFUSE,
  358. LIGHT_COLOR_SPECULAR
  359. };
  360. enum LightParam {
  361. LIGHT_PARAM_SPOT_ATTENUATION,
  362. LIGHT_PARAM_SPOT_ANGLE,
  363. LIGHT_PARAM_RADIUS,
  364. LIGHT_PARAM_ENERGY,
  365. LIGHT_PARAM_ATTENUATION,
  366. LIGHT_PARAM_SHADOW_DARKENING,
  367. LIGHT_PARAM_SHADOW_Z_OFFSET,
  368. LIGHT_PARAM_SHADOW_Z_SLOPE_SCALE,
  369. LIGHT_PARAM_SHADOW_ESM_MULTIPLIER,
  370. LIGHT_PARAM_SHADOW_BLUR_PASSES,
  371. LIGHT_PARAM_MAX
  372. };
  373. virtual RID light_create(LightType p_type)=0;
  374. virtual LightType light_get_type(RID p_light) const=0;
  375. virtual void light_set_color(RID p_light,LightColor p_type, const Color& p_color)=0;
  376. virtual Color light_get_color(RID p_light,LightColor p_type) const=0;
  377. virtual void light_set_shadow(RID p_light,bool p_enabled)=0;
  378. virtual bool light_has_shadow(RID p_light) const=0;
  379. virtual void light_set_volumetric(RID p_light,bool p_enabled)=0;
  380. virtual bool light_is_volumetric(RID p_light) const=0;
  381. virtual void light_set_projector(RID p_light,RID p_texture)=0;
  382. virtual RID light_get_projector(RID p_light) const=0;
  383. virtual void light_set_param(RID p_light, LightParam p_var, float p_value)=0;
  384. virtual float light_get_param(RID p_light, LightParam p_var) const=0;
  385. enum LightOp {
  386. LIGHT_OPERATOR_ADD,
  387. LIGHT_OPERATOR_SUB
  388. };
  389. virtual void light_set_operator(RID p_light,LightOp p_op)=0;
  390. virtual LightOp light_get_operator(RID p_light) const=0;
  391. // omni light
  392. enum LightOmniShadowMode {
  393. LIGHT_OMNI_SHADOW_DEFAULT,
  394. LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,
  395. LIGHT_OMNI_SHADOW_CUBEMAP
  396. };
  397. virtual void light_omni_set_shadow_mode(RID p_light,LightOmniShadowMode p_mode)=0;
  398. virtual LightOmniShadowMode light_omni_get_shadow_mode(RID p_light) const=0;
  399. // directional light
  400. enum LightDirectionalShadowMode {
  401. LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,
  402. LIGHT_DIRECTIONAL_SHADOW_PERSPECTIVE,
  403. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,
  404. LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS
  405. };
  406. virtual void light_directional_set_shadow_mode(RID p_light,LightDirectionalShadowMode p_mode)=0;
  407. virtual LightDirectionalShadowMode light_directional_get_shadow_mode(RID p_light) const=0;
  408. enum LightDirectionalShadowParam {
  409. LIGHT_DIRECTIONAL_SHADOW_PARAM_MAX_DISTANCE,
  410. LIGHT_DIRECTIONAL_SHADOW_PARAM_PSSM_SPLIT_WEIGHT,
  411. LIGHT_DIRECTIONAL_SHADOW_PARAM_PSSM_ZOFFSET_SCALE,
  412. };
  413. virtual void light_directional_set_shadow_param(RID p_light,LightDirectionalShadowParam p_param, float p_value)=0;
  414. virtual float light_directional_get_shadow_param(RID p_light,LightDirectionalShadowParam p_param) const=0;
  415. //@TODO fallof model and all that stuff
  416. /* SKELETON API */
  417. virtual RID skeleton_create()=0;
  418. virtual void skeleton_resize(RID p_skeleton,int p_bones)=0;
  419. virtual int skeleton_get_bone_count(RID p_skeleton) const=0;
  420. virtual void skeleton_bone_set_transform(RID p_skeleton,int p_bone, const Transform& p_transform)=0;
  421. virtual Transform skeleton_bone_get_transform(RID p_skeleton,int p_bone)=0;
  422. /* ROOM API */
  423. virtual RID room_create()=0;
  424. virtual void room_set_bounds(RID p_room, const BSP_Tree& p_bounds)=0;
  425. virtual BSP_Tree room_get_bounds(RID p_room) const=0;
  426. /* PORTAL API */
  427. // portals are only (x/y) points, forming a convex shape, which its clockwise
  428. // order points outside. (z is 0);
  429. virtual RID portal_create()=0;
  430. virtual void portal_set_shape(RID p_portal, const Vector<Point2>& p_shape)=0;
  431. virtual Vector<Point2> portal_get_shape(RID p_portal) const=0;
  432. virtual void portal_set_enabled(RID p_portal, bool p_enabled)=0;
  433. virtual bool portal_is_enabled(RID p_portal) const=0;
  434. virtual void portal_set_disable_distance(RID p_portal, float p_distance)=0;
  435. virtual float portal_get_disable_distance(RID p_portal) const=0;
  436. virtual void portal_set_disabled_color(RID p_portal, const Color& p_color)=0;
  437. virtual Color portal_get_disabled_color(RID p_portal) const=0;
  438. virtual void portal_set_connect_range(RID p_portal, float p_range) =0;
  439. virtual float portal_get_connect_range(RID p_portal) const =0;
  440. /* BAKED LIGHT API */
  441. virtual RID baked_light_create()=0;
  442. enum BakedLightMode {
  443. BAKED_LIGHT_OCTREE,
  444. BAKED_LIGHT_LIGHTMAPS
  445. };
  446. virtual void baked_light_set_mode(RID p_baked_light,BakedLightMode p_mode)=0;
  447. virtual BakedLightMode baked_light_get_mode(RID p_baked_light) const=0;
  448. virtual void baked_light_set_octree(RID p_baked_light,const DVector<uint8_t> p_octree)=0;
  449. virtual DVector<uint8_t> baked_light_get_octree(RID p_baked_light) const=0;
  450. virtual void baked_light_set_light(RID p_baked_light,const DVector<uint8_t> p_light)=0;
  451. virtual DVector<uint8_t> baked_light_get_light(RID p_baked_light) const=0;
  452. virtual void baked_light_set_sampler_octree(RID p_baked_light,const DVector<int> &p_sampler)=0;
  453. virtual DVector<int> baked_light_get_sampler_octree(RID p_baked_light) const=0;
  454. virtual void baked_light_set_lightmap_multiplier(RID p_baked_light,float p_multiplier)=0;
  455. virtual float baked_light_get_lightmap_multiplier(RID p_baked_light) const=0;
  456. virtual void baked_light_add_lightmap(RID p_baked_light,const RID p_texture,int p_id)=0;
  457. virtual void baked_light_clear_lightmaps(RID p_baked_light)=0;
  458. /* BAKED LIGHT SAMPLER */
  459. virtual RID baked_light_sampler_create()=0;
  460. enum BakedLightSamplerParam {
  461. BAKED_LIGHT_SAMPLER_RADIUS,
  462. BAKED_LIGHT_SAMPLER_STRENGTH,
  463. BAKED_LIGHT_SAMPLER_ATTENUATION,
  464. BAKED_LIGHT_SAMPLER_DETAIL_RATIO,
  465. BAKED_LIGHT_SAMPLER_MAX
  466. };
  467. virtual void baked_light_sampler_set_param(RID p_baked_light_sampler,BakedLightSamplerParam p_param,float p_value)=0;
  468. virtual float baked_light_sampler_get_param(RID p_baked_light_sampler,BakedLightSamplerParam p_param) const=0;
  469. virtual void baked_light_sampler_set_resolution(RID p_baked_light_sampler,int p_resolution)=0;
  470. virtual int baked_light_sampler_get_resolution(RID p_baked_light_sampler) const=0;
  471. /* CAMERA API */
  472. virtual RID camera_create()=0;
  473. virtual void camera_set_perspective(RID p_camera,float p_fovy_degrees, float p_z_near, float p_z_far)=0;
  474. virtual void camera_set_orthogonal(RID p_camera,float p_size, float p_z_near, float p_z_far)=0;
  475. virtual void camera_set_transform(RID p_camera,const Transform& p_transform)=0;
  476. virtual void camera_set_visible_layers(RID p_camera,uint32_t p_layers)=0;
  477. virtual uint32_t camera_get_visible_layers(RID p_camera) const=0;
  478. virtual void camera_set_environment(RID p_camera,RID p_env)=0;
  479. virtual RID camera_get_environment(RID p_camera) const=0;
  480. virtual void camera_set_use_vertical_aspect(RID p_camera,bool p_enable)=0;
  481. virtual bool camera_is_using_vertical_aspect(RID p_camera,bool p_enable) const=0;
  482. /*
  483. virtual void camera_add_layer(RID p_camera);
  484. virtual void camera_layer_move_up(RID p_camera,int p_layer);
  485. virtual void camera_layer_move_down(RID p_camera,int p_layer);
  486. virtual void camera_layer_set_mask(RID p_camera,int p_layer,int p_mask);
  487. virtual int camera_layer_get_mask(RID p_camera,int p_layer) const;
  488. enum CameraLayerFlag {
  489. FLAG_CLEAR_DEPTH,
  490. FLAG_CLEAR_COLOR,
  491. FLAG_IGNORE_FOG,
  492. };
  493. virtual void camera_layer_set_flag(RID p_camera,int p_layer,bool p_enable);
  494. virtual bool camera_layer_get_flag(RID p_camera,int p_layer) const;
  495. */
  496. /* VIEWPORT API */
  497. virtual RID viewport_create()=0;
  498. virtual void viewport_attach_to_screen(RID p_viewport,int p_screen=0)=0;
  499. virtual void viewport_detach(RID p_viewport)=0;
  500. virtual void viewport_set_render_target_to_screen_rect(RID p_viewport,const Rect2& p_rect)=0;
  501. enum RenderTargetUpdateMode {
  502. RENDER_TARGET_UPDATE_DISABLED,
  503. RENDER_TARGET_UPDATE_ONCE, //then goes to disabled
  504. RENDER_TARGET_UPDATE_WHEN_VISIBLE, // default
  505. RENDER_TARGET_UPDATE_ALWAYS
  506. };
  507. virtual void viewport_set_as_render_target(RID p_viewport,bool p_enable)=0;
  508. virtual void viewport_set_render_target_update_mode(RID p_viewport,RenderTargetUpdateMode p_mode)=0;
  509. virtual RenderTargetUpdateMode viewport_get_render_target_update_mode(RID p_viewport) const=0;
  510. virtual RID viewport_get_render_target_texture(RID p_viewport) const=0;
  511. virtual void viewport_set_render_target_vflip(RID p_viewport,bool p_enable)=0;
  512. virtual bool viewport_get_render_target_vflip(RID p_viewport) const=0;
  513. virtual void viewport_set_render_target_clear_on_new_frame(RID p_viewport,bool p_enable)=0;
  514. virtual bool viewport_get_render_target_clear_on_new_frame(RID p_viewport) const=0;
  515. virtual void viewport_render_target_clear(RID p_viewport)=0;
  516. virtual void viewport_queue_screen_capture(RID p_viewport)=0;
  517. virtual Image viewport_get_screen_capture(RID p_viewport) const=0;
  518. struct ViewportRect {
  519. int x,y,width,height;
  520. ViewportRect() { x=y=width=height=0; }
  521. };
  522. virtual void viewport_set_rect(RID p_viewport,const ViewportRect& p_rect)=0;
  523. virtual ViewportRect viewport_get_rect(RID p_viewport) const=0;
  524. virtual void viewport_set_hide_scenario(RID p_viewport,bool p_hide)=0;
  525. virtual void viewport_set_hide_canvas(RID p_viewport,bool p_hide)=0;
  526. virtual void viewport_set_disable_environment(RID p_viewport,bool p_disable)=0;
  527. virtual void viewport_attach_camera(RID p_viewport,RID p_camera)=0;
  528. virtual void viewport_set_scenario(RID p_viewport,RID p_scenario)=0;
  529. virtual RID viewport_get_attached_camera(RID p_viewport) const=0;
  530. virtual RID viewport_get_scenario(RID p_viewport) const=0;
  531. virtual void viewport_attach_canvas(RID p_viewport,RID p_canvas)=0;
  532. virtual void viewport_remove_canvas(RID p_viewport,RID p_canvas)=0;
  533. virtual void viewport_set_canvas_transform(RID p_viewport,RID p_canvas,const Matrix32& p_offset)=0;
  534. virtual Matrix32 viewport_get_canvas_transform(RID p_viewport,RID p_canvas) const=0;
  535. virtual void viewport_set_transparent_background(RID p_viewport,bool p_enabled)=0;
  536. virtual bool viewport_has_transparent_background(RID p_viewport) const=0;
  537. virtual void viewport_set_global_canvas_transform(RID p_viewport,const Matrix32& p_transform)=0;
  538. virtual Matrix32 viewport_get_global_canvas_transform(RID p_viewport) const=0;
  539. virtual void viewport_set_canvas_layer(RID p_viewport,RID p_canvas,int p_layer)=0;
  540. /* ENVIRONMENT API */
  541. virtual RID environment_create()=0;
  542. enum EnvironmentBG {
  543. ENV_BG_KEEP,
  544. ENV_BG_DEFAULT_COLOR,
  545. ENV_BG_COLOR,
  546. ENV_BG_TEXTURE,
  547. ENV_BG_CUBEMAP,
  548. ENV_BG_CANVAS,
  549. ENV_BG_MAX
  550. };
  551. virtual void environment_set_background(RID p_env,EnvironmentBG p_bg)=0;
  552. virtual EnvironmentBG environment_get_background(RID p_env) const=0;
  553. enum EnvironmentBGParam {
  554. ENV_BG_PARAM_CANVAS_MAX_LAYER,
  555. ENV_BG_PARAM_COLOR,
  556. ENV_BG_PARAM_TEXTURE,
  557. ENV_BG_PARAM_CUBEMAP,
  558. ENV_BG_PARAM_ENERGY,
  559. ENV_BG_PARAM_SCALE,
  560. ENV_BG_PARAM_GLOW,
  561. ENV_BG_PARAM_MAX
  562. };
  563. virtual void environment_set_background_param(RID p_env,EnvironmentBGParam p_param, const Variant& p_value)=0;
  564. virtual Variant environment_get_background_param(RID p_env,EnvironmentBGParam p_param) const=0;
  565. enum EnvironmentFx {
  566. ENV_FX_AMBIENT_LIGHT,
  567. ENV_FX_FXAA,
  568. ENV_FX_GLOW,
  569. ENV_FX_DOF_BLUR,
  570. ENV_FX_HDR,
  571. ENV_FX_FOG,
  572. ENV_FX_BCS,
  573. ENV_FX_SRGB,
  574. ENV_FX_MAX
  575. };
  576. virtual void environment_set_enable_fx(RID p_env,EnvironmentFx p_effect,bool p_enabled)=0;
  577. virtual bool environment_is_fx_enabled(RID p_env,EnvironmentFx p_mode) const=0;
  578. enum EnvironmentFxBlurBlendMode {
  579. ENV_FX_BLUR_BLEND_MODE_ADDITIVE,
  580. ENV_FX_BLUR_BLEND_MODE_SCREEN,
  581. ENV_FX_BLUR_BLEND_MODE_SOFTLIGHT,
  582. };
  583. enum EnvironmentFxHDRToneMapper {
  584. ENV_FX_HDR_TONE_MAPPER_LINEAR,
  585. ENV_FX_HDR_TONE_MAPPER_LOG,
  586. ENV_FX_HDR_TONE_MAPPER_REINHARDT,
  587. ENV_FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE,
  588. };
  589. enum EnvironmentFxParam {
  590. ENV_FX_PARAM_AMBIENT_LIGHT_COLOR,
  591. ENV_FX_PARAM_AMBIENT_LIGHT_ENERGY,
  592. ENV_FX_PARAM_GLOW_BLUR_PASSES,
  593. ENV_FX_PARAM_GLOW_BLUR_SCALE,
  594. ENV_FX_PARAM_GLOW_BLUR_STRENGTH,
  595. ENV_FX_PARAM_GLOW_BLUR_BLEND_MODE,
  596. ENV_FX_PARAM_GLOW_BLOOM,
  597. ENV_FX_PARAM_GLOW_BLOOM_TRESHOLD,
  598. ENV_FX_PARAM_DOF_BLUR_PASSES,
  599. ENV_FX_PARAM_DOF_BLUR_BEGIN,
  600. ENV_FX_PARAM_DOF_BLUR_RANGE,
  601. ENV_FX_PARAM_HDR_TONEMAPPER,
  602. ENV_FX_PARAM_HDR_EXPOSURE,
  603. ENV_FX_PARAM_HDR_WHITE,
  604. ENV_FX_PARAM_HDR_GLOW_TRESHOLD,
  605. ENV_FX_PARAM_HDR_GLOW_SCALE,
  606. ENV_FX_PARAM_HDR_MIN_LUMINANCE,
  607. ENV_FX_PARAM_HDR_MAX_LUMINANCE,
  608. ENV_FX_PARAM_HDR_EXPOSURE_ADJUST_SPEED,
  609. ENV_FX_PARAM_FOG_BEGIN,
  610. ENV_FX_PARAM_FOG_BEGIN_COLOR,
  611. ENV_FX_PARAM_FOG_END_COLOR,
  612. ENV_FX_PARAM_FOG_ATTENUATION,
  613. ENV_FX_PARAM_FOG_BG,
  614. ENV_FX_PARAM_BCS_BRIGHTNESS,
  615. ENV_FX_PARAM_BCS_CONTRAST,
  616. ENV_FX_PARAM_BCS_SATURATION,
  617. ENV_FX_PARAM_MAX
  618. };
  619. virtual void environment_fx_set_param(RID p_env,EnvironmentFxParam p_effect,const Variant& p_param)=0;
  620. virtual Variant environment_fx_get_param(RID p_env,EnvironmentFxParam p_effect) const=0;
  621. /* SCENARIO API */
  622. virtual RID scenario_create()=0;
  623. enum ScenarioDebugMode {
  624. SCENARIO_DEBUG_DISABLED,
  625. SCENARIO_DEBUG_WIREFRAME,
  626. SCENARIO_DEBUG_OVERDRAW,
  627. SCENARIO_DEBUG_SHADELESS,
  628. };
  629. virtual void scenario_set_debug(RID p_scenario,ScenarioDebugMode p_debug_mode)=0;
  630. virtual void scenario_set_environment(RID p_scenario, RID p_environment)=0;
  631. virtual RID scenario_get_environment(RID p_scenario, RID p_environment) const=0;
  632. virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment)=0;
  633. /* INSTANCING API */
  634. enum InstanceType {
  635. INSTANCE_NONE,
  636. INSTANCE_MESH,
  637. INSTANCE_MULTIMESH,
  638. INSTANCE_IMMEDIATE,
  639. INSTANCE_PARTICLES,
  640. INSTANCE_LIGHT,
  641. INSTANCE_ROOM,
  642. INSTANCE_PORTAL,
  643. INSTANCE_BAKED_LIGHT,
  644. INSTANCE_BAKED_LIGHT_SAMPLER,
  645. INSTANCE_GEOMETRY_MASK=(1<<INSTANCE_MESH)|(1<<INSTANCE_MULTIMESH)|(1<<INSTANCE_IMMEDIATE)|(1<<INSTANCE_PARTICLES)
  646. };
  647. virtual RID instance_create2(RID p_base, RID p_scenario);
  648. // virtual RID instance_create(RID p_base,RID p_scenario)=0; // from can be mesh, light, area and portal so far.
  649. virtual RID instance_create()=0; // from can be mesh, light, poly, area and portal so far.
  650. virtual void instance_set_base(RID p_instance, RID p_base)=0; // from can be mesh, light, poly, area and portal so far.
  651. virtual RID instance_get_base(RID p_instance) const=0;
  652. virtual void instance_set_scenario(RID p_instance, RID p_scenario)=0; // from can be mesh, light, poly, area and portal so far.
  653. virtual RID instance_get_scenario(RID p_instance) const=0;
  654. virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask)=0;
  655. virtual uint32_t instance_get_layer_mask(RID p_instance) const=0;
  656. virtual AABB instance_get_base_aabb(RID p_instance) const=0;
  657. virtual void instance_set_transform(RID p_instance, const Transform& p_transform)=0;
  658. virtual Transform instance_get_transform(RID p_instance) const=0;
  659. virtual void instance_attach_object_instance_ID(RID p_instance,uint32_t p_ID)=0;
  660. virtual uint32_t instance_get_object_instance_ID(RID p_instance) const=0;
  661. virtual void instance_set_morph_target_weight(RID p_instance,int p_shape, float p_weight)=0;
  662. virtual float instance_get_morph_target_weight(RID p_instance,int p_shape) const=0;
  663. virtual void instance_attach_skeleton(RID p_instance,RID p_skeleton)=0;
  664. virtual RID instance_get_skeleton(RID p_instance) const=0;
  665. virtual void instance_set_exterior( RID p_instance, bool p_enabled )=0;
  666. virtual bool instance_is_exterior( RID p_instance) const=0;
  667. virtual void instance_set_room( RID p_instance, RID p_room )=0;
  668. virtual RID instance_get_room( RID p_instance ) const =0;
  669. virtual void instance_set_extra_visibility_margin( RID p_instance, real_t p_margin )=0;
  670. virtual real_t instance_get_extra_visibility_margin( RID p_instance ) const =0;
  671. // don't use these in a game!
  672. virtual Vector<RID> instances_cull_aabb(const AABB& p_aabb, RID p_scenario=RID()) const=0;
  673. virtual Vector<RID> instances_cull_ray(const Vector3& p_from, const Vector3& p_to, RID p_scenario=RID()) const=0;
  674. virtual Vector<RID> instances_cull_convex(const Vector<Plane>& p_convex, RID p_scenario=RID()) const=0;
  675. enum InstanceFlags {
  676. INSTANCE_FLAG_VISIBLE,
  677. INSTANCE_FLAG_BILLBOARD,
  678. INSTANCE_FLAG_BILLBOARD_FIX_Y,
  679. INSTANCE_FLAG_CAST_SHADOW,
  680. INSTANCE_FLAG_RECEIVE_SHADOWS,
  681. INSTANCE_FLAG_DEPH_SCALE,
  682. INSTANCE_FLAG_VISIBLE_IN_ALL_ROOMS,
  683. INSTANCE_FLAG_USE_BAKED_LIGHT,
  684. INSTANCE_FLAG_MAX
  685. };
  686. virtual void instance_geometry_set_flag(RID p_instance,InstanceFlags p_flags,bool p_enabled)=0;
  687. virtual bool instance_geometry_get_flag(RID p_instance,InstanceFlags p_flags) const=0;
  688. virtual void instance_geometry_set_material_override(RID p_instance, RID p_material)=0;
  689. virtual RID instance_geometry_get_material_override(RID p_instance) const=0;
  690. virtual void instance_geometry_set_draw_range(RID p_instance,float p_min,float p_max)=0;
  691. virtual float instance_geometry_get_draw_range_max(RID p_instance) const=0;
  692. virtual float instance_geometry_get_draw_range_min(RID p_instance) const=0;
  693. virtual void instance_geometry_set_baked_light(RID p_instance,RID p_baked_light)=0;
  694. virtual RID instance_geometry_get_baked_light(RID p_instance) const=0;
  695. virtual void instance_geometry_set_baked_light_sampler(RID p_instance,RID p_baked_light_sampler)=0;
  696. virtual RID instance_geometry_get_baked_light_sampler(RID p_instance) const=0;
  697. virtual void instance_geometry_set_baked_light_texture_index(RID p_instance,int p_tex_id)=0;
  698. virtual int instance_geometry_get_baked_light_texture_index(RID p_instance) const=0;
  699. virtual void instance_light_set_enabled(RID p_instance,bool p_enabled)=0;
  700. virtual bool instance_light_is_enabled(RID p_instance) const=0;
  701. /* CANVAS (2D) */
  702. virtual RID canvas_create()=0;
  703. virtual void canvas_set_item_mirroring(RID p_canvas,RID p_item,const Point2& p_mirroring)=0;
  704. virtual Point2 canvas_get_item_mirroring(RID p_canvas,RID p_item) const=0;
  705. virtual void canvas_set_modulate(RID p_canvas,const Color& p_color)=0;
  706. virtual RID canvas_item_create()=0;
  707. virtual void canvas_item_set_parent(RID p_item,RID p_parent)=0;
  708. virtual RID canvas_item_get_parent(RID p_canvas_item) const=0;
  709. virtual void canvas_item_set_visible(RID p_item,bool p_visible)=0;
  710. virtual bool canvas_item_is_visible(RID p_item) const=0;
  711. virtual void canvas_item_set_light_mask(RID p_item,int p_mask)=0;
  712. virtual void canvas_item_set_blend_mode(RID p_canvas_item,MaterialBlendMode p_blend)=0;
  713. virtual void canvas_item_attach_viewport(RID p_item, RID p_viewport)=0;
  714. //virtual void canvas_item_set_rect(RID p_item, const Rect2& p_rect)=0;
  715. virtual void canvas_item_set_transform(RID p_item, const Matrix32& p_transform)=0;
  716. virtual void canvas_item_set_clip(RID p_item, bool p_clip)=0;
  717. virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable)=0;
  718. virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect,const Rect2& p_rect=Rect2())=0;
  719. virtual void canvas_item_set_opacity(RID p_item, float p_opacity)=0;
  720. virtual float canvas_item_get_opacity(RID p_item, float p_opacity) const=0;
  721. virtual void canvas_item_set_self_opacity(RID p_item, float p_self_opacity)=0;
  722. virtual float canvas_item_get_self_opacity(RID p_item, float p_self_opacity) const=0;
  723. virtual void canvas_item_set_on_top(RID p_item, bool p_on_top)=0;
  724. virtual bool canvas_item_is_on_top(RID p_item) const=0;
  725. 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;
  726. virtual void canvas_item_add_rect(RID p_item, const Rect2& p_rect, const Color& p_color)=0;
  727. virtual void canvas_item_add_circle(RID p_item, const Point2& p_pos, float p_radius,const Color& p_color)=0;
  728. 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;
  729. 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)=0;
  730. virtual void canvas_item_add_style_box(RID p_item, const Rect2& p_rect, RID p_texture,const Vector2& p_topleft, const Vector2& p_bottomright, bool p_draw_center=true,const Color& p_modulate=Color(1,1,1))=0;
  731. 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;
  732. 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;
  733. 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>(), RID p_texture=RID(), int p_count=-1)=0;
  734. virtual void canvas_item_add_triangle_array_ptr(RID p_item, int p_count, const int* p_indices, const Point2* p_points, const Color* p_colors,const Point2* p_uvs=NULL, RID p_texture=RID())=0;
  735. virtual void canvas_item_add_set_transform(RID p_item,const Matrix32& p_transform)=0;
  736. virtual void canvas_item_add_set_blend_mode(RID p_item, MaterialBlendMode p_blend)=0;
  737. virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore)=0;
  738. virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable)=0;
  739. virtual void canvas_item_set_z(RID p_item, int p_z)=0;
  740. virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable)=0;
  741. virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable,const Rect2& p_rect)=0;
  742. virtual void canvas_item_clear(RID p_item)=0;
  743. virtual void canvas_item_raise(RID p_item)=0;
  744. virtual void canvas_item_set_material(RID p_item, RID p_material)=0;
  745. virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable)=0;
  746. virtual RID canvas_light_create()=0;
  747. virtual void canvas_light_attach_to_canvas(RID p_light,RID p_canvas)=0;
  748. virtual void canvas_light_set_enabled(RID p_light, bool p_enabled)=0;
  749. virtual void canvas_light_set_scale(RID p_light, float p_scale)=0;
  750. virtual void canvas_light_set_transform(RID p_light, const Matrix32& p_transform)=0;
  751. virtual void canvas_light_set_texture(RID p_light, RID p_texture)=0;
  752. virtual void canvas_light_set_texture_offset(RID p_light, const Vector2& p_offset)=0;
  753. virtual void canvas_light_set_color(RID p_light, const Color& p_color)=0;
  754. virtual void canvas_light_set_height(RID p_light, float p_height)=0;
  755. virtual void canvas_light_set_energy(RID p_light, float p_energy)=0;
  756. virtual void canvas_light_set_z_range(RID p_light, int p_min_z,int p_max_z)=0;
  757. virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer,int p_max_layer)=0;
  758. virtual void canvas_light_set_item_mask(RID p_light, int p_mask)=0;
  759. virtual void canvas_light_set_item_shadow_mask(RID p_light, int p_mask)=0;
  760. enum CanvasLightMode {
  761. CANVAS_LIGHT_MODE_ADD,
  762. CANVAS_LIGHT_MODE_SUB,
  763. CANVAS_LIGHT_MODE_MIX,
  764. };
  765. virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode)=0;
  766. virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled)=0;
  767. virtual void canvas_light_set_shadow_buffer_size(RID p_light, int p_size)=0;
  768. virtual void canvas_light_set_shadow_esm_multiplier(RID p_light, float p_multiplier)=0;
  769. virtual RID canvas_light_occluder_create()=0;
  770. virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder,RID p_canvas)=0;
  771. virtual void canvas_light_occluder_set_enabled(RID p_occluder,bool p_enabled)=0;
  772. virtual void canvas_light_occluder_set_polygon(RID p_occluder,RID p_polygon)=0;
  773. virtual void canvas_light_occluder_set_transform(RID p_occluder,const Matrix32& p_xform)=0;
  774. virtual void canvas_light_occluder_set_light_mask(RID p_occluder,int p_mask)=0;
  775. virtual RID canvas_occluder_polygon_create()=0;
  776. virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon,const DVector<Vector2>& p_shape,bool p_closed)=0;
  777. virtual void canvas_occluder_polygon_set_shape_as_lines(RID p_occluder_polygon,const DVector<Vector2>& p_shape)=0;
  778. enum CanvasOccluderPolygonCullMode {
  779. CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,
  780. CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,
  781. CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,
  782. };
  783. virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon,CanvasOccluderPolygonCullMode p_mode)=0;
  784. /* CANVAS ITEM MATERIAL */
  785. virtual RID canvas_item_material_create()=0;
  786. virtual void canvas_item_material_set_shader(RID p_material, RID p_shader)=0;
  787. virtual void canvas_item_material_set_shader_param(RID p_material, const StringName& p_param, const Variant& p_value)=0;
  788. virtual Variant canvas_item_material_get_shader_param(RID p_material, const StringName& p_param) const=0;
  789. enum CanvasItemShadingMode {
  790. CANVAS_ITEM_SHADING_NORMAL,
  791. CANVAS_ITEM_SHADING_UNSHADED,
  792. CANVAS_ITEM_SHADING_ONLY_LIGHT,
  793. };
  794. virtual void canvas_item_material_set_shading_mode(RID p_material, CanvasItemShadingMode p_mode)=0;
  795. /* CURSOR */
  796. virtual void cursor_set_rotation(float p_rotation, int p_cursor = 0)=0; // radians
  797. virtual void cursor_set_texture(RID p_texture, const Point2 &p_center_offset = Point2(0, 0), int p_cursor=0)=0;
  798. virtual void cursor_set_visible(bool p_visible, int p_cursor = 0)=0;
  799. virtual void cursor_set_pos(const Point2& p_pos, int p_cursor = 0)=0;
  800. /* BLACK BARS */
  801. virtual void black_bars_set_margins(int p_left, int p_top, int p_right, int p_bottom)=0;
  802. virtual void black_bars_set_images(RID p_left, RID p_top, RID p_right, RID p_bottom)=0;
  803. /* FREE */
  804. virtual void free( RID p_rid )=0; ///< free RIDs associated with the visual server
  805. /* CUSTOM SHADING */
  806. virtual void custom_shade_model_set_shader(int p_model, RID p_shader)=0;
  807. virtual RID custom_shade_model_get_shader(int p_model) const=0;
  808. virtual void custom_shade_model_set_name(int p_model, const String& p_name)=0;
  809. virtual String custom_shade_model_get_name(int p_model) const=0;
  810. virtual void custom_shade_model_set_param_info(int p_model, const List<PropertyInfo>& p_info)=0;
  811. virtual void custom_shade_model_get_param_info(int p_model, List<PropertyInfo>* p_info) const=0;
  812. /* EVENT QUEUING */
  813. virtual void draw()=0;
  814. virtual void flush()=0;
  815. virtual bool has_changed() const=0;
  816. virtual void init()=0;
  817. virtual void finish()=0;
  818. /* STATUS INFORMATION */
  819. enum RenderInfo {
  820. INFO_OBJECTS_IN_FRAME,
  821. INFO_VERTICES_IN_FRAME,
  822. INFO_MATERIAL_CHANGES_IN_FRAME,
  823. INFO_SHADER_CHANGES_IN_FRAME,
  824. INFO_SURFACE_CHANGES_IN_FRAME,
  825. INFO_DRAW_CALLS_IN_FRAME,
  826. INFO_USAGE_VIDEO_MEM_TOTAL,
  827. INFO_VIDEO_MEM_USED,
  828. INFO_TEXTURE_MEM_USED,
  829. INFO_VERTEX_MEM_USED,
  830. };
  831. virtual int get_render_info(RenderInfo p_info)=0;
  832. /* Materials for 2D on 3D */
  833. RID material_2d_get(bool p_shaded, bool p_transparent, bool p_cut_alpha,bool p_opaque_prepass);
  834. /* TESTING */
  835. virtual RID get_test_cube()=0;
  836. virtual RID get_test_texture();
  837. virtual RID get_white_texture();
  838. virtual RID make_sphere_mesh(int p_lats,int p_lons,float p_radius);
  839. virtual void mesh_add_surface_from_mesh_data( RID p_mesh, const Geometry::MeshData& p_mesh_data);
  840. virtual void mesh_add_surface_from_planes( RID p_mesh, const DVector<Plane>& p_planes);
  841. virtual void set_boot_image(const Image& p_image, const Color& p_color,bool p_scale)=0;
  842. virtual void set_default_clear_color(const Color& p_color)=0;
  843. enum Features {
  844. FEATURE_SHADERS,
  845. FEATURE_MULTITHREADED,
  846. FEATURE_NEEDS_RELOAD_HOOK,
  847. };
  848. virtual bool has_feature(Features p_feature) const=0;
  849. VisualServer();
  850. virtual ~VisualServer();
  851. };
  852. // make variant understand the enums
  853. VARIANT_ENUM_CAST( VisualServer::CubeMapSide );
  854. VARIANT_ENUM_CAST( VisualServer::TextureFlags );
  855. VARIANT_ENUM_CAST( VisualServer::ShaderMode );
  856. VARIANT_ENUM_CAST( VisualServer::MaterialFlag );
  857. VARIANT_ENUM_CAST( VisualServer::MaterialBlendMode );
  858. VARIANT_ENUM_CAST( VisualServer::ParticleVariable );
  859. VARIANT_ENUM_CAST( VisualServer::ArrayType );
  860. VARIANT_ENUM_CAST( VisualServer::ArrayFormat );
  861. VARIANT_ENUM_CAST( VisualServer::PrimitiveType );
  862. VARIANT_ENUM_CAST( VisualServer::LightType );
  863. VARIANT_ENUM_CAST( VisualServer::LightColor );
  864. VARIANT_ENUM_CAST( VisualServer::LightParam );
  865. VARIANT_ENUM_CAST( VisualServer::ScenarioDebugMode );
  866. VARIANT_ENUM_CAST( VisualServer::InstanceType );
  867. VARIANT_ENUM_CAST( VisualServer::RenderInfo );
  868. VARIANT_ENUM_CAST( VisualServer::MipMapPolicy );
  869. //typedef VisualServer VS; // makes it easier to use
  870. #define VS VisualServer
  871. #endif