blender::draw::overlay::Overlay Struct Reference

#include <overlay_base.hh>

Inherited by blender::draw::overlay::AntiAliasing [private], blender::draw::overlay::Armatures [private], blender::draw::overlay::AttributeTexts [private], blender::draw::overlay::AttributeViewer [private], blender::draw::overlay::Axes [private], blender::draw::overlay::Background [private], blender::draw::overlay::Bounds [private], blender::draw::overlay::Cameras [private], blender::draw::overlay::Cursor [private], blender::draw::overlay::Curves [private], blender::draw::overlay::Empties [private], blender::draw::overlay::Facing [private], blender::draw::overlay::Fade [private], blender::draw::overlay::Fluids [private], blender::draw::overlay::ForceFields [private], blender::draw::overlay::GreasePencil [private], blender::draw::overlay::Grid [private], blender::draw::overlay::ImagePrepass [private], blender::draw::overlay::Lattices [private], blender::draw::overlay::LightProbes [private], blender::draw::overlay::Lights [private], blender::draw::overlay::MeshUVs [private], blender::draw::overlay::Meshes [private], blender::draw::overlay::Metaballs [private], blender::draw::overlay::ModeTransfer [private], blender::draw::overlay::MotionPath [private], blender::draw::overlay::Names [private], blender::draw::overlay::Origins [private], blender::draw::overlay::Outline [private], blender::draw::overlay::Paints [private], blender::draw::overlay::Particles [private], blender::draw::overlay::PointClouds [private], blender::draw::overlay::Prepass [private], blender::draw::overlay::Relations [private], blender::draw::overlay::Sculpts [private], blender::draw::overlay::Speakers [private], blender::draw::overlay::Text [private], blender::draw::overlay::Wireframe [private], and blender::draw::overlay::XrayFade [private].

Public Member Functions
virtual void	begin_sync (Resources &, const State &)=0
virtual void	object_sync (Manager &, const ObjectRef &, Resources &, const State &)
virtual void	edit_object_sync (Manager &, const ObjectRef &, Resources &, const State &)
virtual void	end_sync (Resources &, const State &)
virtual void	pre_draw (Manager &, View &)
virtual void	draw_on_render (gpu::FrameBuffer *, Manager &, View &)
virtual void	draw (Framebuffer &, Manager &, View &)
virtual void	draw_line (Framebuffer &, Manager &, View &)
virtual void	draw_line_only (Framebuffer &, Manager &, View &)
virtual void	draw_color_only (Framebuffer &, Manager &, View &)
virtual void	draw_output (Framebuffer &, Manager &, View &)

Public Attributes
bool	enabled_ = false

Detailed Description

Base overlay class used for documentation.

This is not actually used as all methods should always be called from the derived class. There is still some external conditional logic and draw ordering that needs to be adjusted on a per overlay basis inside the overlay::Instance.

Definition at line 22 of file overlay_base.hh.

Member Function Documentation

begin_sync()

virtual void blender::draw::overlay::Overlay::begin_sync ( Resources & , const State &  )

pure virtual

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.

Implemented in blender::draw::overlay::AntiAliasing, blender::draw::overlay::Armatures, blender::draw::overlay::AttributeTexts, blender::draw::overlay::AttributeViewer, blender::draw::overlay::Axes, blender::draw::overlay::Background, blender::draw::overlay::Bounds, blender::draw::overlay::Cameras, blender::draw::overlay::Cursor, blender::draw::overlay::Curves, blender::draw::overlay::Empties, blender::draw::overlay::Facing, blender::draw::overlay::Fade, blender::draw::overlay::Fluids, blender::draw::overlay::ForceFields, blender::draw::overlay::GreasePencil, blender::draw::overlay::Grid, blender::draw::overlay::ImagePrepass, blender::draw::overlay::Lattices, blender::draw::overlay::LightProbes, blender::draw::overlay::Lights, blender::draw::overlay::Meshes, blender::draw::overlay::MeshUVs, blender::draw::overlay::Metaballs, blender::draw::overlay::ModeTransfer, blender::draw::overlay::MotionPath, blender::draw::overlay::Names, blender::draw::overlay::Origins, blender::draw::overlay::Outline, blender::draw::overlay::Paints, blender::draw::overlay::Particles, blender::draw::overlay::PointClouds, blender::draw::overlay::Prepass, blender::draw::overlay::Relations, blender::draw::overlay::Sculpts, blender::draw::overlay::Speakers, blender::draw::overlay::Text, blender::draw::overlay::Wireframe, and blender::draw::overlay::XrayFade.

draw()

virtual void blender::draw::overlay::Overlay::draw ( Framebuffer & , Manager & , View &  )

inlinevirtual

