xref: /openbsd/sys/dev/wsfont/wsfont.h (revision d415bd75)
1 /*	$OpenBSD: wsfont.h,v 1.12 2019/07/11 18:07:54 mpi 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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _WSFONT_H_
34 #define _WSFONT_H_ 1
35 
36 /*
37  * wsfont_find() can be called with any of the parameters as 0, meaning we
38  * don't care about that aspect of the font. It returns a cookie which
39  * we can use with the other functions. When more flexibility is required,
40  * wsfont_enum() should be used. The last two parameters to wsfont_lock()
41  * are the bit order and byte order required (WSDISPLAY_FONTORDER_L2R or
42  * WSDISPLAY_FONTORDER_R2L).
43  *
44  * Example:
45  *
46  *	struct wsdisplay_font *font;
47  *	int cookie;
48  *
49  *	if ((cookie = wsfont_find(NULL, 8, 16, 0, 0)) <= 0)
50  *		panic("unable to get 8x16 font");
51  *
52  *	if (wsfont_lock(cookie, &font, WSDISPLAY_FONTORDER_L2R,
53  *	    WSDISPLAY_FONTORDER_R2L) <= 0)
54  *		panic("unable to lock font");
55  *
56  *	... do stuff ...
57  *
58  *	wsfont_unlock(cookie);
59  */
60 
61 struct wsdisplay_font;
62 
63 /* For wsfont_add() */
64 #define WSFONT_BUILTIN	(0x01)
65 #define WSFONT_STATIC	(0x02)
66 
67 /* wsfont.c */
68 void	wsfont_init(void);
69 int	wsfont_find(const char *, int, int, int);
70 int	wsfont_add(struct wsdisplay_font *, int);
71 void	wsfont_enum(int (*)(void *, struct wsdisplay_font *), void *);
72 int	wsfont_lock(int, struct wsdisplay_font **, int, int);
73 int	wsfont_unlock(int);
74 int	wsfont_map_unichar(struct wsdisplay_font *, int);
75 int	wsfont_rotate(int, int);
76 
77 #endif	/* !_WSFONT_H_ */
78