1/**************************************************************************/
2/* utilities.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef UTILITIES_RD_H
32#define UTILITIES_RD_H
33
34#include "core/templates/rid_owner.h"
35#include "servers/rendering/storage/utilities.h"
36
37namespace RendererRD {
38
39/* VISIBILITY NOTIFIER */
40
41struct VisibilityNotifier {
42 AABB aabb;
43 Callable enter_callback;
44 Callable exit_callback;
45 Dependency dependency;
46};
47
48class Utilities : public RendererUtilities {
49private:
50 static Utilities *singleton;
51
52 /* VISIBILITY NOTIFIER */
53
54 mutable RID_Owner<VisibilityNotifier> visibility_notifier_owner;
55
56 /* MISC */
57
58 //keep cached since it can be called form any thread
59 uint64_t texture_mem_cache = 0;
60 uint64_t buffer_mem_cache = 0;
61 uint64_t total_mem_cache = 0;
62
63public:
64 static Utilities *get_singleton() { return singleton; }
65
66 Utilities();
67 virtual ~Utilities() override;
68
69 /* INSTANCES */
70
71 virtual RS::InstanceType get_base_type(RID p_rid) const override;
72 virtual bool free(RID p_rid) override;
73
74 /* DEPENDENCIES */
75
76 virtual void base_update_dependency(RID p_base, DependencyTracker *p_instance) override;
77
78 /* VISIBILITY NOTIFIER */
79
80 VisibilityNotifier *get_visibility_notifier(RID p_rid) { return visibility_notifier_owner.get_or_null(p_rid); };
81 bool owns_visibility_notifier(RID p_rid) const { return visibility_notifier_owner.owns(p_rid); };
82
83 virtual RID visibility_notifier_allocate() override;
84 virtual void visibility_notifier_initialize(RID p_notifier) override;
85 virtual void visibility_notifier_free(RID p_notifier) override;
86
87 virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) override;
88 virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) override;
89
90 virtual AABB visibility_notifier_get_aabb(RID p_notifier) const override;
91 virtual void visibility_notifier_call(RID p_notifier, bool p_enter, bool p_deferred) override;
92
93 /* TIMING */
94
95 virtual void capture_timestamps_begin() override;
96 virtual void capture_timestamp(const String &p_name) override;
97 virtual uint32_t get_captured_timestamps_count() const override;
98 virtual uint64_t get_captured_timestamps_frame() const override;
99 virtual uint64_t get_captured_timestamp_gpu_time(uint32_t p_index) const override;
100 virtual uint64_t get_captured_timestamp_cpu_time(uint32_t p_index) const override;
101 virtual String get_captured_timestamp_name(uint32_t p_index) const override;
102
103 /* MISC */
104
105 virtual void update_dirty_resources() override;
106 virtual void set_debug_generate_wireframes(bool p_generate) override {}
107
108 virtual bool has_os_feature(const String &p_feature) const override;
109
110 virtual void update_memory_info() override;
111
112 virtual uint64_t get_rendering_info(RS::RenderingInfo p_info) override;
113
114 virtual String get_video_adapter_name() const override;
115 virtual String get_video_adapter_vendor() const override;
116 virtual RenderingDevice::DeviceType get_video_adapter_type() const override;
117 virtual String get_video_adapter_api_version() const override;
118
119 virtual Size2i get_maximum_viewport_size() const override;
120};
121
122} // namespace RendererRD
123
124#endif // UTILITIES_RD_H
125