Reimplemented in blender::draw::overlay::Facing, blender::draw::overlay::Fade, blender::draw::overlay::MeshUVs, blender::draw::overlay::ModeTransfer, blender::draw::overlay::Paints, blender::draw::overlay::Particles, and blender::draw::overlay::Text.

Definition at line 101 of file overlay_base.hh.

Referenced by blender::draw::overlay::Meshes::edit_object_sync(), and blender::draw::overlay::Wireframe::object_sync_ex().

draw_color_only()

virtual void blender::draw::overlay::Overlay::draw_color_only ( Framebuffer & , Manager & , View &  )

inlinevirtual

Reimplemented in blender::draw::overlay::Curves, blender::draw::overlay::GreasePencil, blender::draw::overlay::Grid, blender::draw::overlay::LightProbes, blender::draw::overlay::Meshes, blender::draw::overlay::MotionPath, blender::draw::overlay::Origins, and blender::draw::overlay::XrayFade.

Definition at line 104 of file overlay_base.hh.

draw_line()

virtual void blender::draw::overlay::Overlay::draw_line ( Framebuffer & , Manager & , View &  )

inlinevirtual

Reimplemented in blender::draw::overlay::Armatures, blender::draw::overlay::AttributeViewer, blender::draw::overlay::Axes, blender::draw::overlay::Bounds, blender::draw::overlay::Cameras, blender::draw::overlay::Curves, blender::draw::overlay::Empties, blender::draw::overlay::Fluids, blender::draw::overlay::ForceFields, blender::draw::overlay::GreasePencil, blender::draw::overlay::Lattices, blender::draw::overlay::LightProbes, blender::draw::overlay::Lights, blender::draw::overlay::Meshes, blender::draw::overlay::Metaballs, blender::draw::overlay::Particles, blender::draw::overlay::PointClouds, blender::draw::overlay::Prepass, blender::draw::overlay::Relations, blender::draw::overlay::Sculpts, blender::draw::overlay::Speakers, and blender::draw::overlay::Wireframe.

Definition at line 102 of file overlay_base.hh.

draw_line_only()

virtual void blender::draw::overlay::Overlay::draw_line_only ( Framebuffer & , Manager & , View &  )

inlinevirtual

Definition at line 103 of file overlay_base.hh.

draw_on_render()

virtual void blender::draw::overlay::Overlay::draw_on_render ( gpu::FrameBuffer * , Manager & , View &  )

inlinevirtual

Drawing can be split into multiple passes. Each callback draws onto a specific frame-buffer. The order between each draw function is guaranteed. But it is not guaranteed that no other overlay will render in between. The overlay can render to a temporary frame-buffer before resolving to the given frame-buffer.

Reimplemented in blender::draw::overlay::ImagePrepass, blender::draw::overlay::MeshUVs, and blender::draw::overlay::Sculpts.

Definition at line 99 of file overlay_base.hh.

draw_output()

virtual void blender::draw::overlay::Overlay::draw_output ( Framebuffer & , Manager & , View &  )

inlinevirtual

Reimplemented in blender::draw::overlay::AntiAliasing, blender::draw::overlay::Background, and blender::draw::overlay::Cursor.

Definition at line 105 of file overlay_base.hh.

edit_object_sync()

virtual void blender::draw::overlay::Overlay::edit_object_sync ( Manager & , const ObjectRef & , Resources & , const State &  )

inlinevirtual

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

Reimplemented in blender::draw::overlay::Armatures, blender::draw::overlay::Curves, blender::draw::overlay::GreasePencil, blender::draw::overlay::Lattices, blender::draw::overlay::Meshes, blender::draw::overlay::MeshUVs, blender::draw::overlay::Metaballs, blender::draw::overlay::Particles, blender::draw::overlay::PointClouds, and blender::draw::overlay::Text.

Definition at line 74 of file overlay_base.hh.

end_sync()

virtual void blender::draw::overlay::Overlay::end_sync ( Resources & , const State &  )

inlinevirtual

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

Reimplemented in blender::draw::overlay::Armatures, blender::draw::overlay::Axes, blender::draw::overlay::Bounds, blender::draw::overlay::Cameras, blender::draw::overlay::Empties, blender::draw::overlay::Fluids, blender::draw::overlay::ForceFields, blender::draw::overlay::LightProbes, blender::draw::overlay::Lights, blender::draw::overlay::MeshUVs, blender::draw::overlay::Metaballs, blender::draw::overlay::Origins, blender::draw::overlay::Relations, blender::draw::overlay::Speakers, and blender::draw::overlay::Text.

Definition at line 83 of file overlay_base.hh.

object_sync()

virtual void blender::draw::overlay::Overlay::object_sync ( Manager & , const ObjectRef & , Resources & , const State &  )

inlinevirtual

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 in blender::draw::overlay::Armatures, blender::draw::overlay::AttributeTexts, blender::draw::overlay::AttributeViewer, blender::draw::overlay::Axes, blender::draw::overlay::Bounds, blender::draw::overlay::Cameras, blender::draw::overlay::Empties, blender::draw::overlay::Facing, blender::draw::overlay::Fade, blender::draw::overlay::Fluids, blender::draw::overlay::ForceFields, blender::draw::overlay::GreasePencil, blender::draw::overlay::Lattices, blender::draw::overlay::LightProbes, blender::draw::overlay::Lights, blender::draw::overlay::MeshUVs, blender::draw::overlay::Metaballs, blender::draw::overlay::ModeTransfer, blender::draw::overlay::MotionPath, blender::draw::overlay::Names, blender::draw::overlay::Origins, blender::draw::overlay::Outline, blender::draw::overlay::Paints, blender::draw::overlay::Particles, blender::draw::overlay::Prepass, blender::draw::overlay::Relations, blender::draw::overlay::Sculpts, and blender::draw::overlay::Speakers.

Definition at line 63 of file overlay_base.hh.

pre_draw()

virtual void blender::draw::overlay::Overlay::pre_draw ( Manager & , View &  )

inlinevirtual

Warms PassMain and PassSortable to avoid overhead of pipeline switching. Should only contains calls to generate_commands. NOTE: view is guaranteed to be the same view that will be passed to the draw functions.

Reimplemented in blender::draw::overlay::AttributeViewer, blender::draw::overlay::Cameras, blender::draw::overlay::Empties, blender::draw::overlay::Facing, blender::draw::overlay::Fade, blender::draw::overlay::Lattices, blender::draw::overlay::LightProbes, blender::draw::overlay::Outline, blender::draw::overlay::Particles, blender::draw::overlay::PointClouds, blender::draw::overlay::Prepass, and blender::draw::overlay::Wireframe.

Definition at line 90 of file overlay_base.hh.

Member Data Documentation

enabled_

bool blender::draw::overlay::Overlay::enabled_ = false

IMPORTANT: Overlays are used for every area using GPUViewport (i.e. View3D, UV Editor, Compositor ...). They are also used for depth picking and selection. This means each overlays must decide when they are active. The begin_sync method must initialize the enabled_ member depending on the context state, and every method should implement an early out cases.

Definition at line 29 of file overlay_base.hh.

