/usr/include/crystalspace-2.0/ivideo/fontserv.h is in libcrystalspace-dev 2.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | /*
Copyright (C) 2000 by Norman Kraemer
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CS_IVIDEO_FONTSERV_H__
#define __CS_IVIDEO_FONTSERV_H__
#include "csutil/csunicode.h"
#include "csutil/scf_interface.h"
#include "csutil/ref.h"
/**\file
* Font server interface
*/
/**
* \addtogroup gfx2d
* @{ */
/**\name Basic fonts alias names
* Any font server should provide these fonts, since most
* programs expect they to be available. Other fonts may or
* may be not available but these should be always available.
* Default font names always start with "*" to avoid confusion
* with real file names.
* @{ */
/// Thick and relatively large font
#define CSFONT_LARGE "*large"
/// Thick italic relatively large font
#define CSFONT_ITALIC "*italic"
/// Thin courier-like relatively large font
#define CSFONT_COURIER "*courier"
/// Very small font (smallest font that is still readable)
#define CSFONT_SMALL "*small"
/** @} */
/**
* The default char, drawn in case a glyph wasn't present in the font.
* The Unicode standard says that this will never be a valid code point -
* so we just take as the "replacer" char.
*/
#define CS_FONT_DEFAULT_GLYPH 0xffff
struct iFont;
struct iDataBuffer;
/**
* Called before a font is deleted.
* You can insert any number of callback routines into the font
* so that when the font will be destroyed all of them will be
* called in turn. This can be used by canvas driver, for example,
* if the canvas driver does some kind of caching for fonts,
* e.g. OpenGL driver pre-caches the font on a texture, it needs
* some mechanism to be notified when the font is destroyed to free
* the cache texture associated with the font.
*/
struct iFontDeleteNotify : public virtual iBase
{
SCF_INTERFACE(iFontDeleteNotify, 2,0,0);
/// Before delete.
virtual void BeforeDelete (iFont* font) = 0;
};
/**
* Metrics for a glyph that are dependent from whether a simple
* or antialiased image is used.
*/
struct csBitmapMetrics
{
/// Width of the glyph image
int width;
/// Height of the glyph image
int height;
/// X offset of the image to the pen position
int left;
/// Y offset of the image to the pen position
int top;
};
/**
* Metrics for a glyph that are independent from whether a simple
* or antialiased image is used.
*/
struct csGlyphMetrics
{
/// Amount of pixels the pen needs to advance after the glyph
int advance;
};
/**
* A font object.
* Objects of this class are used by canvas driver to paint glyphs.
*
* Main creators of instances implementing this interface:
* - iFontServer::LoadFont()
*/
struct iFont : public virtual iBase
{
SCF_INTERFACE (iFont, 6, 0, 0);
/**
* Add a font delete notification callback routine.
* This routine will be called from font destructor,
* with the font instance being passed as argument.
* Another parameter is provided to supply additional data.
*/
virtual void AddDeleteCallback (iFontDeleteNotify* func) = 0;
/**
* Remove a font delete notification callback.
*/
virtual bool RemoveDeleteCallback (iFontDeleteNotify* func) = 0;
/**
* Query current font size in Point. If server does not support rescalable
* fonts, this method returns 0.
*/
virtual float GetSize () = 0;
/**
* Return the maximum width and height of a single glyph, in pixels.
* Return -1 if it could not be determined.
*/
virtual void GetMaxSize (int &oW, int &oH) = 0;
/**
* Return the metrics of a glyph.
*/
virtual bool GetGlyphMetrics (utf32_char c, csGlyphMetrics& metrics) = 0;
/**
* Return a pointer to a bitmap containing a rendered character.
* Returns 0 if the glyph can't be retrieved.
*/
virtual csPtr<iDataBuffer> GetGlyphBitmap (utf32_char c,
csBitmapMetrics& metrics) = 0;
/**
* Return a pointer to a bitmap containing the alpha bitmap for the
* rendered character.
* Returns 0 if the glyph can't be retrieved.
*/
virtual csPtr<iDataBuffer> GetGlyphAlphaBitmap (utf32_char c,
csBitmapMetrics& metrics) = 0;
/**
* Return the width and height of text written with this font.
*/
virtual void GetDimensions (const char *text, int &oW, int &oH) = 0;
/**
* Return the width and height of text written with this font. desc
* gives the maximum descender.
*/
virtual void GetDimensions (const char *text, int &oW, int &oH,
int &desc) = 0;
/**
* Determine how many characters from this string can be written
* without exceeding given width (in pixels)
*/
virtual int GetLength (const char *text, int maxwidth) = 0;
/**
* Get the font's descent in pixels.
* Returns a value <0 if an error occured.
* The sum of descent and ascent must not necessarily equal the
* maximum height.
*/
virtual int GetDescent () = 0;
/**
* Get the font's ascent in pixels.
* Returns a value <0 if an error occured.
* The sum of descent and ascent must not necessarily equal the
* maximum height.
*/
virtual int GetAscent () = 0;
/**
* Returns whether a specific glyph is present in this font.
*/
virtual bool HasGlyph (utf32_char c) = 0;
/**
* Gets the default baseline to baseline distance between
* two lines of text using this font.
*/
virtual int GetTextHeight () = 0;
/**
* When displaying or rendering underlined text, this
* value corresponds to the vertical position, relative
* to the baseline, of the underline bar. It is positive
* if the underline it is below the baseline. The position
* returned is to the top of the underline bar/rectagle.
*/
virtual int GetUnderlinePosition () = 0;
/**
* When displaying or rendering underlined text, this value
* corresponds to the vertical thickness of the underline
* bar/rectangle.
*/
virtual int GetUnderlineThickness () = 0;
};
/**
* A font server interface.
* Font server can load fonts and create iFont objects.
* In fact user does not care whenever fonts are built-in
* the font server or are on disk; thus some font servers
* may contain the fonts hardcoded; in this case the
* font path is really a identifier.
*
* Main creators of instances implementing this interface:
* - Font Multiplexer plugin (crystalspace.font.server.multiplexer)
* - Standard Font server plugin (crystalspace.font.server.default)
* - FreeType2 Font server plugin (crystalspace.font.server.freetype2)
*
* Main ways to get pointers to this interface:
* - csQueryRegistry<iFontServer>()
*
* Main users of this interface:
* - iGraphics3D implementations (3D renderers).
*/
struct iFontServer : public virtual iBase
{
SCF_INTERFACE (iFontServer, 4, 0, 0);
/**
* Load a font by name.
* Returns a new iFont object or 0 on failure.
*/
virtual csPtr<iFont> LoadFont (const char* filename,
float size = 10.0f) = 0;
/**
* Enable or disable error reporting.
* By default, the font loaders emit a warning when a font could not loaded.
* Use this method to enable or disable that behaviour.
*/
virtual void SetWarnOnError (bool enable) = 0;
/// Get status of warning emission on error
virtual bool GetWarnOnError () = 0;
};
/** @} */
#endif // __CS_IVIDEO_FONTSERV_H__
|