Blender: blender::render::hydra::Engine Class Reference

Blender V4.3

#include <engine.hh>

Inherited by blender::render::hydra::FinalEngine, and blender::render::hydra::ViewportEngine.

Public Member Functions
	Engine (RenderEngine *bl_engine, const std::string &render_delegate_name)

virtual	~Engine ()=default

void	sync (Depsgraph depsgraph, bContext context)

virtual void	render ()=0

virtual void	set_render_setting (const std::string &key, const pxr::VtValue &val)

Protected Member Functions
float	renderer_percent_done ()

pxr::HdTaskSharedPtrVector	tasks ()

virtual void	notify_status (float progress, const std::string &title, const std::string &info)=0

Protected Attributes
std::string	render_delegate_name_

RenderEngine *	bl_engine_ = nullptr

Depsgraph *	depsgraph_ = nullptr

bContext *	context_ = nullptr

Scene *	scene_ = nullptr

pxr::HgiUniquePtr	hgi_

pxr::HdDriver	hgi_driver_

pxr::HdPluginRenderDelegateUniqueHandle	render_delegate_

std::unique_ptr< pxr::HdRenderIndex >	render_index_

std::unique_ptr< io::hydra::HydraSceneDelegate >	hydra_scene_delegate_

std::unique_ptr< io::hydra::USDSceneDelegate >	usd_scene_delegate_

std::unique_ptr< RenderTaskDelegate >	render_task_delegate_

std::unique_ptr< pxr::HdxFreeCameraSceneDelegate >	free_camera_delegate_

std::unique_ptr< LightTasksDelegate >	light_tasks_delegate_

std::unique_ptr< pxr::HdEngine >	engine_

Detailed Description

Definition at line 33 of file engine.hh.

Constructor & Destructor Documentation

◆ Engine()

blender::render::hydra::Engine::Engine	(	RenderEngine *	bl_engine,
		const std::string &	render_delegate_name )

Definition at line 30 of file hydra/engine.cc.

References BLI_setenv(), RenderEngineType::flag, GPU_backend_get_type(), GPU_BACKEND_VULKAN, hgi_, hgi_driver_, RE_USE_GPU_CONTEXT, render_delegate_, render_delegate_name_, render_index_, and RenderEngine::type.

◆ ~Engine()

virtual blender::render::hydra::Engine::~Engine ( )

virtualdefault

Member Function Documentation

◆ notify_status()

virtual void blender::render::hydra::Engine::notify_status	(	float	progress,
		const std::string &	title,
		const std::string &	info )

protectedpure virtual

Implemented in blender::render::hydra::FinalEngine, blender::render::hydra::PreviewEngine, and blender::render::hydra::ViewportEngine.

◆ render()

virtual void blender::render::hydra::Engine::render ( )

pure virtual

Implemented in blender::render::hydra::FinalEngine, and blender::render::hydra::ViewportEngine.

Referenced by blender::render::hydra::engine_render_func().

◆ renderer_percent_done()

float blender::render::hydra::Engine::renderer_percent_done ( )

protected

Definition at line 119 of file hydra/engine.cc.

References float, and render_delegate_.

Referenced by blender::render::hydra::FinalEngine::render(), and blender::render::hydra::ViewportEngine::render().

◆ set_render_setting()

void blender::render::hydra::Engine::set_render_setting	(	const std::string &	key,
		const pxr::VtValue &	val )

virtual

Reimplemented in blender::render::hydra::FinalEngine.

Definition at line 114 of file hydra/engine.cc.

References render_delegate_.

Referenced by blender::render::hydra::engine_set_render_setting_func(), and blender::render::hydra::FinalEngine::set_render_setting().

◆ sync()

void blender::render::hydra::Engine::sync	(	Depsgraph *	depsgraph,
		bContext *	context )

Definition at line 78 of file hydra/engine.cc.

References bl_engine_, context_, CTX_wm_view3d(), DEG_get_evaluated_scene(), depsgraph, depsgraph_, SceneHydra::export_method, RenderEngineType::flag, Scene::hydra, hydra_scene_delegate_, RE_USE_MATERIALX, render_index_, SCE_HYDRA_EXPORT_HYDRA, scene_, RenderEngine::type, and usd_scene_delegate_.

