visual_server.h 39 KB

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