Blender V5.3
blender::DRWViewData Struct Reference

#include <draw_view_data.hh>

Public Member Functions

 DRWViewData ()
 ~DRWViewData ()
void texture_list_size_validate (const int2 &size)
template<typename CallbackT>
void foreach_engine (CallbackT callback)
template<typename CallbackT>
void foreach_enabled_engine (CallbackT callback)

Public Attributes

DefaultFramebufferList dfbl = {}
DefaultTextureList dtxl = {}
bool from_viewport = false
int2 texture_list_size = {0, 0}
eevee::Engine eevee
workbench::Engine workbench
draw::external::Engine external
image_engine::Engine image
draw::gpencil::Engine grease_pencil
draw::overlay::Engine overlay
draw::select::Engine object_select
draw::edit_select::Engine edit_select
draw::compositor_engine::Engine compositor
Map< std::string, std::unique_ptr< draw::TextureFromPool > > viewport_compositor_passes
draw::Manager * manager = nullptr

Detailed Description

Definition at line 62 of file draw_view_data.hh.

Constructor & Destructor Documentation

◆ DRWViewData()

blender::DRWViewData::DRWViewData ( )

Definition at line 28 of file draw_view_data.cc.

References manager.

Referenced by blender::DRW_viewport_data_create().

◆ ~DRWViewData()

blender::DRWViewData::~DRWViewData ( )

Definition at line 33 of file draw_view_data.cc.

References manager.

Member Function Documentation

◆ foreach_enabled_engine()

◆ foreach_engine()

template<typename CallbackT>
void blender::DRWViewData::foreach_engine ( CallbackT callback)
inline

Grease pencil. Merge its output to the render result frame-buffer.

GPU compositor. Processes render result and output to the render result frame-buffer.

Overlays. Draw on a separate overlay frame-buffer. Can read render result.

Selection. Are always enabled alone and have no interaction with other engines.

Definition at line 105 of file draw_view_data.hh.

References compositor, edit_select, external, image, and object_select.

Referenced by blender::DRW_view_data_free_unused(), and foreach_enabled_engine().

◆ texture_list_size_validate()

void blender::DRWViewData::texture_list_size_validate ( const int2 & size)

Definition at line 103 of file draw_view_data.cc.

References blender::copy_v2_v2_int(), and texture_list_size.

Referenced by blender::DRWContext::acquire_data().

Member Data Documentation

◆ compositor

draw::compositor_engine::Engine blender::DRWViewData::compositor

Definition at line 86 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines(), and foreach_engine().

◆ dfbl

◆ dtxl

◆ edit_select

draw::edit_select::Engine blender::DRWViewData::edit_select

Definition at line 82 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines(), and foreach_engine().

◆ eevee

eevee::Engine blender::DRWViewData::eevee

Engines running for this viewport. nullptr if not enabled.

Definition at line 75 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines().

◆ external

draw::external::Engine blender::DRWViewData::external

Definition at line 77 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines(), and foreach_engine().

◆ from_viewport

bool blender::DRWViewData::from_viewport = false

True indicates the textures inside dtxl are from the viewport and should not be freed.

Definition at line 67 of file draw_view_data.hh.

Referenced by blender::DRW_view_data_default_lists_from_viewport().

◆ grease_pencil

draw::gpencil::Engine blender::DRWViewData::grease_pencil

Definition at line 79 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines().

◆ image

image_engine::Engine blender::DRWViewData::image

Definition at line 78 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines(), and foreach_engine().

◆ manager

draw::Manager* blender::DRWViewData::manager = nullptr

New per view/viewport manager. Null if not supported by current hardware.

Definition at line 97 of file draw_view_data.hh.

Referenced by blender::DRW_manager_get(), DRWViewData(), blender::DRWContext::engines_init_and_sync(), blender::DRWContext::sync(), and ~DRWViewData().

◆ object_select

draw::select::Engine blender::DRWViewData::object_select

Definition at line 81 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines(), and foreach_engine().

◆ overlay

draw::overlay::Engine blender::DRWViewData::overlay

◆ texture_list_size

int2 blender::DRWViewData::texture_list_size = {0, 0}

Common size for texture in the engines texture list. We free all texture lists if it changes.

Definition at line 72 of file draw_view_data.hh.

Referenced by texture_list_size_validate().

◆ viewport_compositor_passes

Map<std::string, std::unique_ptr<draw::TextureFromPool> > blender::DRWViewData::viewport_compositor_passes

Stores passes needed by the viewport compositor. Engines are expected to populate those in every redraw using calls to the DRW_viewport_pass_texture_get function. The compositor can then call the same function to retrieve the passes it needs, which are expected to be initialized. Those textures are release when view data is reset.

Definition at line 94 of file draw_view_data.hh.

Referenced by blender::DRW_view_data_reset(), blender::DRW_viewport_pass_texture_exists(), and blender::DRW_viewport_pass_texture_get().

◆ workbench

workbench::Engine blender::DRWViewData::workbench

Definition at line 76 of file draw_view_data.hh.

Referenced by blender::DRWContext::enable_engines().


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