Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GuiAdvancedScrollText] Improve performance #1946

Closed
wants to merge 5 commits into from
+50 −31
Closed

[GuiAdvancedScrollText] Improve performance #1946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a833638
[GuiAdvancedScrollText] Move prefix width calculation to addEntry
oznogon Mar 18, 2023
c91c2b8
[GuiAdvancedScrollText] Disregard text that would be drawn below rect
oznogon Mar 18, 2023
0eb713e
[GuiAdvancedScrollText] Use unsigned ints for indexes
oznogon Mar 18, 2023
c4c0dfa
[GuiAdvancedScrollText] Move font prep from onDraw to addEntry
oznogon Mar 18, 2023
5cfbe98
[GuiAdvancedScrollText] Re-prep fonts when window width changes
oznogon Mar 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 44 additions & 29 deletions src/gui/gui2_advancedscrolltext.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
#include "gui2_advancedscrolltext.h"

GuiAdvancedScrollText::GuiAdvancedScrollText(GuiContainer* owner, string id)
: GuiElement(owner, id), text_size(30)
: GuiElement(owner, id), text_size(30.0f), rect_width(rect.size.x), max_prefix_width(0.0f)
{
scrollbar = new GuiScrollbar(this, id + "_SCROLL", 0, 1, 0, nullptr);
scrollbar->setPosition(0, 0, sp::Alignment::TopRight)->setSize(50, GuiElement::GuiSizeMax);
}

GuiAdvancedScrollText* GuiAdvancedScrollText::addEntry(string prefix, string text, glm::u8vec4 color)
{
entries.emplace_back();
entries.back().prefix = prefix;
entries.back().text = text;
entries.back().color = color;
Entry& entry = entries.emplace_back();
entry.prefix = prefix;
entry.prepared_prefix = sp::RenderTarget::getDefaultFont()->prepare(prefix, 32, text_size, rect.size, sp::Alignment::TopLeft);
max_prefix_width = std::max(max_prefix_width, entry.prepared_prefix.getUsedAreaSize().x);
entry.text = text;
entry.prepared_text = sp::RenderTarget::getDefaultFont()->prepare(text, 32, text_size, {rect.size.x - max_prefix_width - 50.0f, rect.size.y}, sp::Alignment::TopLeft, sp::Font::FlagLineWrap | sp::Font::FlagClip);
entry.color = color;
// For each entry, fix the maximum prefix width, so we know how much space we have for the text.
return this;
}

Expand All @@ -21,16 +25,16 @@ unsigned int GuiAdvancedScrollText::getEntryCount() const
return entries.size();
}

string GuiAdvancedScrollText::getEntryText(int index) const
string GuiAdvancedScrollText::getEntryText(unsigned int index) const
{
if (index < 0 || index >= int(getEntryCount()))
if (index >= getEntryCount())
return "";
return entries[index].text;
}