Referenced by blender::draw::overlay::Armatures::begin_sync(), blender::draw::overlay::AttributeTexts::begin_sync(), blender::draw::overlay::AttributeViewer::begin_sync(), blender::draw::overlay::Axes::begin_sync(), blender::draw::overlay::Cameras::begin_sync(), blender::draw::overlay::Curves::begin_sync(), blender::draw::overlay::Empties::begin_sync(), blender::draw::overlay::Facing::begin_sync(), blender::draw::overlay::Fade::begin_sync(), blender::draw::overlay::GreasePencil::begin_sync(), blender::draw::overlay::Grid::begin_sync(), blender::draw::overlay::ImagePrepass::begin_sync(), blender::draw::overlay::Lattices::begin_sync(), blender::draw::overlay::LightProbes::begin_sync(), blender::draw::overlay::Lights::begin_sync(), blender::draw::overlay::Meshes::begin_sync(), blender::draw::overlay::MeshUVs::begin_sync(), blender::draw::overlay::ModeTransfer::begin_sync(), blender::draw::overlay::MotionPath::begin_sync(), blender::draw::overlay::Names::begin_sync(), blender::draw::overlay::Origins::begin_sync(), blender::draw::overlay::Outline::begin_sync(), blender::draw::overlay::Paints::begin_sync(), blender::draw::overlay::Particles::begin_sync(), blender::draw::overlay::PointClouds::begin_sync(), blender::draw::overlay::Prepass::begin_sync(), blender::draw::overlay::Relations::begin_sync(), blender::draw::overlay::Sculpts::begin_sync(), blender::draw::overlay::Speakers::begin_sync(), blender::draw::overlay::Text::begin_sync(), blender::draw::overlay::Wireframe::begin_sync(), blender::draw::overlay::XrayFade::begin_sync(), blender::draw::overlay::Wireframe::copy_depth(), blender::draw::overlay::Facing::draw(), blender::draw::overlay::Fade::draw(), blender::draw::overlay::MeshUVs::draw(), blender::draw::overlay::ModeTransfer::draw(), blender::draw::overlay::Paints::draw(), blender::draw::overlay::Particles::draw(), blender::draw::overlay::Text::draw(), blender::draw::overlay::Empties::draw_background_images(), blender::draw::overlay::Curves::draw_color_only(), blender::draw::overlay::GreasePencil::draw_color_only(), blender::draw::overlay::Grid::draw_color_only(), blender::draw::overlay::LightProbes::draw_color_only(), blender::draw::overlay::Meshes::draw_color_only(), blender::draw::overlay::MotionPath::draw_color_only(), blender::draw::overlay::Origins::draw_color_only(), blender::draw::overlay::XrayFade::draw_color_only(), blender::draw::overlay::Empties::draw_images(), blender::draw::overlay::Empties::draw_in_front_images(), blender::draw::overlay::Armatures::draw_line(), blender::draw::overlay::AttributeViewer::draw_line(), blender::draw::overlay::Axes::draw_line(), blender::draw::overlay::Curves::draw_line(), blender::draw::overlay::Empties::draw_line(), blender::draw::overlay::GreasePencil::draw_line(), blender::draw::overlay::Lattices::draw_line(), blender::draw::overlay::LightProbes::draw_line(), blender::draw::overlay::Lights::draw_line(), blender::draw::overlay::Meshes::draw_line(), blender::draw::overlay::Particles::draw_line(), blender::draw::overlay::PointClouds::draw_line(), blender::draw::overlay::Prepass::draw_line(), blender::draw::overlay::Relations::draw_line(), blender::draw::overlay::Sculpts::draw_line(), blender::draw::overlay::Speakers::draw_line(), blender::draw::overlay::Wireframe::draw_line(), blender::draw::overlay::Outline::draw_line_only_ex(), blender::draw::overlay::ImagePrepass::draw_on_render(), blender::draw::overlay::MeshUVs::draw_on_render(), blender::draw::overlay::Sculpts::draw_on_render(), blender::draw::overlay::Armatures::edit_object_sync(), blender::draw::overlay::Curves::edit_object_sync(), blender::draw::overlay::GreasePencil::edit_object_sync(), blender::draw::overlay::Lattices::edit_object_sync(), blender::draw::overlay::Meshes::edit_object_sync(), blender::draw::overlay::MeshUVs::edit_object_sync(), blender::draw::overlay::Particles::edit_object_sync(), blender::draw::overlay::PointClouds::edit_object_sync(), blender::draw::overlay::Text::edit_object_sync(), blender::draw::overlay::Curves::edit_object_sync_legacy(), blender::draw::overlay::Armatures::end_sync(), blender::draw::overlay::Axes::end_sync(), blender::draw::overlay::Empties::end_sync(), blender::draw::overlay::LightProbes::end_sync(), blender::draw::overlay::Lights::end_sync(), blender::draw::overlay::MeshUVs::end_sync(), blender::draw::overlay::Origins::end_sync(), blender::draw::overlay::Relations::end_sync(), blender::draw::overlay::Speakers::end_sync(), blender::draw::overlay::Text::end_sync(), blender::draw::overlay::Outline::flat_objects_pass_sync(), blender::draw::overlay::Armatures::object_sync(), blender::draw::overlay::AttributeTexts::object_sync(), blender::draw::overlay::AttributeViewer::object_sync(), blender::draw::overlay::Axes::object_sync(), blender::draw::overlay::Cameras::object_sync(), blender::draw::overlay::Empties::object_sync(), blender::draw::overlay::Facing::object_sync(), blender::draw::overlay::Fade::object_sync(), blender::draw::overlay::GreasePencil::object_sync(), blender::draw::overlay::Lattices::object_sync(), blender::draw::overlay::LightProbes::object_sync(), blender::draw::overlay::Lights::object_sync(), blender::draw::overlay::MeshUVs::object_sync(), blender::draw::overlay::ModeTransfer::object_sync(), blender::draw::overlay::MotionPath::object_sync(), blender::draw::overlay::Names::object_sync(), blender::draw::overlay::Origins::object_sync(), blender::draw::overlay::Outline::object_sync(), blender::draw::overlay::Paints::object_sync(), blender::draw::overlay::Particles::object_sync(), blender::draw::overlay::Prepass::object_sync(), blender::draw::overlay::Relations::object_sync(), blender::draw::overlay::Sculpts::object_sync(), blender::draw::overlay::Speakers::object_sync(), blender::draw::overlay::Wireframe::object_sync_ex(), blender::draw::overlay::AttributeViewer::pre_draw(), blender::draw::overlay::Empties::pre_draw(), blender::draw::overlay::Facing::pre_draw(), blender::draw::overlay::Fade::pre_draw(), blender::draw::overlay::Lattices::pre_draw(), blender::draw::overlay::LightProbes::pre_draw(), blender::draw::overlay::Outline::pre_draw(), blender::draw::overlay::Particles::pre_draw(), blender::draw::overlay::PointClouds::pre_draw(), blender::draw::overlay::Prepass::pre_draw(), and blender::draw::overlay::Wireframe::pre_draw().

---

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

• overlay_base.hh