2
0

renderer_viewport.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. /*************************************************************************/
  2. /* renderer_viewport.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef RENDERER_VIEWPORT_H
  31. #define RENDERER_VIEWPORT_H
  32. #include "core/templates/local_vector.h"
  33. #include "core/templates/rid_owner.h"
  34. #include "core/templates/self_list.h"
  35. #include "servers/rendering/renderer_scene.h"
  36. #include "servers/rendering_server.h"
  37. #include "servers/xr/xr_interface.h"
  38. class RendererViewport {
  39. public:
  40. struct CanvasBase {
  41. };
  42. struct Viewport {
  43. RID self;
  44. RID parent;
  45. bool use_xr; /* use xr interface to override camera positioning and projection matrices and control output */
  46. float scale_3d = 1.0;
  47. Size2i size;
  48. RID camera;
  49. RID scenario;
  50. RS::ViewportUpdateMode update_mode;
  51. RID render_target;
  52. RID render_target_texture;
  53. RID render_buffers;
  54. RS::ViewportMSAA msaa;
  55. RS::ViewportScreenSpaceAA screen_space_aa;
  56. bool use_debanding;
  57. bool use_occlusion_culling;
  58. bool occlusion_buffer_dirty;
  59. DisplayServer::WindowID viewport_to_screen;
  60. Rect2 viewport_to_screen_rect;
  61. bool viewport_render_direct_to_screen;
  62. bool disable_2d = false;
  63. bool disable_environment = false;
  64. bool disable_3d = false;
  65. bool measure_render_time;
  66. bool snap_2d_transforms_to_pixel;
  67. bool snap_2d_vertices_to_pixel;
  68. uint64_t time_cpu_begin;
  69. uint64_t time_cpu_end;
  70. uint64_t time_gpu_begin;
  71. uint64_t time_gpu_end;
  72. RID shadow_atlas;
  73. int shadow_atlas_size;
  74. bool shadow_atlas_16_bits = false;
  75. bool sdf_active;
  76. float lod_threshold = 1.0;
  77. uint64_t last_pass = 0;
  78. RS::ViewportDebugDraw debug_draw;
  79. RS::ViewportClearMode clear_mode;
  80. RS::CanvasItemTextureFilter texture_filter = RS::CANVAS_ITEM_TEXTURE_FILTER_LINEAR;
  81. RS::CanvasItemTextureRepeat texture_repeat = RS::CANVAS_ITEM_TEXTURE_REPEAT_DISABLED;
  82. bool transparent_bg;
  83. struct CanvasKey {
  84. int64_t stacking;
  85. RID canvas;
  86. bool operator<(const CanvasKey &p_canvas) const {
  87. if (stacking == p_canvas.stacking) {
  88. return canvas < p_canvas.canvas;
  89. }
  90. return stacking < p_canvas.stacking;
  91. }
  92. CanvasKey() {
  93. stacking = 0;
  94. }
  95. CanvasKey(const RID &p_canvas, int p_layer, int p_sublayer) {
  96. canvas = p_canvas;
  97. int64_t sign = p_layer < 0 ? -1 : 1;
  98. stacking = sign * (((int64_t)ABS(p_layer)) << 32) + p_sublayer;
  99. }
  100. int get_layer() const { return stacking >> 32; }
  101. };
  102. struct CanvasData {
  103. CanvasBase *canvas;
  104. Transform2D transform;
  105. int layer;
  106. int sublayer;
  107. };
  108. Transform2D global_transform;
  109. Map<RID, CanvasData> canvas_map;
  110. RendererScene::RenderInfo render_info;
  111. Viewport() {
  112. update_mode = RS::VIEWPORT_UPDATE_WHEN_VISIBLE;
  113. clear_mode = RS::VIEWPORT_CLEAR_ALWAYS;
  114. transparent_bg = false;
  115. viewport_to_screen = DisplayServer::INVALID_WINDOW_ID;
  116. shadow_atlas_size = 0;
  117. measure_render_time = false;
  118. debug_draw = RS::VIEWPORT_DEBUG_DRAW_DISABLED;
  119. msaa = RS::VIEWPORT_MSAA_DISABLED;
  120. screen_space_aa = RS::VIEWPORT_SCREEN_SPACE_AA_DISABLED;
  121. use_debanding = false;
  122. use_occlusion_culling = false;
  123. occlusion_buffer_dirty = true;
  124. snap_2d_transforms_to_pixel = false;
  125. snap_2d_vertices_to_pixel = false;
  126. use_xr = false;
  127. sdf_active = false;
  128. time_cpu_begin = 0;
  129. time_cpu_end = 0;
  130. time_gpu_begin = 0;
  131. time_gpu_end = 0;
  132. }
  133. uint32_t get_view_count();
  134. };
  135. HashMap<String, RID> timestamp_vp_map;
  136. uint64_t draw_viewports_pass = 0;
  137. mutable RID_Owner<Viewport, true> viewport_owner;
  138. struct ViewportSort {
  139. _FORCE_INLINE_ bool operator()(const Viewport *p_left, const Viewport *p_right) const {
  140. bool left_to_screen = p_left->viewport_to_screen_rect.size != Size2();
  141. bool right_to_screen = p_right->viewport_to_screen_rect.size != Size2();
  142. if (left_to_screen == right_to_screen) {
  143. return p_right->parent == p_left->self;
  144. }
  145. return (right_to_screen ? 0 : 1) < (left_to_screen ? 0 : 1);
  146. }
  147. };
  148. Vector<Viewport *> active_viewports;
  149. int total_objects_drawn = 0;
  150. int total_vertices_drawn = 0;
  151. int total_draw_calls_used = 0;
  152. private:
  153. void _configure_3d_render_buffers(Viewport *p_viewport);
  154. void _draw_3d(Viewport *p_viewport);
  155. void _draw_viewport(Viewport *p_viewport);
  156. int occlusion_rays_per_thread = 512;
  157. void _resize_occlusion_culling_buffer(const Size2i &p_size);
  158. public:
  159. RID viewport_allocate();
  160. void viewport_initialize(RID p_rid);
  161. void viewport_set_use_xr(RID p_viewport, bool p_use_xr);
  162. void viewport_set_scale_3d(RID p_viewport, float p_scale_3d);
  163. void viewport_set_size(RID p_viewport, int p_width, int p_height);
  164. void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID);
  165. void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable);
  166. void viewport_set_active(RID p_viewport, bool p_active);
  167. void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport);
  168. void viewport_set_update_mode(RID p_viewport, RS::ViewportUpdateMode p_mode);
  169. void viewport_set_vflip(RID p_viewport, bool p_enable);
  170. void viewport_set_clear_mode(RID p_viewport, RS::ViewportClearMode p_clear_mode);
  171. RID viewport_get_texture(RID p_viewport) const;
  172. RID viewport_get_occluder_debug_texture(RID p_viewport) const;
  173. void viewport_set_disable_2d(RID p_viewport, bool p_disable);
  174. void viewport_set_disable_environment(RID p_viewport, bool p_disable);
  175. void viewport_set_disable_3d(RID p_viewport, bool p_disable);
  176. void viewport_attach_camera(RID p_viewport, RID p_camera);
  177. void viewport_set_scenario(RID p_viewport, RID p_scenario);
  178. void viewport_attach_canvas(RID p_viewport, RID p_canvas);
  179. void viewport_remove_canvas(RID p_viewport, RID p_canvas);
  180. void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset);
  181. void viewport_set_transparent_background(RID p_viewport, bool p_enabled);
  182. void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform);
  183. void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer);
  184. void viewport_set_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = false);
  185. void viewport_set_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv);
  186. void viewport_set_msaa(RID p_viewport, RS::ViewportMSAA p_msaa);
  187. void viewport_set_screen_space_aa(RID p_viewport, RS::ViewportScreenSpaceAA p_mode);
  188. void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding);
  189. void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling);
  190. void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread);
  191. void viewport_set_occlusion_culling_build_quality(RS::ViewportOcclusionCullingBuildQuality p_quality);
  192. void viewport_set_lod_threshold(RID p_viewport, float p_pixels);
  193. virtual int viewport_get_render_info(RID p_viewport, RS::ViewportRenderInfoType p_type, RS::ViewportRenderInfo p_info);
  194. virtual void viewport_set_debug_draw(RID p_viewport, RS::ViewportDebugDraw p_draw);
  195. void viewport_set_measure_render_time(RID p_viewport, bool p_enable);
  196. float viewport_get_measured_render_time_cpu(RID p_viewport) const;
  197. float viewport_get_measured_render_time_gpu(RID p_viewport) const;
  198. void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled);
  199. void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled);
  200. void viewport_set_default_canvas_item_texture_filter(RID p_viewport, RS::CanvasItemTextureFilter p_filter);
  201. void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, RS::CanvasItemTextureRepeat p_repeat);
  202. void viewport_set_sdf_oversize_and_scale(RID p_viewport, RS::ViewportSDFOversize p_over_size, RS::ViewportSDFScale p_scale);
  203. void handle_timestamp(String p_timestamp, uint64_t p_cpu_time, uint64_t p_gpu_time);
  204. void set_default_clear_color(const Color &p_color);
  205. void draw_viewports();
  206. bool free(RID p_rid);
  207. int get_total_objects_drawn() const;
  208. int get_total_vertices_drawn() const;
  209. int get_total_draw_calls_used() const;
  210. // Workaround for setting this on thread.
  211. void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window);
  212. RendererViewport();
  213. virtual ~RendererViewport() {}
  214. };
  215. #endif // RENDERER_VIEWPORT_H