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