Blender V5.0
blender::draw::overlay::Speakers Class Reference

#include <overlay_speaker.hh>

Inherits blender::draw::overlay::Overlay.

Public Member Functions

 Speakers (const SelectionType selection_type)
void begin_sync (Resources &, const State &state) final
void object_sync (Manager &, const ObjectRef &ob_ref, Resources &res, const State &state) final
void end_sync (Resources &res, const State &state) final
void draw_line (Framebuffer &framebuffer, Manager &manager, View &view) final

Detailed Description

Display speaker objects.

Definition at line 20 of file overlay_speaker.hh.

Constructor & Destructor Documentation

◆ Speakers()

blender::draw::overlay::Speakers::Speakers ( const SelectionType selection_type)
inline

Definition at line 31 of file overlay_speaker.hh.

Member Function Documentation

◆ begin_sync()

void blender::draw::overlay::Speakers::begin_sync ( Resources & ,
const State &  )
inlinefinalvirtual

Synchronization creates and fill render passes based on context state and scene state.

It runs for every scene update, so keep computation overhead low. If it is triggered, everything in the scene is considered updated. Note that this only concerns the render passes, the mesh batch caches are updated on a per object-data basis.

IMPORTANT: Synchronization must be view agnostic. That is, not rely on view position, projection matrix or frame-buffer size to do conditional pass creation. This is because, by design, syncing can happen once and rendered multiple time (multi view rendering, stereo rendering, orbiting view ...). Conditional pass creation, must be done in the drawing callbacks, but they should remain the exception. Also there will be no access to object data at this point. Creates passes used for object sync and enabling / disabling internal overlay types (e.g. vertices, edges, faces in edit mode). Runs once at the start of the sync cycle. Should also contain passes setup for overlays that are not per object overlays (e.g. Grid).

This method must be implemented.

Implements blender::draw::overlay::Overlay.

Definition at line 33 of file overlay_speaker.hh.

References blender::draw::overlay::Overlay::enabled_, and state.

◆ draw_line()

void blender::draw::overlay::Speakers::draw_line ( Framebuffer & framebuffer,
Manager & manager,
View & view )
inlinefinalvirtual

◆ end_sync()

void blender::draw::overlay::Speakers::end_sync ( Resources & ,
const State &  )
inlinefinalvirtual

Finalize passes or buffers used for object sync. Runs once at the start of the sync cycle.

Reimplemented from blender::draw::overlay::Overlay.

Definition at line 59 of file overlay_speaker.hh.

References DRW_CLIPPING_UBO_SLOT, DRW_STATE_DEPTH_LESS_EQUAL, DRW_STATE_WRITE_COLOR, DRW_STATE_WRITE_DEPTH, blender::draw::overlay::Overlay::enabled_, OVERLAY_GLOBALS_SLOT, and state.

◆ object_sync()

void blender::draw::overlay::Speakers::object_sync ( Manager & ,
const ObjectRef & ,
Resources & ,
const State &  )
inlinefinalvirtual

Fills passes or buffers for each object. Runs for each individual object state. IMPORTANT: Can run only once for instances using the same state (ObjectRef might contains instancing data).

Reimplemented from blender::draw::overlay::Overlay.

Definition at line 44 of file overlay_speaker.hh.

References blender::draw::overlay::Overlay::enabled_, and state.

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


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