#include <DRW_render.hh>

Public Types
enum	Mode { VIEWPORT = 0 , VIEWPORT_XR , VIEWPORT_OFFSCREEN , VIEWPORT_RENDER , SELECT_OBJECT , SELECT_OBJECT_MATERIAL , SELECT_EDIT_MESH , DEPTH , DEPTH_ACTIVE_OBJECT , RENDER , CUSTOM }
using	iter_callback_t

Public Member Functions
GPUFrameBuffer *	default_framebuffer ()
DefaultFramebufferList *	viewport_framebuffer_list_get () const
DefaultTextureList *	viewport_texture_list_get () const
	DRWContext (Mode mode, Depsgraph depsgraph, GPUViewport viewport, const bContext C=nullptr, ARegion region=nullptr, View3D *v3d=nullptr)
	DRWContext (Mode mode, Depsgraph depsgraph, const blender::int2 size={1, 1}, const bContext C=nullptr, ARegion region=nullptr, View3D v3d=nullptr)
	~DRWContext ()
blender::float2	viewport_size_get () const
bool	is_select () const
bool	is_material_select () const
bool	is_depth () const
bool	is_image_render () const
bool	is_scene_render () const
bool	is_viewport_image_render () const
Viewport (DRW_viewport)
void	acquire_data ()
void	release_data ()
Rendering (DRW_engines)
void	enable_engines (bool gpencil_engine_needed=false, RenderEngineType *render_engine_type=nullptr)
void	engines_data_validate ()
void	sync (iter_callback_t iter_callback)
void	engines_init_and_sync (iter_callback_t iter_callback)
void	engines_draw_scene ()
Draw Manager State
bool	is_playback () const
bool	is_navigating () const
bool	is_painting () const
bool	is_transforming () const
bool	is_viewport_compositor_enabled () const

Static Public Member Functions
static DRWContext &	get_active ()
static bool	is_active ()

Public Attributes
DRWData *	data = nullptr
DRWViewData *	view_data_active = nullptr
GPUViewport *	viewport = nullptr
blender::float2	size = {0, 0}
blender::float2	inv_size = {0, 0}
enum DRWContext::Mode	mode
struct {
bool draw_background = false
bool draw_text = false
}	options
DRWTextStore **	text_store_p = nullptr
GSet *	delayed_extraction = nullptr
Depsgraph *	depsgraph = nullptr
Scene *	scene = nullptr
ViewLayer *	view_layer = nullptr
const bContext *	evil_C = nullptr
ARegion *	region = nullptr
SpaceLink *	space_data = nullptr
RegionView3D *	rv3d = nullptr
View3D *	v3d = nullptr
Object *	obact = nullptr
Object *	object_pose = nullptr
Object *	object_edit = nullptr
eObjectMode	object_mode = OB_MODE_OBJECT

Detailed Description

Definition at line 209 of file DRW_render.hh.

Member Typedef Documentation

◆ iter_callback_t

using DRWContext::iter_callback_t

Initial value:

std::function<void(struct DupliCacheManager &, struct ExtractionGraph &)>

DupliCacheManager

Definition draw_context.cc:568

ExtractionGraph

Definition draw_context.cc:242

Definition at line 354 of file DRW_render.hh.

Member Enumeration Documentation

◆ Mode

enum DRWContext::Mode

Enumerator
VIEWPORT	Render for display of 2D or 3D area. Runs on main thread.
VIEWPORT_XR	Render for a 3D viewport in XR. Runs on main thread.
VIEWPORT_OFFSCREEN	Render for a 3D viewport offscreen render (python). Runs on main thread.
VIEWPORT_RENDER	Render for a 3D viewport image render (render preview). Runs on main thread.
SELECT_OBJECT	Render for object mode selection. Runs on main thread.
SELECT_OBJECT_MATERIAL	Render for object material selection. Runs on main thread.
SELECT_EDIT_MESH	Render for edit mesh selection. Runs on main thread.
DEPTH	Render for depth picking (auto-depth). Runs on main thread.
DEPTH_ACTIVE_OBJECT
RENDER	Render for F12 final render. Can run in any thread.
CUSTOM	Used by custom pipeline. Can run in any thread.

Definition at line 235 of file DRW_render.hh.

Constructor & Destructor Documentation

◆ DRWContext() [1/2]

DRWContext::DRWContext	(	Mode	mode,
		Depsgraph *	depsgraph,
		GPUViewport *	viewport,
		const bContext *	C = nullptr,
		ARegion *	region = nullptr,
		View3D *	v3d = nullptr )

If viewport is not specified, DRWData will be considered temporary and discarded on exit. If C is nullptr, it means that the context is not associated with any UI or operator. If region is nullptr, it will be sourced from the context C or left as nullptr otherwise. If v3d is nullptr, it will be sourced from the context C or left as nullptr otherwise.

Definition at line 174 of file draw_context.cc.

