Browse Source

Text: completed documentation review.

Added missing documentation and license header to deprecated header.
pull/54/merge
Vladimír Vondruš 12 years ago
parent
commit
834f1a0346
  1. 17
      src/Magnum/Text/AbstractFont.h
  2. 2
      src/Magnum/Text/AbstractFontConverter.h
  3. 28
      src/Magnum/Text/Alignment.h
  4. 10
      src/Magnum/Text/Renderer.h
  5. 2
      src/Magnum/Text/Text.h
  6. 29
      src/Magnum/Text/TextRenderer.h

17
src/Magnum/Text/AbstractFont.h

@ -311,14 +311,21 @@ implements @ref doRenderGlyph(). Bounds checking on @p i is done automatically
in the wrapping @ref renderGlyph() function.
*/
class MAGNUM_TEXT_EXPORT AbstractLayouter {
AbstractLayouter(const AbstractLayouter&) = delete;
AbstractLayouter(AbstractLayouter&&) = delete;
AbstractLayouter& operator=(const AbstractLayouter&) = delete;
AbstractLayouter& operator=(const AbstractLayouter&&) = delete;
public:
/** @brief Copying is not allowed */
AbstractLayouter(const AbstractLayouter&) = delete;
/** @brief Moving is not allowed */
AbstractLayouter(AbstractLayouter&&) = delete;
~AbstractLayouter();
/** @brief Copying is not allowed */
AbstractLayouter& operator=(const AbstractLayouter&) = delete;
/** @brief Moving is not allowed */
AbstractLayouter& operator=(const AbstractLayouter&&) = delete;
/** @brief Count of glyphs in laid out text */
UnsignedInt glyphCount() const { return _glyphCount; }

2
src/Magnum/Text/AbstractFontConverter.h

@ -115,7 +115,7 @@ class MAGNUM_TEXT_EXPORT AbstractFontConverter: public PluginManager::AbstractPl
/**
* @brief Features supported by this converter
*
* @see features()
* @see @ref features()
*/
typedef Containers::EnumSet<Feature, UnsignedByte> Features;

28
src/Magnum/Text/Alignment.h

@ -50,77 +50,77 @@ namespace Implementation {
}
/**
@brief Text rendering alignment
@brief %Text rendering alignment
@see @ref Renderer::render(), @ref Renderer::Renderer()
*/
enum class Alignment: UnsignedByte {
/** Text start and line is at origin */
/** %Text start and line is at origin */
LineLeft = Implementation::AlignmentLine|Implementation::AlignmentLeft,
/**
* Text center and line is at origin
* %Text center and line is at origin
*
* @see @ref Alignment::LineCenterIntegral
*/
LineCenter = Implementation::AlignmentLine|Implementation::AlignmentCenter,
/** Text end and line is at origin */
/** %Text end and line is at origin */
LineRight = Implementation::AlignmentLine|Implementation::AlignmentRight,
/**
* Text start and vertical middle is at origin
* %Text start and vertical middle is at origin
*
* @see @ref Alignment::MiddleLeftIntegral
*/
MiddleLeft = Implementation::AlignmentMiddle|Implementation::AlignmentLeft,
/**
* Text center and vertical middle is at origin
* %Text center and vertical middle is at origin
*
* @see @ref Alignment::MiddleRightIntegral
*/
MiddleCenter = Implementation::AlignmentMiddle|Implementation::AlignmentCenter,
/**
* Text end and vertical middle is at origin
* %Text end and vertical middle is at origin
*
* @see @ref Alignment::MiddleRightIntegral
*/
MiddleRight = Implementation::AlignmentMiddle|Implementation::AlignmentRight,
/** Text start and top is at origin */
/** %Text start and top is at origin */
TopLeft = Implementation::AlignmentTop|Implementation::AlignmentLeft,
/** Text center and top is at origin */
/** %Text center and top is at origin */
TopCenter = Implementation::AlignmentTop|Implementation::AlignmentCenter,
/** Text end and top is at origin */
/** %Text end and top is at origin */
TopRight = Implementation::AlignmentTop|Implementation::AlignmentRight,
/**
* Text center and line is at origin and alignment offset is integral
* %Text center and line is at origin and alignment offset is integral
*
* @see @ref Alignment::LineCenter
*/
LineCenterIntegral = Implementation::AlignmentLine|Implementation::AlignmentCenter|Implementation::AlignmentIntegral,
/**
* Text start and vertical middle is at origin and alignment offset is integral
* %Text start and vertical middle is at origin and alignment offset is integral
*
* @see @ref Alignment::MiddleLeft
*/
MiddleLeftIntegral = Implementation::AlignmentMiddle|Implementation::AlignmentLeft|Implementation::AlignmentIntegral,
/**
* Text center and vertical middle is at origin and alignment offset is integral
* %Text center and vertical middle is at origin and alignment offset is integral
*
* @see @ref Alignment::MiddleCenter
*/
MiddleCenterIntegral = Implementation::AlignmentMiddle|Implementation::AlignmentCenter|Implementation::AlignmentIntegral,
/**
* Text end and vertical middle is at origin and alignment offset is integral
* %Text end and vertical middle is at origin and alignment offset is integral
*
* @see @ref Alignment::MiddleRight
*/

10
src/Magnum/Text/Renderer.h

@ -56,8 +56,8 @@ class MAGNUM_TEXT_EXPORT AbstractRenderer {
* @param font Font
* @param cache Glyph cache
* @param size Font size
* @param text Text to render
* @param alignment Text alignment
* @param text %Text to render
* @param alignment %Text alignment
*
* Returns tuple with vertex positions, texture coordinates, indices
* and rectangle spanning the rendered text.
@ -80,7 +80,7 @@ class MAGNUM_TEXT_EXPORT AbstractRenderer {
/** @brief Index buffer */
Buffer& indexBuffer() { return _indexBuffer; }
/** @brief Mesh */
/** @brief %Mesh */
Mesh& mesh() { return _mesh; }
/**
@ -243,7 +243,7 @@ template<UnsignedInt dimensions> class MAGNUM_TEXT_EXPORT Renderer: public Abstr
* @param vertexBuffer %Buffer where to store vertices
* @param indexBuffer %Buffer where to store indices
* @param usage Usage of vertex and index buffer
* @param alignment Text alignment
* @param alignment %Text alignment
*
* Returns mesh prepared for use with @ref Shaders::AbstractVector
* subclasses and rectangle spanning the rendered text.
@ -255,7 +255,7 @@ template<UnsignedInt dimensions> class MAGNUM_TEXT_EXPORT Renderer: public Abstr
* @param font Font
* @param cache Glyph cache
* @param size Font size
* @param alignment Text alignment
* @param alignment %Text alignment
*/
explicit Renderer(AbstractFont& font, const GlyphCache& cache, Float size, Alignment alignment = Alignment::LineLeft);
Renderer(AbstractFont&, GlyphCache&&, Float, Alignment alignment = Alignment::LineLeft) = delete; /**< @overload */

2
src/Magnum/Text/Text.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Forward declarations for Magnum::Text namespace
* @brief Forward declarations for @ref Magnum::Text namespace
*/
#include "Magnum/Types.h"

29
src/Magnum/Text/TextRenderer.h

@ -1,5 +1,34 @@
#ifndef Magnum_Text_TextRenderer_h
#define Magnum_Text_TextRenderer_h
/*
This file is part of Magnum.
Copyright © 2010, 2011, 2012, 2013, 2014
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 Typedef @ref Magnum::Text::TextRenderer2D, @ref Magnum::Text::TextRenderer3D
* @deprecated Use @ref Renderer.h instead.
*/
#include "Magnum/Text/Renderer.h"

Loading…
Cancel
Save