mirror of https://github.com/mosra/magnum.git
Browse Source
No redundant naming. Text::Renderer2D and Text::Renderer3D is typedef'd to old name, the typedefs are deprecated and will be removed in some future release.pull/34/head
Vladimír Vondruš
13 years ago
10 changed files with 361 additions and 324 deletions
@ -0,0 +1,281 @@
|
||||
#ifndef Magnum_Text_Renderer_h |
||||
#define Magnum_Text_Renderer_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
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. |
||||
*/ |
||||
|
||||
/** @file
|
||||
* @brief Class @ref Magnum::Text::AbstractRenderer, @ref Magnum::Text::Renderer, typedef @ref Magnum::Text::Renderer2D, @ref Magnum::Text::Renderer3D |
||||
*/ |
||||
|
||||
#include "Math/Geometry/Rectangle.h" |
||||
#include "Buffer.h" |
||||
#include "DimensionTraits.h" |
||||
#include "Mesh.h" |
||||
#include "Text/Text.h" |
||||
|
||||
#include "magnumTextVisibility.h" |
||||
|
||||
#include <string> |
||||
#include <tuple> |
||||
#include <vector> |
||||
|
||||
namespace Magnum { namespace Text { |
||||
|
||||
/**
|
||||
@brief Base for text renderers |
||||
|
||||
Not meant to be used directly, see @ref Renderer for more information. |
||||
@see @ref Renderer2D, @ref Renderer3D |
||||
*/ |
||||
class MAGNUM_TEXT_EXPORT AbstractRenderer { |
||||
public: |
||||
/**
|
||||
* @brief Render text |
||||
* @param font Font |
||||
* @param cache Glyph cache |
||||
* @param size Font size |
||||
* @param text Text to render |
||||
* |
||||
* Returns tuple with vertex positions, texture coordinates, indices |
||||
* and rectangle spanning the rendered text. |
||||
*/ |
||||
static std::tuple<std::vector<Vector2>, std::vector<Vector2>, std::vector<UnsignedInt>, Rectangle> render(AbstractFont& font, const GlyphCache& cache, Float size, const std::string& text); |
||||
|
||||
/**
|
||||
* @brief Capacity for rendered glyphs |
||||
* |
||||
* @see @ref reserve() |
||||
*/ |
||||
UnsignedInt capacity() const { return _capacity; } |
||||
|
||||
/** @brief Rectangle spanning the rendered text */ |
||||
Rectangle rectangle() const { return _rectangle; } |
||||
|
||||
/** @brief Vertex buffer */ |
||||
Buffer& vertexBuffer() { return _vertexBuffer; } |
||||
|
||||
/** @brief Index buffer */ |
||||
Buffer& indexBuffer() { return _indexBuffer; } |
||||
|
||||
/** @brief Mesh */ |
||||
Mesh& mesh() { return _mesh; } |
||||
|
||||
/**
|
||||
* @brief Reserve capacity for rendered glyphs |
||||
* |
||||
* Reallocates memory in buffers to hold @p glyphCount glyphs and |
||||
* prefills index buffer. Consider using appropriate @p vertexBufferUsage |
||||
* if the text will be changed frequently. Index buffer is changed |
||||
* only by calling this function, thus @p indexBufferUsage generally |
||||
* doesn't need to be so dynamic if the capacity won't be changed much. |
||||
* |
||||
* Initially zero capacity is reserved. |
||||
* @see @ref capacity() |
||||
*/ |
||||
void reserve(UnsignedInt glyphCount, Buffer::Usage vertexBufferUsage, Buffer::Usage indexBufferUsage); |
||||
|
||||
/**
|
||||
* @brief Render text |
||||
* |
||||
* Renders the text to vertex buffer, reusing index buffer already |
||||
* filled with @ref reserve(). Rectangle spanning the rendered text is |
||||
* available through @ref rectangle(). |
||||
* |
||||
* Initially no text is rendered. |
||||
* @attention The capacity must be large enough to contain all glyphs, |
||||
* see @ref reserve() for more information. |
||||
*/ |
||||
void render(const std::string& text); |
||||
|
||||
protected: |
||||
/**
|
||||
* @brief Constructor |
||||
* @param font Font |
||||
* @param cache Glyph cache |
||||
* @param size Font size |
||||
*/ |
||||
explicit AbstractRenderer(AbstractFont& font, const GlyphCache& cache, Float size); |
||||
AbstractRenderer(AbstractFont&, GlyphCache&&, Float) = delete; /**< @overload */ |
||||
|
||||
~AbstractRenderer(); |
||||
|
||||
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||
protected: |
||||
#else |
||||
private: |
||||
#endif |
||||
static std::tuple<Mesh, Rectangle> MAGNUM_LOCAL render(AbstractFont& font, const GlyphCache& cache, Float size, const std::string& text, Buffer& vertexBuffer, Buffer& indexBuffer, Buffer::Usage usage); |
||||
|
||||
Mesh _mesh; |
||||
Buffer _vertexBuffer, _indexBuffer; |
||||
#ifdef CORRADE_TARGET_EMSCRIPTEN |
||||
Containers::Array<UnsignedByte> _vertexBufferData, _indexBufferData; |
||||
#endif |
||||
|
||||
private: |
||||
AbstractFont& font; |
||||
const GlyphCache& cache; |
||||
Float size; |
||||
UnsignedInt _capacity; |
||||
Rectangle _rectangle; |
||||
|
||||
#if defined(MAGNUM_TARGET_GLES2) && !defined(CORRADE_TARGET_EMSCRIPTEN) |
||||
typedef void*(*BufferMapImplementation)(Buffer&, GLsizeiptr); |
||||
static MAGNUM_TEXT_LOCAL void* bufferMapImplementationFull(Buffer& buffer, GLsizeiptr length); |
||||
static MAGNUM_TEXT_LOCAL void* bufferMapImplementationSub(Buffer& buffer, GLsizeiptr length); |
||||
static MAGNUM_TEXT_LOCAL void* bufferMapImplementationRange(Buffer& buffer, GLsizeiptr length); |
||||
static BufferMapImplementation bufferMapImplementation; |
||||
#else |
||||
#ifndef CORRADE_TARGET_EMSCRIPTEN |
||||
static |
||||
#else |
||||
MAGNUM_TEXT_LOCAL |
||||
#endif |
||||
void* bufferMapImplementation(Buffer& buffer, GLsizeiptr length); |
||||
#endif |
||||
|
||||
#if defined(MAGNUM_TARGET_GLES2) && !defined(CORRADE_TARGET_EMSCRIPTEN) |
||||
typedef void(*BufferUnmapImplementation)(Buffer&); |
||||
static MAGNUM_TEXT_LOCAL void bufferUnmapImplementationDefault(Buffer& buffer); |
||||
static MAGNUM_TEXT_LOCAL void bufferUnmapImplementationSub(Buffer& buffer); |
||||
static MAGNUM_TEXT_LOCAL BufferUnmapImplementation bufferUnmapImplementation; |
||||
#else |
||||
#ifndef CORRADE_TARGET_EMSCRIPTEN |
||||
static |
||||
#else |
||||
MAGNUM_TEXT_LOCAL |
||||
#endif |
||||
void bufferUnmapImplementation(Buffer& buffer); |
||||
#endif |
||||
}; |
||||
|
||||
/**
|
||||
@brief %Text renderer |
||||
|
||||
Lays out the text into mesh using given font. Use of ligatures, kerning etc. |
||||
depends on features supported by particular font and its layouter. |
||||
|
||||
@section Renderer-usage Usage |
||||
|
||||
Immutable text (e.g. menu items, credits) can be simply rendered using static |
||||
methods, returning result either as data arrays or as fully configured mesh. |
||||
The text can be then drawn by configuring text shader, binding font texture |
||||
and drawing the mesh: |
||||
@code |
||||
Text::AbstractFont* font; |
||||
Text::GlyphCache cache; |
||||
|
||||
Shaders::VectorShader2D shader; |
||||
Buffer vertexBuffer, indexBuffer; |
||||
Mesh mesh; |
||||
|
||||
// Render the text
|
||||
Rectangle rectangle; |
||||
std::tie(mesh, rectangle) = Text::Renderer2D::render(*font, cache, 0.15f, |
||||
"Hello World!", vertexBuffer, indexBuffer, Buffer::Usage::StaticDraw); |
||||
|
||||
// Draw white text centered on the screen
|
||||
shader.setTransformationProjectionMatrix(projection*Matrix3::translation(-rectangle.width()/2.0f)) |
||||
.setColor(Color3(1.0f)); |
||||
.use(); |
||||
glyphCache->texture()->bind(Shaders::VectorShader2D::FontTextureLayer); |
||||
mesh.draw(); |
||||
@endcode |
||||
See @ref render(AbstractFont&, const GlyphCache&, Float, const std::string&) and |
||||
@ref render(AbstractFont&, const GlyphCache&, Float, const std::string&, Buffer&, Buffer&, Buffer::Usage) |
||||
for more information. |
||||
|
||||
While this method is sufficient for one-shot rendering of static texts, for |
||||
mutable texts (e.g. FPS counters, chat messages) there is another approach |
||||
that doesn't recreate everything on each text change: |
||||
@code |
||||
Text::AbstractFont* font; |
||||
Text::GlyphCache cache; |
||||
Shaders::VectorShader2D shader; |
||||
|
||||
// Initialize renderer and reserve memory for enough glyphs
|
||||
Text::Renderer2D renderer(*font, cache, 0.15f); |
||||
renderer.reserve(32, Buffer::Usage::DynamicDraw, Buffer::Usage::StaticDraw); |
||||
|
||||
// Update the text occasionally
|
||||
renderer.render("Hello World Countdown: 10"); |
||||
|
||||
// Draw the text centered on the screen
|
||||
shader.setTransformationProjectionMatrix(projection*Matrix3::translation(-renderer.rectangle().width()/2.0f)) |
||||
.setColor(Color3(1.0f)); |
||||
.use(); |
||||
glyphCache->texture()->bind(Shaders::VectorShader2D::FontTextureLayer); |
||||
renderer.mesh().draw(); |
||||
@endcode |
||||
|
||||
@section Renderer-extensions Required OpenGL functionality |
||||
|
||||
Mutable text rendering requires @extension{ARB,map_buffer_range} on desktop |
||||
OpenGL (also part of OpenGL ES 3.0). If neither @es_extension{EXT,map_buffer_range} |
||||
nor @es_extension{CHROMIUM,map_sub} is not available in ES 2.0, at least |
||||
@es_extension{OES,mapbuffer} must be supported for asynchronous buffer updates. |
||||
There is no similar extension in WebGL, thus plain (and slow) buffer updates |
||||
are used there. |
||||
|
||||
@see @ref Renderer2D, @ref Renderer3D, @ref AbstractFont, |
||||
@ref Shaders::AbstractVector |
||||
*/ |
||||
template<UnsignedInt dimensions> class MAGNUM_TEXT_EXPORT Renderer: public AbstractRenderer { |
||||
public: |
||||
/**
|
||||
* @brief Render text |
||||
* @param font Font |
||||
* @param cache Glyph cache |
||||
* @param size Font size |
||||
* @param text %Text to render |
||||
* @param vertexBuffer %Buffer where to store vertices |
||||
* @param indexBuffer %Buffer where to store indices |
||||
* @param usage Usage of vertex and index buffer |
||||
* |
||||
* Returns mesh prepared for use with @ref Shaders::AbstractVector |
||||
* subclasses and rectangle spanning the rendered text. |
||||
*/ |
||||
static std::tuple<Mesh, Rectangle> render(AbstractFont& font, const GlyphCache& cache, Float size, const std::string& text, Buffer& vertexBuffer, Buffer& indexBuffer, Buffer::Usage usage); |
||||
|
||||
/**
|
||||
* @brief Constructor |
||||
* @param font Font |
||||
* @param cache Glyph cache |
||||
* @param size Font size |
||||
*/ |
||||
explicit Renderer(AbstractFont& font, const GlyphCache& cache, Float size); |
||||
Renderer(AbstractFont&, GlyphCache&&, Float) = delete; /**< @overload */ |
||||
|
||||
using AbstractRenderer::render; |
||||
}; |
||||
|
||||
/** @brief Two-dimensional text renderer */ |
||||
typedef Renderer<2> Renderer2D; |
||||
|
||||
/** @brief Three-dimensional text renderer */ |
||||
typedef Renderer<3> Renderer3D; |
||||
|
||||
}} |
||||
|
||||
#endif |
||||
Loading…
Reference in new issue