Get started with patching up the Qt GUI docs
[profile/ivi/qtbase.git] / src / gui / text / qdistancefield_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QDISTANCEFIELD_H
43 #define QDISTANCEFIELD_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include <qrawfont.h>
57 #include <private/qfontengine_p.h>
58
59 QT_BEGIN_NAMESPACE
60
61 #define QT_DISTANCEFIELD_DEFAULT_BASEFONTSIZE 54
62 #define QT_DISTANCEFIELD_DEFAULT_TILESIZE 64
63 #define QT_DISTANCEFIELD_DEFAULT_SCALE 16
64 #define QT_DISTANCEFIELD_DEFAULT_RADIUS 80
65 #define QT_DISTANCEFIELD_HIGHGLYPHCOUNT 2000
66
67 #define QT_DISTANCEFIELD_BASEFONTSIZE(NarrowOutlineFont) \
68     (NarrowOutlineFont ? QT_DISTANCEFIELD_DEFAULT_BASEFONTSIZE * 2 : \
69                          QT_DISTANCEFIELD_DEFAULT_BASEFONTSIZE)
70 #define QT_DISTANCEFIELD_TILESIZE(NarrowOutlineFont) \
71     (NarrowOutlineFont ? QT_DISTANCEFIELD_DEFAULT_TILESIZE * 2 : \
72                          QT_DISTANCEFIELD_DEFAULT_TILESIZE)
73 #define QT_DISTANCEFIELD_SCALE(NarrowOutlineFont) \
74     (NarrowOutlineFont ? QT_DISTANCEFIELD_DEFAULT_SCALE / 2 : \
75                          QT_DISTANCEFIELD_DEFAULT_SCALE)
76 #define QT_DISTANCEFIELD_RADIUS(NarrowOutlineFont) \
77     (NarrowOutlineFont ? QT_DISTANCEFIELD_DEFAULT_RADIUS / 2 : \
78                          QT_DISTANCEFIELD_DEFAULT_RADIUS)
79
80 bool Q_GUI_EXPORT qt_fontHasNarrowOutlines(const QRawFont &f);
81 QImage Q_GUI_EXPORT qt_renderDistanceFieldGlyph(const QRawFont &font, glyph_t glyph, bool doubleResolution);
82 bool Q_GUI_EXPORT qt_fontHasNarrowOutlines(QFontEngine *fontEngine);
83 QImage Q_GUI_EXPORT qt_renderDistanceFieldGlyph(QFontEngine *fontEngine, glyph_t glyph, bool doubleResolution);
84
85 QT_END_NAMESPACE
86
87 #endif // QDISTANCEFIELD_H