1 /*
2 * Copyright (C) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #ifndef API_RENDER_IRENDER_CONTEXT_H
17 #define API_RENDER_IRENDER_CONTEXT_H
18
19 #include <base/containers/string.h>
20 #include <base/containers/string_view.h>
21 #include <core/plugin/intf_class_factory.h>
22 #include <render/device/intf_device.h>
23 #include <render/namespace.h>
24 #include <render/resource_handle.h>
25
26 RENDER_BEGIN_NAMESPACE()
27 class IRenderDataStoreManager;
28 class IRenderNodeGraphManager;
29 class IRenderer;
30 class IRenderUtil;
31
32 /**
33 * RenderResultCode
34 */
35 enum class RenderResultCode : uint32_t {
36 RENDER_SUCCESS = 0,
37 RENDER_ERROR = 1,
38 };
39
40 /**
41 * VersionInfo
42 */
43 struct VersionInfo {
44 /** Name, default is "no_name" */
45 BASE_NS::string name { "no_name" };
46 /** Major number of version */
47 uint32_t versionMajor { 0 };
48 /** Minor number of version */
49 uint32_t versionMinor { 0 };
50 /** Patch number of version */
51 uint32_t versionPatch { 0 };
52 };
53
54 /**
55 * RenderCreateInfo
56 */
57 struct RenderCreateInfo {
58 /** Application version info */
59 VersionInfo applicationInfo;
60 /** Device create info */
61 DeviceCreateInfo deviceCreateInfo;
62 };
63
64 /**
65 * IRenderContext interface for accessing managers and renderer.
66 * Device must be created to access valid renderer, render node graph manager, and render data store manager.
67 */
68 class IRenderContext : public CORE_NS::IClassFactory {
69 public:
70 static constexpr auto UID = BASE_NS::Uid { "c8d8650b-efac-4e04-8e66-e12b35d2749e" };
71 using Ptr = BASE_NS::refcnt_ptr<IRenderContext>;
72
73 /** Init, create device for render use.
74 * @param createInfo Device creation info.
75 */
76 virtual RenderResultCode Init(const RenderCreateInfo& createInfo) = 0;
77
78 /** Get active device. */
79 virtual IDevice& GetDevice() const = 0;
80 /** Get rendererer */
81 virtual IRenderer& GetRenderer() const = 0;
82 /** Get render node graph manager */
83 virtual IRenderNodeGraphManager& GetRenderNodeGraphManager() const = 0;
84 /** Get render data store manager */
85 virtual IRenderDataStoreManager& GetRenderDataStoreManager() const = 0;
86
87 /** Get render utilities */
88 virtual IRenderUtil& GetRenderUtil() const = 0;
89
90 /** Get engine */
91 virtual CORE_NS::IEngine& GetEngine() const = 0;
92
93 /** Get version */
94 virtual BASE_NS::string_view GetVersion() = 0;
95
96 protected:
97 IRenderContext() = default;
98 virtual ~IRenderContext() = default;
99 };
100
GetName(const IRenderContext *)101 inline constexpr BASE_NS::string_view GetName(const IRenderContext*)
102 {
103 return "IRenderContext";
104 }
105 RENDER_END_NAMESPACE()
106
107 #endif // API_RENDER_IRENDER_CONTEXT_H
108