Referenced by blender::render::hydra::engine_update_func().

◆ tasks()

pxr::HdTaskSharedPtrVector blender::render::hydra::Engine::tasks ( )

protected

Definition at line 129 of file hydra/engine.cc.

References RenderData::alphamode, light_tasks_delegate_, Scene::r, R_ALPHAPREMUL, render_task_delegate_, and scene_.

Referenced by blender::render::hydra::FinalEngine::render(), and blender::render::hydra::ViewportEngine::render().

Member Data Documentation

◆ bl_engine_

RenderEngine* blender::render::hydra::Engine::bl_engine_ = nullptr

protected

Definition at line 36 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::notify_status(), blender::render::hydra::ViewportEngine::notify_status(), blender::render::hydra::FinalEngine::render(), blender::render::hydra::ViewportEngine::render(), and sync().

◆ context_

bContext* blender::render::hydra::Engine::context_ = nullptr

protected

Definition at line 38 of file engine.hh.

Referenced by blender::render::hydra::ViewportEngine::render(), blender::render::hydra::ViewportEngine::render(), and sync().

◆ depsgraph_

Depsgraph* blender::render::hydra::Engine::depsgraph_ = nullptr

protected

Definition at line 37 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), and sync().

◆ engine_

std::unique_ptr<pxr::HdEngine> blender::render::hydra::Engine::engine_

protected

Definition at line 53 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), and blender::render::hydra::ViewportEngine::render().

◆ free_camera_delegate_

std::unique_ptr<pxr::HdxFreeCameraSceneDelegate> blender::render::hydra::Engine::free_camera_delegate_

protected

Definition at line 51 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), and blender::render::hydra::ViewportEngine::render().

◆ hgi_

pxr::HgiUniquePtr blender::render::hydra::Engine::hgi_

protected

Definition at line 42 of file engine.hh.

Referenced by Engine().

◆ hgi_driver_

pxr::HdDriver blender::render::hydra::Engine::hgi_driver_

protected

Definition at line 43 of file engine.hh.

Referenced by Engine().

◆ hydra_scene_delegate_

std::unique_ptr<io::hydra::HydraSceneDelegate> blender::render::hydra::Engine::hydra_scene_delegate_

protected

Definition at line 47 of file engine.hh.

Referenced by sync().

◆ light_tasks_delegate_

std::unique_ptr<LightTasksDelegate> blender::render::hydra::Engine::light_tasks_delegate_

protected

Definition at line 52 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), blender::render::hydra::ViewportEngine::render(), and tasks().

◆ render_delegate_

pxr::HdPluginRenderDelegateUniqueHandle blender::render::hydra::Engine::render_delegate_

protected

Definition at line 44 of file engine.hh.

Referenced by Engine(), renderer_percent_done(), and set_render_setting().

◆ render_delegate_name_

std::string blender::render::hydra::Engine::render_delegate_name_

protected

Definition at line 35 of file engine.hh.

Referenced by Engine().

◆ render_index_

std::unique_ptr<pxr::HdRenderIndex> blender::render::hydra::Engine::render_index_

protected

Definition at line 45 of file engine.hh.

Referenced by Engine(), blender::render::hydra::FinalEngine::render(), blender::render::hydra::ViewportEngine::render(), and sync().

◆ render_task_delegate_

std::unique_ptr<RenderTaskDelegate> blender::render::hydra::Engine::render_task_delegate_

protected

Definition at line 50 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), blender::render::hydra::ViewportEngine::render(), and tasks().

◆ scene_

Scene* blender::render::hydra::Engine::scene_ = nullptr

protected

Definition at line 39 of file engine.hh.

Referenced by blender::render::hydra::FinalEngine::render(), sync(), and tasks().

◆ usd_scene_delegate_

std::unique_ptr<io::hydra::USDSceneDelegate> blender::render::hydra::Engine::usd_scene_delegate_

protected

Definition at line 48 of file engine.hh.

Referenced by sync().

The documentation for this class was generated from the following files: