Blender V5.3
engine.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011-2022 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include <memory>
8#include <string>
9
10#include <pxr/imaging/hd/driver.h>
11#include <pxr/imaging/hd/engine.h>
12#include <pxr/imaging/hd/pluginRenderDelegateUniqueHandle.h>
13#include <pxr/imaging/hd/retainedSceneIndex.h>
14#include <pxr/imaging/hgi/hgi.h>
15#include <pxr/usd/usd/stage.h>
16#include <pxr/usdImaging/usdImaging/delegate.h>
17
19#include "hydra/scene_index.hh"
20#include "hydra/settings.hh"
22
25
26struct CLG_LogRef;
27
28namespace blender {
29
30struct bContext;
31struct Object;
32struct RenderEngine;
33
34namespace render::hydra {
35
36extern CLG_LogRef *LOG_HYDRA_RENDER;
37
38class Engine {
39 protected:
42 Depsgraph *depsgraph_ = nullptr;
43 bContext *context_ = nullptr;
44 Scene *scene_ = nullptr;
45
46 /* The order is important due to deletion order */
47 pxr::HgiUniquePtr hgi_;
48 pxr::HdDriver hgi_driver_;
49 pxr::HdPluginRenderDelegateUniqueHandle render_delegate_;
50 std::unique_ptr<pxr::HdRenderIndex> render_index_;
51
52 std::unique_ptr<io::hydra::CameraDelegate> free_camera_delegate_;
53 std::unique_ptr<io::hydra::HydraSceneIndex> hydra_scene_index_;
55 std::unique_ptr<io::hydra::USDSceneIndex> usd_scene_delegate_;
56
57 pxr::HdRetainedSceneIndexRefPtr task_scene_index_;
58 std::unique_ptr<RenderTaskDelegate> render_task_delegate_;
59 std::unique_ptr<LightTasksDelegate> light_tasks_delegate_;
60 std::unique_ptr<pxr::HdEngine> engine_;
61
62 public:
63 Engine(RenderEngine *bl_engine, const std::string &render_delegate_name);
64 virtual ~Engine() = default;
65
66 void sync(Depsgraph *depsgraph, bContext *context);
67 virtual void render() = 0;
68
69 virtual void set_render_setting(const std::string &key, const pxr::VtValue &val);
70
71 protected:
72 virtual const Object *camera_object() const = 0;
73
75 pxr::HdTaskSharedPtrVector tasks();
76 virtual void notify_status(float progress,
77 const std::string &title,
78 const std::string &info) = 0;
79};
80
81} // namespace render::hydra
82} // namespace blender
pxr::HdRetainedSceneIndexRefPtr task_scene_index_
Definition engine.hh:57
virtual const Object * camera_object() const =0
Engine(RenderEngine *bl_engine, const std::string &render_delegate_name)
RenderEngine * bl_engine_
Definition engine.hh:41
void sync(Depsgraph *depsgraph, bContext *context)
pxr::SdfPath hydra_scene_index_path_
Definition engine.hh:54
pxr::HdTaskSharedPtrVector tasks()
std::unique_ptr< RenderTaskDelegate > render_task_delegate_
Definition engine.hh:58
pxr::HdPluginRenderDelegateUniqueHandle render_delegate_
Definition engine.hh:49
std::string render_delegate_name_
Definition engine.hh:40
std::unique_ptr< io::hydra::USDSceneIndex > usd_scene_delegate_
Definition engine.hh:55
std::unique_ptr< io::hydra::CameraDelegate > free_camera_delegate_
Definition engine.hh:52
std::unique_ptr< pxr::HdRenderIndex > render_index_
Definition engine.hh:50
std::unique_ptr< io::hydra::HydraSceneIndex > hydra_scene_index_
Definition engine.hh:53
virtual void notify_status(float progress, const std::string &title, const std::string &info)=0
pxr::HgiUniquePtr hgi_
Definition engine.hh:47
virtual void set_render_setting(const std::string &key, const pxr::VtValue &val)
std::unique_ptr< LightTasksDelegate > light_tasks_delegate_
Definition engine.hh:59
std::unique_ptr< pxr::HdEngine > engine_
Definition engine.hh:60
CLG_LogRef * LOG_HYDRA_RENDER
BMesh Iterators.