GuiAdvancedScrollText* GuiAdvancedScrollText::removeEntry(int index)
GuiAdvancedScrollText* GuiAdvancedScrollText::removeEntry(unsigned int index)
{
if (index < 0 || index > int(getEntryCount()))
if (index > getEntryCount())
return this;
entries.erase(entries.begin() + index);
return this;
Expand All @@ -44,40 +48,51 @@ GuiAdvancedScrollText* GuiAdvancedScrollText::clearEntries()

void GuiAdvancedScrollText::onDraw(sp::RenderTarget& renderer)
{
//For all the entries, fix the maximum prefix width, so we know how much space we have for the text.
float max_prefix_width = 0.0f;
for(Entry& e : entries)
{
auto prepared = sp::RenderTarget::getDefaultFont()->prepare(e.prefix, 32, text_size, {0, 0}, sp::Alignment::TopLeft, 0);
max_prefix_width = std::max(max_prefix_width, prepared.getUsedAreaSize().x);
}
const bool is_resized = rect_width != rect.size.x;
if (is_resized) { rect_width = rect.size.x; }

//Draw the visible entries
float draw_offset = -scrollbar->getValue();
float draw_offset = -scrollbar->getValue() + text_size + 12.0f;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bad kludge to realign text now that the positioning lives in the Entry rather than recalculated each onDraw.


for(Entry& e : entries)
{
auto prepared_prefix = sp::RenderTarget::getDefaultFont()->prepare(e.prefix, 32, text_size, rect.size, sp::Alignment::TopLeft);
auto prepared_text = sp::RenderTarget::getDefaultFont()->prepare(e.text, 32, text_size, {rect.size.x - max_prefix_width - 50, rect.size.y}, sp::Alignment::TopLeft, sp::Font::FlagLineWrap | sp::Font::FlagClip);
auto height = prepared_text.getUsedAreaSize().y;
if (draw_offset + height > 0)
if (is_resized)
{
// Window width has changed. Re-prep fonts.
e.prepared_prefix = sp::RenderTarget::getDefaultFont()->prepare(e.prefix, 32, text_size, rect.size, sp::Alignment::TopLeft);
max_prefix_width = std::max(max_prefix_width, e.prepared_prefix.getUsedAreaSize().x);
e.prepared_text = sp::RenderTarget::getDefaultFont()->prepare(e.text, 32, text_size, {rect.size.x - max_prefix_width - 50.0f, rect.size.y}, sp::Alignment::TopLeft, sp::Font::FlagLineWrap | sp::Font::FlagClip);
}

const float height = e.prepared_text.getUsedAreaSize().y;

if (draw_offset + height > 0
&& draw_offset < rect.size.y)
{
for(auto& g : prepared_prefix.data)
g.position.y += draw_offset;
for(auto& g : prepared_text.data)
g.position.y += draw_offset;
renderer.drawText(rect, prepared_prefix, text_size, {255, 255, 255, 255}, sp::Font::FlagClip);
renderer.drawText(sp::Rect(rect.position.x + max_prefix_width, rect.position.y, rect.size.x - 50 - max_prefix_width, rect.size.y), prepared_text, text_size, e.color, sp::Font::FlagClip);
const float y_start = e.prepared_prefix.data[0].position.y;

for(auto& g : e.prepared_prefix.data)
{
g.position.y = draw_offset;
}
for(auto& g : e.prepared_text.data)
{
g.position.y = (g.position.y - y_start) + draw_offset;
}
renderer.drawText(rect, e.prepared_prefix, text_size, {255, 255, 255, 255}, sp::Font::FlagClip);
renderer.drawText(sp::Rect(rect.position.x + max_prefix_width, rect.position.y, rect.size.x - 50 - max_prefix_width, rect.size.y), e.prepared_text, text_size, e.color, sp::Font::FlagClip);
}

draw_offset += height;
}

//Calculate how many lines we have to display in total.
int line_count = draw_offset + scrollbar->getValue();
const int line_count = draw_offset + scrollbar->getValue();

//Check if we need to update the scroll bar.
if (scrollbar->getMax() != line_count)
{
int diff = line_count - scrollbar->getMax();
const int diff = line_count - scrollbar->getMax();
scrollbar->setRange(0, line_count);
scrollbar->setValueSize(rect.size.y);
if (auto_scroll_down)
Expand Down
8 changes: 6 additions & 2 deletions src/gui/gui2_advancedscrolltext.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,17 @@ class GuiAdvancedScrollText : public GuiElement
{
public:
string prefix;
sp::Font::PreparedFontString prepared_prefix;
string text;
sp::Font::PreparedFontString prepared_text;
glm::u8vec4 color;
};

std::vector<Entry> entries;
GuiScrollbar* scrollbar;
float text_size;
float rect_width;
float max_prefix_width;
bool auto_scroll_down;
public:
GuiAdvancedScrollText(GuiContainer* owner, string id);
Expand All @@ -29,8 +33,8 @@ class GuiAdvancedScrollText : public GuiElement
GuiAdvancedScrollText* setTextSize(float text_size) { this->text_size = text_size; return this; }

unsigned int getEntryCount() const;
string getEntryText(int index) const;
GuiAdvancedScrollText* removeEntry(int index);
string getEntryText(unsigned int index) const;
GuiAdvancedScrollText* removeEntry(unsigned int index);
GuiAdvancedScrollText* clearEntries();

virtual void onDraw(sp::RenderTarget& renderer) override;
Expand Down