summaryrefslogtreecommitdiffstats
path: root/thirdparties/common/include/libfreetype/freetype2/freetype/ftbbox.h
blob: 389aa1cbfff48256fdfc6a4628abd766445f5f11 (plain)
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
/***************************************************************************/
/*                                                                         */
/*  ftbbox.h                                                               */
/*                                                                         */
/*    FreeType exact bbox computation (specification).                     */
/*                                                                         */
/*  Copyright 1996-2001, 2003, 2007, 2011 by                               */
/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
/*                                                                         */
/*  This file is part of the FreeType project, and may only be used,       */
/*  modified, and distributed under the terms of the FreeType project      */
/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
/*  this file you indicate that you have read the license and              */
/*  understand and accept it fully.                                        */
/*                                                                         */
/***************************************************************************/


/*************************************************************************/
/*                                                                       */
/* This component has a _single_ role: to compute exact outline bounding */
/* boxes.                                                                */
/*                                                                       */
/* It is separated from the rest of the engine for various technical     */
/* reasons.  It may well be integrated in `ftoutln' later.               */
/*                                                                       */
/*************************************************************************/


#ifndef __FTBBOX_H__
#define __FTBBOX_H__


#include <ft2build.h>
#include FT_FREETYPE_H

#ifdef FREETYPE_H
#error "freetype.h of FreeType 1 has been loaded!"
#error "Please fix the directory search order for header files"
#error "so that freetype.h of FreeType 2 is found first."
#endif


FT_BEGIN_HEADER


/*************************************************************************/
/*                                                                       */
/* <Section>                                                             */
/*    outline_processing                                                 */
/*                                                                       */
/*************************************************************************/


/*************************************************************************/
/*                                                                       */
/* <Function>                                                            */
/*    FT_Outline_Get_BBox                                                */
/*                                                                       */
/* <Description>                                                         */
/*    Compute the exact bounding box of an outline.  This is slower      */
/*    than computing the control box.  However, it uses an advanced      */
/*    algorithm which returns _very_ quickly when the two boxes          */
/*    coincide.  Otherwise, the outline Bézier arcs are traversed to     */
/*    extract their extrema.                                             */
/*                                                                       */
/* <Input>                                                               */
/*    outline :: A pointer to the source outline.                        */
/*                                                                       */
/* <Output>                                                              */
/*    abbox   :: The outline's exact bounding box.                       */
/*                                                                       */
/* <Return>                                                              */
/*    FreeType error code.  0~means success.                             */
/*                                                                       */
/* <Note>                                                                */
/*    If the font is tricky and the glyph has been loaded with           */
/*    @FT_LOAD_NO_SCALE, the resulting BBox is meaningless.  To get      */
/*    reasonable values for the BBox it is necessary to load the glyph   */
/*    at a large ppem value (so that the hinting instructions can        */
/*    properly shift and scale the subglyphs), then extracting the BBox  */
/*    which can be eventually converted back to font units.              */
/*                                                                       */
FT_EXPORT( FT_Error )
FT_Outline_Get_BBox( FT_Outline*  outline,
                     FT_BBox     *abbox );


/* */


FT_END_HEADER

#endif /* __FTBBOX_H__ */


/* END */


/* Local Variables: */
/* coding: utf-8    */
/* End:             */
OpenPOWER on IntegriCloud