1/* $NetBSD: wsfont.h,v 1.26 2016/11/20 15:44:40 macallan Exp $ */
2
3/*-
4 * Copyright (c) 1999, 2000, 2001, 2002 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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _WSFONT_H_
33#define _WSFONT_H_ 1
34
35#define WSFONT_FLAGS_MASK 0x7f000000
36#define WSFONT_FLAG_OPT 0x01000000 /* use alternate font */
37#define WSFONT_GLYPH(c, font) ((uint8_t *)font->data + \
38 ((c) - font->firstchar) * font->stride * font->fontheight)
39#define FONT_IS_ALPHA(f) ((f)->fontwidth <= (f)->stride)
40
41/*
42 * Example:
43 *
44 * struct wsdisplay_font *font;
45 * int cookie;
46 *
47 * cookie = wsfont_find(NULL, 8, 16, 0, WSDISPLAY_FONTORDER_L2R,
48 * WSDISPLAY_FONTORDER_R2L);
49 * if (cookie <= 0)
50 * panic("unable to get 8x16 font");
51 *
52 * if (wsfont_lock(cookie, &font))
53 * panic("unable to lock font");
54 *
55 * ... do stuff ...
56 *
57 * wsfont_unlock(cookie);
58 */
59
60struct wsdisplay_font;
61
62void wsfont_init(void);
63int wsfont_matches(struct wsdisplay_font *, const char *, int, int, int, int);
64int wsfont_find(const char *, int, int, int, int, int, int);
65#define WSFONT_FIND_BITMAP 0x01
66#define WSFONT_FIND_ALPHA 0x02
67#define WSFONT_FIND_ALL 0xff
68#define WSFONT_FIND_BESTWIDTH 0x1000
69#define WSFONT_PREFER_ALPHA 0x2000
70
71void wsfont_walk(void (*)(struct wsdisplay_font *, void *, int), void *);
72
73int wsfont_add(struct wsdisplay_font *, int);
74int wsfont_remove(int);
75void wsfont_enum(void (*)(const char *, int, int, int));
76int wsfont_lock(int, struct wsdisplay_font **);
77int wsfont_unlock(int);
78int wsfont_map_unichar(struct wsdisplay_font *, int);
79int wsfont_rotate(int, int);
80
81enum {
82 WSFONT_ROTATE_CW,
83 WSFONT_ROTATE_CCW,
84 WSFONT_ROTATE_UD
85};
86
87int wsfont_make_cookie(int, int, int);
88
89#endif /* !_WSFONT_H_ */
90