References C, depsgraph, DRWContext(), GPU_texture_height(), GPU_texture_width(), GPU_viewport_color_texture(), region, v3d, viewport, and blender::draw::color_management::viewport_color_management_set().

Referenced by DRWContext(), and get_active().

◆ DRWContext() [2/2]

DRWContext::DRWContext	(	Mode	mode,
		Depsgraph *	depsgraph,
		const blender::int2	size = {1, 1},
		const bContext *	C = nullptr,
		ARegion *	region = nullptr,
		View3D *	v3d = nullptr )

References depsgraph, mode, and size.

◆ ~DRWContext()

DRWContext::~DRWContext ( )

Definition at line 193 of file draw_context.cc.

References BLI_assert.

Member Function Documentation

◆ acquire_data()

void DRWContext::acquire_data ( )

Acquire data and view_data_active. Needs to be called before enabling any draw engine. IMPORTANT: This can be called multiple times before release_data. IMPORTANT: This must be called with an active GPUContext.

Definition at line 466 of file draw_context.cc.

References BLI_assert, BLI_rctf_transform_calc_m4_pivot_min(), View2D::cur, CUSTOM, data, blender::draw::View::default_set(), DRW_view_data_default_lists_from_viewport(), DRW_viewport_data_create(), drw_viewport_data_ensure(), blender::gpu::TexturePool::get(), GPU_context_active_get(), GPU_viewport_active_view_get(), blender::MatBase< float, 4, 4 >::identity(), is_image_render(), mode, blender::MatBase< T, NumCol, NumRow, Alignment >::ptr(), blender::gpu::TexturePool::reset(), rv3d, ARegion::v2d, view, view_data_active, and viewport.

Referenced by DRW_cache_restart(), DRW_custom_pipeline_begin(), DRW_draw_depth_loop(), DRW_draw_render_loop_offscreen(), DRW_draw_select_id(), DRW_draw_select_loop(), DRW_draw_view(), DRW_render_gpencil(), and DRW_render_to_image().

◆ default_framebuffer()

GPUFrameBuffer * DRWContext::default_framebuffer ( )

Returns the viewport's default frame-buffer.

Definition at line 199 of file draw_context.cc.

References view_data_active.

Referenced by drw_draw_render_loop_2d(), and drw_draw_render_loop_3d().

◆ enable_engines()

void DRWContext::enable_engines	(	bool	gpencil_engine_needed = false,
		RenderEngineType *	render_engine_type = nullptr )

Enable engines from context. Not needed for Mode::RENDER and Mode::CUSTOM.

render_engine_type specify the engine to use in OB_MATERIAL or OB_RENDER modes. gpencil_engine_needed should be set to true if the grease pencil engine is needed.

Definition at line 861 of file draw_context.cc.

References BLI_assert_unreachable, DRWViewData::compositor, DEPTH, DEPTH_ACTIVE_OBJECT, DRW_engine_external_acquire_for_image_editor(), DRW_engine_viewport_eevee_type, DRW_engine_viewport_workbench_type, DRWViewData::edit_select, DRWViewData::eevee, ELEM, DRWViewData::external, RenderEngineType::flag, SpaceNode::flag, G, DRWViewData::grease_pencil, DRWViewData::image, is_viewport_compositor_enabled(), mode, OB_MATERIAL, OB_RENDER, OB_SOLID, OB_WIRE, DRWViewData::object_select, DRWViewData::overlay, RE_INTERNAL, SELECT_EDIT_MESH, SELECT_OBJECT, SELECT_OBJECT_MATERIAL, DrawEngine::Pointer::set_used(), View3D::shading, SNODE_BACKDRAW, space_data, SPACE_IMAGE, SPACE_NODE, View3DShading::type, view_data_active, DRWViewData::workbench, and XRAY_ENABLED.

Referenced by DRW_draw_depth_loop(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_select_id(), and DRW_draw_select_loop().

◆ engines_data_validate()

void DRWContext::engines_data_validate ( )

Free unused engine data.

Definition at line 949 of file draw_context.cc.

References DRW_view_data_free_unused(), and view_data_active.

Referenced by drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), and DRW_draw_select_loop().

◆ engines_draw_scene()

void DRWContext::engines_draw_scene ( )

Run enabled engine init and draw scene callbacks.

Definition at line 814 of file draw_context.cc.

References blender::StringRefNull::c_str(), DrawEngine::draw(), DRW_manager_get(), GPU_BACKEND_OPENGL, GPU_debug_group_begin(), GPU_debug_group_end(), GPU_DEVICE_ANY, GPU_DRIVER_ANY, GPU_flush(), GPU_OS_ANY, GPU_type_matches_ex(), DrawEngine::name_get(), blender::draw::command::StateSet::set(), and view_data_active.

