ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11487 Commits
21 Branches
19 Tags
70 MiB
Tree: b02cab2f32
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b02cab2f32'
${ noResults }
magnum/src/Magnum/Text/Text.h

87 lines
2.8 KiB
Raw Normal View History Unescape

Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
#ifndef Magnum_Text_Text_h
#define Magnum_Text_Text_h
/*
This file is part of Magnum.
Updated copyright year.
6 years ago
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
Here we go again.
1 year ago
2020, 2021, 2022, 2023, 2024, 2025
It's October already?!
2 years ago
Vladimír Vondruš <mosra@centrum.cz>
Relicensing to MIT/Expat license, part 2: headers.
13 years ago
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
*/
/** @file
Text: adapted to the new documentation theme.
8 years ago
* @brief Forward declarations for the @ref Magnum::Text namespace
Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
*/
Making includes absolute, part 5: absolute includes everywhere. The only places where they aren't absolute are: - when header is included from corresponding source file - when including headers which are not part of final installation (e.g. test-specific configuration, headers from Implementation/)
12 years ago
#include "Magnum/Types.h"
Text: renamed {DistanceField,}GlyphCache to {DistanceField}GlyphCacheGL. Like with TextureTools::DistanceField, to make room for non-GL implementations. Old names are deprecated aliases, same for headers. The only remaining bit in the Text library is the Renderer class, but for that one I first need to invent a non-shitty API so I can just deprecate the old thing as a whole and create something reasonable from scratch in RendererGL.
2 years ago
#ifdef MAGNUM_BUILD_DEPRECATED
#include <Corrade/Utility/Macros.h>
#endif
Text: split out HarfBuzz layouting into new HarfBuzzFont class. It now allows to transparently select between FreeType and HarfBuzz layouting. The new class is built only if USE_HARFBUZZ is enabled.
13 years ago
Exclude namespaces from forward declaration header docs. They don't document anything, so there's no point in listing them.
2 years ago
#ifndef DOXYGEN_GENERATING_OUTPUT
Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
namespace Magnum { namespace Text {
Text: abstract base for fonts and layouters. Font and text layouting is now abstracted out from its implementation. Font class is renamed to FreeTypeFont and all the work can be done through AbstractFont and AbstractLayouter interface.
13 years ago
class AbstractFont;
Text: interface for font converters. Provides a way to convert font into different format (either with or without contents of associated glyph cache) or import/export glyph cache (i.e. to avoid recreating it from scratch every time).
13 years ago
class AbstractFontConverter;
Text: API-independent base for glyph caches. Allows the Font and FontConverter plugins be built without TARGET_GL enabled. That was the last piece missing for making the magnum-plugins repo completely GL-free.
7 years ago
class AbstractGlyphCache;
Text: abstract base for fonts and layouters. Font and text layouting is now abstracted out from its implementation. Font class is renamed to FreeTypeFont and all the work can be done through AbstractFont and AbstractLayouter interface.
13 years ago
class AbstractLayouter;
Text: new AbstractShaper interface for shaping. Replaces the previous, grossly inefficient AbstractLayouter which was performing one virtual call per glyph (!). It's now also reusable, meaning it doesn't need to be allocated anew for every new shaped text, and it no longer requires each and every font plugin to implement the same redundant glyph data fetching from the glyph cache, scaling etc. -- all that is meant to be done by the users of AbstractShaper, i.e. Renderer. The independency on a glyph cache theorerically also means it can be used for a completely different, non-texture-based way to render text (such as direct path drawing directly on the GPU), although I won't be exploring that path now. It also exposes an interface for specifying script, language, direction and typographic features. Such interface will be currently only implemented in HarfBuzz, but that's the intent -- to provide a flexible enough interface to support all possible use cases that a font or a font plugin may support, instead of exposing a least common denominator and then having no easy way to shape a text in a non-Latin script or use a fancy OpenType feature the chosen font has. The old public interface is preserved for backwards compatibility, marked as deprecated, however the virtual APIs are not, as supporting that would be too nasty. I don't think any user code ever implemented a font plugin so this should be okay. To ensure smooth transition with no regressions, the Renderer class and MagnumFont tests still use the old API in this commit, and their test pass the same way as they did before (except for two removed MagnumFont test cases which tested errors that are now an assertion in the deprecated layout() API and thus cannot be tested from the plugin anymore). Porting them away from the deprecated API will be done in separate commits.
3 years ago
class AbstractShaper;
Text: abstract base for fonts and layouters. Font and text layouting is now abstracted out from its implementation. Font class is renamed to FreeTypeFont and all the work can be done through AbstractFont and AbstractLayouter interface.
13 years ago
Text: support for aligning rendered text.
13 years ago
enum class Alignment: UnsignedByte;
Text: rename Direction to ShapeDirection, move to a dedicated header. Because there's going to be LayoutDirection as well, for controlling how line progression happens. Because nothing in text rendering is simple.
3 years ago
enum class ShapeDirection: UnsignedByte;
Text: add a LayoutDirection enum. To be used as a placeholder argument in the reworked renderer APIs. No intention to deal with the complexities of this right now, just taking it to not have to deprecate & replace the API when this feature actually gets implemented.
3 years ago
enum class LayoutDirection: UnsignedByte;
Text: support for aligning rendered text.
13 years ago
Text: API-independent base for glyph caches. Allows the Font and FontConverter plugins be built without TARGET_GL enabled. That was the last piece missing for making the magnum-plugins repo completely GL-free.
7 years ago
class AbstractGlyphCache;
Text: added a Script enum. Will be used for the upcoming new AbstractShaper API. It's based on the ISO script codes, matching the HarfBuzz script enum, with the intention of being passed to it as-is.
3 years ago
Text: added a Feature enum. Like the Script enum, to be used for the new AbstractShaper API.
3 years ago
enum class Feature: UnsignedInt;
Text: added a Script enum. Will be used for the upcoming new AbstractShaper API. It's based on the ISO script codes, matching the HarfBuzz script enum, with the intention of being passed to it as-is.
3 years ago
enum class Script: UnsignedInt;
Text: forward-declare FeatureRange.
3 years ago
class FeatureRange;
Text: new RendererCore class. A higher-level stateful wrapper around the low-level utilities, capable of rendering text formed from multiple lines and multiple fonts. Will be used as a backend for a new Renderer / RendererGL implementation. No usage docs yet, those will come once the other two classes are made as well.
2 years ago
class RendererCore;
Text: new Renderer class. Builds upon RendererCore and generates index and vertex data from the glyph positions and IDs. Documentation again coming later once everything is in, next is a RendererGL which populates a GL::Mesh with these.
1 year ago
class Renderer;
Text: new RendererCore class. A higher-level stateful wrapper around the low-level utilities, capable of rendering text formed from multiple lines and multiple fonts. Will be used as a backend for a new Renderer / RendererGL implementation. No usage docs yet, those will come once the other two classes are made as well.
2 years ago
Text: API-independent base for glyph caches. Allows the Font and FontConverter plugins be built without TARGET_GL enabled. That was the last piece missing for making the magnum-plugins repo completely GL-free.
7 years ago
#ifdef MAGNUM_TARGET_GL
Text: renamed {DistanceField,}GlyphCache to {DistanceField}GlyphCacheGL. Like with TextureTools::DistanceField, to make room for non-GL implementations. Old names are deprecated aliases, same for headers. The only remaining bit in the Text library is the Renderer class, but for that one I first need to invent a non-shitty API so I can just deprecate the old thing as a whole and create something reasonable from scratch in RendererGL.
2 years ago
class DistanceFieldGlyphCacheGL;
class GlyphCacheGL;
#ifdef MAGNUM_BUILD_DEPRECATED
typedef CORRADE_DEPRECATED("use DistanceFieldGlyphCacheGL instead") DistanceFieldGlyphCacheGL DistanceFieldGlyphCache;
typedef CORRADE_DEPRECATED("use GlyphCacheGL instead") GlyphCacheGL GlyphCache;
#endif
Text: add a GlyphCacheArrayGL. So far the Renderer doesn't work with that, and neither the builtin Vector shaders are be able use it, but gotta start somewhere. I wanted to have the texture contents tested on ES, but it turns out that implementing DebugTools::textureSubImage() for arrays is blocked on another feature I badly need to finish first. Sigh.
1 year ago
#ifndef MAGNUM_TARGET_GLES2
Text: new DistanceFieldGlyphCacheArrayGL class. Counterpart to GlyphCacheArrayGL. At first I expected that it'd need TextureTools::DistanceFieldGL to be expanded with texture array support but after enough massaging of brain matter I realized that not really, since the procesing has to be done slice by slice anyway, and having to upload the whole array just to have a temporary input for processing would be a waste of memory.
1 year ago
class DistanceFieldGlyphCacheArrayGL;
Text: add a GlyphCacheArrayGL. So far the Renderer doesn't work with that, and neither the builtin Vector shaders are be able use it, but gotta start somewhere. I wanted to have the texture contents tested on ES, but it turns out that implementing DebugTools::textureSubImage() for arrays is blocked on another feature I badly need to finish first. Sigh.
1 year ago
class GlyphCacheArrayGL;
#endif
Text: new RendererGL class. This is a replacement for the existing AbstractRenderer and Renderer2D / Renderer3D classes, with no STL or other shittiness like excessive allocations, and with a much better feature set. Deprecation of the old APIs is going to happen next. Compared to the old implementation it doesn't make use of the complicated buffer mapping because -- unlike in 2012 -- such behavior was since deemed questionable as the driver (or whichever translation layer like ANGLE or Zink or Apple's GL-over-Metal) may still make a copy anyway and doing so prevents buffer orphaning. So it's right now just plain setData() / setSubData() calls. *If* it becomes some sort of a bottleneck (which I doubt), I may reconsider, or add something else like double buffering.
1 year ago
class RendererGL;
Text: redo the old Renderer*D using new APIs and deprecate it. The tests all pass exactly as they did before, apart from slightly different assertion messages. I moved the guts from Renderer.cpp to RendererGL.cpp as the code relies on both GL and STL, to not have it spread over too many places.
1 year ago
#ifdef MAGNUM_BUILD_DEPRECATED
class CORRADE_DEPRECATED("use Renderer or RendererGL instead") AbstractRenderer;
CORRADE_IGNORE_DEPRECATED_PUSH /* idiotic MSVC warns for deprecated APIs using deprecated APIs */
typedef CORRADE_DEPRECATED("use Renderer or RendererGL instead") AbstractRenderer Renderer2D;
typedef CORRADE_DEPRECATED("use Renderer or RendererGL instead") AbstractRenderer Renderer3D;
CORRADE_IGNORE_DEPRECATED_POP
#endif
Hide forward declarations from Doxygen. Forward declarations of templated types don't have named template parameters and thus Doxygen (sometimes) used these for documentation. It then looked like this: Magnum::Math::RectangularMatrix<std::size_t, std::size_t, class> which isn't helpful at all. After the change it looks like this (much better): Magnum::Math::RectangularMatrix<cols, rows, T>
12 years ago
#endif
Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
}}
Exclude namespaces from forward declaration header docs. They don't document anything, so there's no point in listing them.
2 years ago
#endif
Text: initial implementation of font and text rendering. The library uses FreeType for glyph pre-rendering and basic glyph geometry and HarfBuzz for text layouting (i.e. ligatures, kerning, ...). Currently all used glyphs must be prerendered into texture atlas, other glyphs are simply not rendered (although the layouting code handles them like if they are there). Text rendering supports UTF-8, although glyph pre-rendering is currently ASCII only, as I couldn't find any working implementation of Unicode STL function in recent GCC versions. Will be fixed later.
14 years ago
#endif