1 /* $OpenBSD: wsfont.h,v 1.4 2005/09/15 20:23:10 miod Exp $ */
2 /* $NetBSD: wsfont.h,v 1.12 2000/06/13 13:37:07 ad Exp $ */
3
4 /*-
5 * Copyright (c) 1999 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Andrew Doran.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 #ifndef _WSFONT_H_
41 #define _WSFONT_H_ 1
42
43 /*
44 * wsfont_find() can be called with any of the parameters as 0, meaning we
45 * don't care about that aspect of the font. It returns a cookie which
46 * we can use with the other functions. When more flexibility is required,
47 * wsfont_enum() should be used. The last two parameters to wsfont_lock()
48 * are the bit order and byte order required (WSDISPLAY_FONTORDER_L2R or
49 * WSDISPLAY_FONTORDER_R2L).
50 *
51 * Example:
52 *
53 * struct wsdisplay_font *font;
54 * int cookie;
55 *
56 * if ((cookie = wsfont_find(NULL, 8, 16, 0, 0)) <= 0)
57 * panic("unable to get 8x16 font");
58 *
59 * if (wsfont_lock(cookie, &font, WSDISPLAY_FONTORDER_L2R,
60 * WSDISPLAY_FONTORDER_R2L) <= 0)
61 * panic("unable to lock font");
62 *
63 * ... do stuff ...
64 *
65 * wsfont_unlock(cookie);
66 */
67
68 struct wsdisplay_font;
69
70 /* For wsfont_add() */
71 #define WSFONT_BUILTIN (0x01)
72 #define WSFONT_STATIC (0x02)
73 #define WSFONT_RDONLY (0x04)
74
75 /* wsfont.c */
76 void wsfont_init(void);
77 int wsfont_find(char *, int, int, int);
78 int wsfont_add(struct wsdisplay_font *, int);
79 int wsfont_remove(int);
80 void wsfont_enum(void (*)(char *, int, int, int));
81 int wsfont_lock(int, struct wsdisplay_font **, int, int);
82 int wsfont_unlock(int);
83 int wsfont_getflg(int, int *, int *);
84 int wsfont_map_unichar(struct wsdisplay_font *, int);
85 int wsfont_rotate(int);
86
87 #endif /* !_WSFONT_H_ */