Referenced by DRW_draw_depth_loop(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_select_id(), and DRW_draw_select_loop().

◆ engines_init_and_sync()

void DRWContext::engines_init_and_sync ( iter_callback_t iter_callback )

Run enabled engine init and sync callbacks. iter_callback defines which object to sync.

Definition at line 788 of file draw_context.cc.

References DrawEngine::begin_sync(), DRW_text_cache_destroy(), DrawEngine::end_sync(), DrawEngine::init(), obact, sync(), DrawEngine::text_draw_cache, text_store_p, and view_data_active.

Referenced by DRW_draw_depth_loop(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_select_id(), and DRW_draw_select_loop().

◆ get_active()

DRWContext & DRWContext::get_active ( )

inlinestatic

Definition at line 364 of file DRW_render.hh.

References DRWContext().

Referenced by drw_get().

◆ is_active()

bool DRWContext::is_active ( )

inlinestatic

Return true if any DRWContext is active on this thread.

Definition at line 375 of file DRW_render.hh.

Referenced by DRW_draw_in_progress().

◆ is_depth()

bool DRWContext::is_depth ( ) const

inline

Definition at line 388 of file DRW_render.hh.

References DEPTH, DEPTH_ACTIVE_OBJECT, ELEM, and mode.

Referenced by blender::draw::overlay::Instance::init().

◆ is_image_render()

bool DRWContext::is_image_render ( ) const

inline

Definition at line 392 of file DRW_render.hh.

References ELEM, mode, RENDER, and VIEWPORT_RENDER.

Referenced by acquire_data(), blender::workbench::AntiAliasingPass::draw(), DRW_object_is_visible_psys_in_active_context(), blender::draw::overlay::Instance::init(), blender::workbench::SceneResources::init(), and blender::workbench::ObjectState::ObjectState().

◆ is_material_select()

bool DRWContext::is_material_select ( ) const

inline

Definition at line 384 of file DRW_render.hh.

References ELEM, mode, and SELECT_OBJECT_MATERIAL.

Referenced by blender::draw::overlay::Instance::init().

◆ is_navigating()

bool DRWContext::is_navigating ( ) const

True if current viewport is drawn during navigation operator.

Definition at line 1983 of file draw_context.cc.

References rv3d, RV3D_NAVIGATING, and RV3D_PAINTING.

◆ is_painting()

bool DRWContext::is_painting ( ) const

True if current viewport is drawn during painting operator.

Definition at line 1988 of file draw_context.cc.

References rv3d, and RV3D_PAINTING.

◆ is_playback()

bool DRWContext::is_playback ( ) const

True if current viewport is drawn during playback.

Definition at line 1974 of file draw_context.cc.

References CTX_wm_manager(), ED_screen_animation_playing(), and evil_C.

◆ is_scene_render()

bool DRWContext::is_scene_render ( ) const

inline

Definition at line 396 of file DRW_render.hh.

References ELEM, mode, and RENDER.

Referenced by blender::workbench::AntiAliasingPass::draw(), DRW_object_visibility_in_active_context(), and blender::workbench::ObjectState::ObjectState().

◆ is_select()

bool DRWContext::is_select ( ) const

inline

Definition at line 380 of file DRW_render.hh.

References ELEM, mode, SELECT_EDIT_MESH, SELECT_OBJECT, and SELECT_OBJECT_MATERIAL.

◆ is_transforming()

bool DRWContext::is_transforming ( ) const

True if current viewport is drawn during transforming operator.

Definition at line 1993 of file draw_context.cc.

References G, G_TRANSFORM_EDIT, and G_TRANSFORM_OBJ.

◆ is_viewport_compositor_enabled()

bool DRWContext::is_viewport_compositor_enabled ( ) const

True if viewport compositor is enabled when drawing with this context.

Definition at line 1998 of file draw_context.cc.

References OB_MATERIAL, rv3d, RV3D_CAMOB, scene, View3D::shading, this, View3DShading::type, View3DShading::use_compositor, V3D_SHADING_USE_COMPOSITOR_CAMERA, and V3D_SHADING_USE_COMPOSITOR_DISABLED.

Referenced by enable_engines().

◆ is_viewport_image_render()

bool DRWContext::is_viewport_image_render ( ) const

inline

Definition at line 400 of file DRW_render.hh.

References ELEM, mode, and VIEWPORT_RENDER.

Referenced by blender::draw::compositor_engine::Context::get_compositing_region(), and blender::draw::overlay::Instance::init().

◆ release_data()

void DRWContext::release_data ( )

Make sure to release acquired DRWData. If created on the fly, make sure to destroy them. IMPORTANT: This needs to be called with the same active GPUContext acquire_data() was called with.

Definition at line 526 of file draw_context.cc.

References BLI_assert, data, DRW_view_data_reset(), DRW_viewport_data_free(), GPU_context_active_get(), blender::draw::command::StateSet::set(), view_data_active, and viewport.

Referenced by DRW_custom_pipeline_end(), DRW_draw_depth_loop(), DRW_draw_render_loop_offscreen(), DRW_draw_select_id(), DRW_draw_select_loop(), and DRW_draw_view().