Imported Upstream version 2.11.93
[platform/upstream/fontconfig.git] / doc / fcrange.fncs
1 /*
2  * fontconfig/doc/fcrange.fncs
3  *
4  * Copyright © 2003 Keith Packard
5  *
6  * Permission to use, copy, modify, distribute, and sell this software and its
7  * documentation for any purpose is hereby granted without fee, provided that
8  * the above copyright notice appear in all copies and that both that
9  * copyright notice and this permission notice appear in supporting
10  * documentation, and that the name of the author(s) not be used in
11  * advertising or publicity pertaining to distribution of the software without
12  * specific, written prior permission.  The authors make no
13  * representations about the suitability of this software for any purpose.  It
14  * is provided "as is" without express or implied warranty.
15  *
16  * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18  * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22  * PERFORMANCE OF THIS SOFTWARE.
23  */
24 @RET@           FcRange *
25 @FUNC@          FcRangeCopy
26 @TYPE1@         const FcRange *                 @ARG1@          range
27 @PURPOSE@       Copy a range object
28 @DESC@
29 <function>FcRangeCopy</function> creates a new FcRange object and
30 populates it with the contents of <parameter>range</parameter>.
31 @SINCE@         2.11.91
32 @@
33
34 @RET@           FcRange *
35 @FUNC@          FcRangeCreateDouble
36 @TYPE1@         double                          @ARG1@          begin
37 @TYPE2@         double                          @ARG2@          end
38 @PURPOSE@       create a range object for double
39 @DESC@
40 <function>FcRangeCreateDouble</function> creates a new FcRange object with
41 double sized value.
42 @SINCE@         2.11.91
43 @@
44
45 @RET@           FcRange *
46 @FUNC@          FcRangeCreateInteger
47 @TYPE1@         int                             @ARG1@          begin
48 @TYPE2@         int                             @ARG2@          end
49 @PURPOSE@       create a range object for integer
50 @DESC@
51 <function>FcRangeCreateInteger</function> creates a new FcRange object with
52 integer sized value.
53 @SINCE@         2.11.91
54 @@
55
56 @RET@           void
57 @FUNC@          FcRangeDestroy
58 @TYPE1@         FcRange *                       @ARG1@          range
59 @PURPOSE@       destroy a range object
60 @DESC@
61 <function>FcRangeDestroy</function> destroys a FcRange object, freeing
62 all memory associated with it.
63 @SINCE@         2.11.91
64 @@
65
66 @RET@           FcBool
67 @FUNC@          FcRangeGetDouble
68 @TYPE1@         const FcRange *                 @ARG1@          range
69 @TYPE2@         double *                        @ARG2@          begin
70 @TYPE3@         double *                        @ARG3@          end
71 @PURPOSE@       Get the range in double
72 @DESC@
73 Returns in <parameter>begin</parameter> and <parameter>end</parameter> as the range.
74 @SINCE@         2.11.91
75 @@