src/ascension/ui/text.h

changeset 48
6e5b5ba2752c
parent 45
18de2af03531
child 50
d8d2e4817db1
equal deleted inserted replaced
47:44457f6cb0a2 48:6e5b5ba2752c
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 * Copyright 2023 Mike Becker. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef ASCENSION_UI_TEXT_H
29 #define ASCENSION_UI_TEXT_H
30
31 #include "font.h"
32 #include "../scene.h"
33
34 typedef struct AscText {
35 extend_asc_scene_node;
36 char *text;
37 AscFont const *font;
38 asc_col4i color;
39 unsigned max_width;
40 bool hidden;
41 bool centered;
42 unsigned tex_id;
43 } AscText;
44
45
46 /**
47 * Creates a text node.
48 *
49 * The current context ink and font will be used.
50 *
51 * @param x the position where to draw the text
52 * @param y the position where to draw the text
53 * @param text the text to draw
54 * @return the scene node
55 *
56 * @see asc_ink()
57 * @see asc_font()
58 */
59 AscSceneNode *asc_text(int x, int y, char const* text);
60
61 /**
62 * Provides access to the text data fields.
63 *
64 * @param node scene node created by asc_text()
65 */
66 #define asc_text_data(node) ((AscText*)node)
67
68 /**
69 * Releases all the memory of this node.
70 *
71 * @param node the text node
72 */
73 void asc_text_free(AscText *node);
74
75 #endif //ASCENSION_UI_TEXT_H

mercurial