summaryrefslogtreecommitdiff
path: root/indra/llrender/llfontvertexbuffer.h
blob: 94b833d22753c3556ea80970d8408a3985e76522 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/**
 * @file llfontgl.h
 * @author Andrii Kleshchev
 * @brief Buffer storage for font rendering.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLFONTVERTEXBUFFER_H
#define LL_LLFONTVERTEXBUFFER_H

#include "llfontgl.h"

class LLVertexBufferData;

// Rendering fonts is expensive, this class is intended to store
// vertex buffers for rendered text, so that they can be reused.
// LLFontVertexBuffer tracks font and rendering parameters, but
// expects caller to track text changes and call reset() when
// text changes.
class LLFontVertexBuffer
{
public:
    LLFontVertexBuffer();
    ~LLFontVertexBuffer();

    void reset();

    S32 render(const LLFontGL* fontp,
        const LLWString& text,
        S32 begin_offset,
        LLRect rect,
        const LLColor4& color,
        LLFontGL::HAlign halign = LLFontGL::LEFT, LLFontGL::VAlign valign = LLFontGL::BASELINE,
        U8 style = LLFontGL::NORMAL,
        LLFontGL::ShadowType shadow = LLFontGL::NO_SHADOW,
        S32 max_chars = S32_MAX, S32 max_pixels = S32_MAX,
        F32* right_x = NULL,
        bool use_ellipses = false,
        bool use_color = true);

    S32 render(const LLFontGL* fontp,
        const LLWString& text,
        S32 begin_offset,
        LLRectf rect,
        const LLColor4& color,
        LLFontGL::HAlign halign = LLFontGL::LEFT, LLFontGL::VAlign valign = LLFontGL::BASELINE,
        U8 style = LLFontGL::NORMAL,
        LLFontGL::ShadowType shadow = LLFontGL::NO_SHADOW,
        S32 max_chars = S32_MAX,
        F32* right_x = NULL,
        bool use_ellipses = false,
        bool use_color = true);

    S32 render(const LLFontGL* fontp,
        const LLWString& text,
        S32 begin_offset,
        F32 x, F32 y,
        const LLColor4& color,
        LLFontGL::HAlign halign = LLFontGL::LEFT, LLFontGL::VAlign valign = LLFontGL::BASELINE,
        U8 style = LLFontGL::NORMAL,
        LLFontGL::ShadowType shadow = LLFontGL::NO_SHADOW,
        S32 max_chars = S32_MAX, S32 max_pixels = S32_MAX,
        F32* right_x = NULL,
        bool use_ellipses = false,
        bool use_color = true);

    static void enableBufferCollection(bool enable) { sEnableBufferCollection = enable; }
private:

    void genBuffers(const LLFontGL* fontp,
         const LLWString& text,
         S32 begin_offset,
         F32 x, F32 y,
         const LLColor4& color,
         LLFontGL::HAlign halign, LLFontGL::VAlign valign,
         U8 style,
        LLFontGL::ShadowType shadow,
         S32 max_chars, S32 max_pixels,
         F32* right_x,
         bool use_ellipses,
         bool use_color);

    void renderBuffers();

    std::list<LLVertexBufferData> mBufferList;
    S32 mChars = 0;
    const LLFontGL *mLastFont = nullptr;
    S32 mLastOffset = 0;
    S32 mLastMaxChars = 0;
    S32 mLastMaxPixels = 0;
    F32 mLastX = 0.f;
    F32 mLastY = 0.f;
    LLColor4 mLastColor;
    LLFontGL::HAlign mLastHalign = LLFontGL::LEFT;
    LLFontGL::VAlign mLastValign = LLFontGL::BASELINE;
    U8 mLastStyle = LLFontGL::NORMAL;
    LLFontGL::ShadowType mLastShadow = LLFontGL::NO_SHADOW;
    F32 mLastRightX = 0.f;

    // LLFontGL's statics
    F32 mLastScaleX = 1.f;
    F32 mLastScaleY = 1.f;
    F32 mLastVertDPI = 0.f;
    F32 mLastHorizDPI = 0.f;
    S32 mLastResGeneration = 0;
    LLCoordGL mLastOrigin;

    // Adding new characters to bitmap cache can alter value from getBitmapWidth();
    // which alters whole string. So rerender when new characters were added to cache.
    S32 mLastFontCacheGen = 0;

    static bool sEnableBufferCollection;
};

// Extracting width from a font is expensive, and due to
// mechanics of font rendering, we need width separately
// and usually before rendering.
// LLFontWidthBuffer tracks font and rendering parameters,
// but expects caller to track text changes and call reset()
// when text changes.
class LLFontWidthBuffer
{
public:
    LLFontWidthBuffer();
    ~LLFontWidthBuffer();

    void reset();

    F32 getWidth(const LLFontGL* fontp,
        const llwchar* wchars,
        S32 begin_offset,
        S32 max_chars,
        bool no_padding);

    static void enableBufferCollection(bool enable) { sEnableBufferCollection = enable; }
private:
        const LLFontGL* mLastFont = nullptr;
        S32 mLastOffset = 0;
        S32 mLastMaxChars = 0;
        bool mLastNoPadding = false;
        F32 mWidth = -1.f;

        // LLFontGL's values that affect width calculation
        F32 mLastScaleX = 1.f;
        F32 mLastScaleY = 1.f;
        F32 mLastVertDPI = 0.f;
        F32 mLastHorizDPI = 0.f;
        S32 mLastResGeneration = 0;

        // Cache generation tracking
        S32 mLastFontCacheGen = 0;

        static bool sEnableBufferCollection;
};

#endif