Source

selove / src / modules / font / Rasterizer.h

The default branch has multiple heads

Full commit
/**
* Copyright (c) 2006-2012 LOVE Development Team
*
* This software is provided 'as-is', without any express or implied
* warranty.  In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
*    claim that you wrote the original software. If you use this software
*    in a product, an acknowledgment in the product documentation would be
*    appreciated but is not required.
* 2. Altered source versions must be plainly marked as such, and must not be
*    misrepresented as being the original software.
* 3. This notice may not be removed or altered from any source distribution.
**/

#ifndef LOVE_FONT_RASTERIZER_H
#define LOVE_FONT_RASTERIZER_H

// LOVE
#include <common/Object.h>
#include "GlyphData.h"

namespace love
{
namespace font
{
	/**
	* Holds the specific font metrics.
	**/
	struct FontMetrics
	{
		int advance;
		int ascent;
		int descent;
		int height;
	};

	/**
	* Holds data for a font object.
	**/
	class Rasterizer : public Object
	{
	protected:
		FontMetrics metrics;

	public:

		virtual ~Rasterizer();

		/**
		* Gets the max height of the glyphs.
		**/
		virtual int getHeight() const;

		/**
		* Gets the max advance of the glyphs.
		**/
		virtual int getAdvance() const;

		/**
		* Gets the max ascent (height above baseline) for the font.
		**/
		virtual int getAscent() const;

		/**
		* Gets the max descent (height below baseline) for the font.
		**/
		virtual int getDescent() const;

		/**
		* Gets the line height of the font.
		**/
		virtual int getLineHeight() const = 0;

		/**
		* Gets a specific glyph.
		* @param glyph The (UNICODE) glyph to get data for
		**/
		virtual GlyphData * getGlyphData(unsigned short glyph) const = 0;

		/**
		* Gets the number of glyphs the rasterizer has data for.
		**/
		virtual int getNumGlyphs() const = 0;


	}; // Rasterizer

} // font
} // love

#endif // LOVE_FONT_RASTERIZER_H