Abstract class for layering and rendering frames.
More...
#include <gui_frame_renderer.hpp>
Abstract class for layering and rendering frames.
Definition at line 20 of file gui_frame_renderer.hpp.
◆ frame_list_iterator
◆ frame_list_type
◆ frame_renderer() [1/3]
lxgui::gui::frame_renderer::frame_renderer |
( |
| ) |
|
◆ ~frame_renderer()
virtual lxgui::gui::frame_renderer::~frame_renderer |
( |
| ) |
|
|
virtualdefault |
◆ frame_renderer() [2/3]
◆ frame_renderer() [3/3]
◆ clear_strata_list_()
void lxgui::gui::frame_renderer::clear_strata_list_ |
( |
| ) |
|
|
protected |
◆ find_topmost_frame() [1/2]
utils::observer_ptr< frame > lxgui::gui::frame_renderer::find_topmost_frame |
( |
const std::function< bool(const frame &)> & |
predicate | ) |
|
|
inline |
Find the top-most frame matching the provided predicate.
- Parameters
-
predicate | A function returning 'true' if the frame can be selected |
- Returns
- The topmost frame, or nullptr if none
Definition at line 82 of file gui_frame_renderer.hpp.
◆ find_topmost_frame() [2/2]
utils::observer_ptr< const frame > lxgui::gui::frame_renderer::find_topmost_frame |
( |
const std::function< bool(const frame &)> & |
predicate | ) |
const |
Find the top-most frame matching the provided predicate.
- Parameters
-
predicate | A function returning 'true' if the frame can be selected |
- Returns
- The topmost frame, or nullptr if none
Definition at line 149 of file gui_frame_renderer.cpp.
◆ get_highest_level()
int lxgui::gui::frame_renderer::get_highest_level |
( |
strata |
strata_id | ) |
const |
Returns the highest level on the provided strata.
- Parameters
-
strata_id | The strata to inspect |
- Returns
- The highest level on the provided strata
Definition at line 161 of file gui_frame_renderer.cpp.
◆ get_strata_range_()
std::pair< std::size_t, std::size_t > lxgui::gui::frame_renderer::get_strata_range_ |
( |
strata |
strata_id | ) |
const |
|
protected |
◆ get_target_dimensions()
virtual vector2f lxgui::gui::frame_renderer::get_target_dimensions |
( |
| ) |
const |
|
pure virtual |
◆ has_strata_list_changed_()
bool lxgui::gui::frame_renderer::has_strata_list_changed_ |
( |
| ) |
const |
|
protected |
◆ notify_level_changed()
void lxgui::gui::frame_renderer::notify_level_changed |
( |
const utils::observer_ptr< frame > & |
obj, |
|
|
int |
old_level, |
|
|
int |
new_level |
|
) |
| |
|
virtual |
Tells this renderer that a frame has changed level.
- Parameters
-
obj | The frame which has changed |
old_level | The old frame level |
new_level | The new frame level |
Definition at line 132 of file gui_frame_renderer.cpp.
◆ notify_rendered_frame()
void lxgui::gui::frame_renderer::notify_rendered_frame |
( |
const utils::observer_ptr< frame > & |
obj, |
|
|
bool |
rendered |
|
) |
| |
|
virtual |
Tells this renderer that it should (or not) render another frame.
- Parameters
-
obj | The frame to render |
rendered | 'true' if this renderer needs to render that new object |
Definition at line 82 of file gui_frame_renderer.cpp.
◆ notify_strata_changed()
void lxgui::gui::frame_renderer::notify_strata_changed |
( |
const utils::observer_ptr< frame > & |
obj, |
|
|
strata |
old_strata_id, |
|
|
strata |
new_strata_id |
|
) |
| |
|
virtual |
Tells this renderer that a frame has changed strata.
- Parameters
-
obj | The frame which has changed |
old_strata_id | The old frame strata |
new_strata_id | The new frame strata |
Definition at line 110 of file gui_frame_renderer.cpp.
◆ notify_strata_needs_redraw()
void lxgui::gui::frame_renderer::notify_strata_needs_redraw |
( |
strata |
strata_id | ) |
|
|
virtual |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ render_strata_()
void lxgui::gui::frame_renderer::render_strata_ |
( |
const strata_data & |
strata_obj | ) |
const |
|
protected |
◆ reset_strata_list_changed_flag_()
void lxgui::gui::frame_renderer::reset_strata_list_changed_flag_ |
( |
| ) |
|
|
protected |
◆ frame_list_updated_
bool lxgui::gui::frame_renderer::frame_list_updated_ = false |
|
protected |
◆ num_strata
constexpr std::size_t lxgui::gui::frame_renderer::num_strata = magic_enum::enum_count<strata>() |
|
staticconstexprprotected |
◆ sorted_frame_list_
◆ strata_list_
The documentation for this class was generated from the following files: