-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconsole_key_t.html
More file actions
155 lines (152 loc) · 7.65 KB
/
console_key_t.html
File metadata and controls
155 lines (152 loc) · 7.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-C2YXLNQ21C"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-C2YXLNQ21C');
</script>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>libtcod documentation | Keyboard event structure</title>
<script type="text/javascript" src="../js/doctcod.js"></script>
<link href="../css/style.css" rel="stylesheet" type="text/css">
</head>
<link type="text/css" rel="stylesheet" href="../css/shCore.css">
</link>
<link type="text/css" rel="stylesheet" href="../css/shThemeDefault.css">
</link>
<script language="javascript" src="../js/shCore.js"></script>
<script language="javascript" src="../js/shBrushBash.js"></script>
<body>
<div class="header">
<p><span class="title1">libtcod</span><span class="title2">documentation</span></p>
</div>
<div class="breadcrumb">
<div class="breadcrumbtext">
<p>
you are here: <a onclick="link('../index2.html')">Index</a> > <a onclick="link('console.html')">2.
Console</a> > <a onclick="link('console_input.html')">2.4. Handling user input</a> > <a
onclick="link('console_key_t.html')">2.4.3. Keyboard event structure</a><br>
<a class="prev" onclick="link('console_non_blocking_input.html')">2.4.2. Non blocking user input</a> | <a
class="next" onclick="link('console_mouse_t.html')">2.4.4. Mouse event structure</a>
</p>
</div>
</div>
<div class="filter"><input type="checkbox" id="chk_c" name="chk_c" onchange="enable('c',this.checked)"
checked='checked'><label for='chk_c'> C </label><input type="checkbox" id="chk_cpp" name="chk_cpp"
onchange="enable('cpp',this.checked)" checked='checked'><label for='chk_cpp'> C++ </label><input type="checkbox"
id="chk_py" name="chk_py" onchange="enable('py',this.checked)" checked='checked'><label for='chk_py'> Py
</label><input type="checkbox" id="chk_lua" name="chk_lua" onchange="enable('lua',this.checked)"
disabled='disabled'><label class='disabled' for='chk_lua'> Lua </label><input type="checkbox" id="chk_cs"
name="chk_cs" onchange="enable('cs',this.checked)" disabled='disabled'><label class='disabled' for='chk_cs'> C#
</label></div>
<div class="main">
<div class="maintext">
<h1>2.4.3. Keyboard event structure</h1>
<p>This structure contains information about a key pressed/released by the user.<br /> </p>
<a name="0"></a>
<div class="code">
<p class="c"><span class="code-keyword">typedef</span><span class="code-keyword"> struct</span><span
class="code-symbol"> {</span><span class="code-tcod"><br /> TCOD_keycode_t</span>
vk<span class="code-symbol">;</span><span class="code-keyword"><br /> char</span>
c<span class="code-symbol">;</span><span class="code-keyword"><br /> char</span>
text<span class="code-symbol">[</span><span class="code-value">32</span><span
class="code-symbol">]</span><span class="code-symbol">;</span><span
class="code-keyword"><br /> bool</span> pressed<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> lalt<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> lctrl<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> lmeta<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> ralt<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> rctrl<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> rmeta<span
class="code-symbol">;</span><span class="code-keyword"><br /> bool</span> shift<span
class="code-symbol">;</span><span class="code-symbol"><br />}</span><span class="code-tcod">
TCOD_key_t</span><span class="code-symbol">;</span></p>
</div>
<table class="param">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr class="hilite">
<td>vk</td>
<td>An arbitrary value representing the physical key on the keyboard. Possible values are stored in the
TCOD_keycode_t enum. If no key was pressed, the value is TCODK_NONE<br /> </td>
</tr>
<tr>
<td>c</td>
<td>If the key correspond to a printable character, the character is stored in this field. Else, this field
contains 0.<br /> </td>
</tr>
<tr class="hilite">
<td>text</td>
<td>If vk is TCODK_TEXT, this will contain the text entered by the user.<br /> </td>
</tr>
<tr>
<td>pressed</td>
<td>true if the event is a key pressed, or false for a key released.<br /> </td>
</tr>
<tr class="hilite">
<td>lalt</td>
<td>This field represents the status of the left Alt key : true => pressed, false => released.<br /> </td>
</tr>
<tr>
<td>lctrl</td>
<td>This field represents the status of the left Control key : true => pressed, false => released.<br />
</td>
</tr>
<tr class="hilite">
<td>lmeta</td>
<td>This field represents the status of the left Meta (Windows/Command/..) key : true => pressed, false =>
released.<br /> </td>
</tr>
<tr>
<td>ralt</td>
<td>This field represents the status of the right Alt key : true => pressed, false => released.<br /> </td>
</tr>
<tr class="hilite">
<td>rctrl</td>
<td>This field represents the status of the right Control key : true => pressed, false => released.<br />
</td>
</tr>
<tr>
<td>rmeta</td>
<td>This field represents the status of the right Meta (Windows/Command/..) key : true => pressed, false =>
released.<br /> </td>
</tr>
<tr class="hilite">
<td>shift</td>
<td>This field represents the status of the shift key : true => pressed, false => released.<br /> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="footer">
<div class="footertext">
<p>libtcod 1.6.4, © 2008, 2009, 2010, 2012, 2017 Jice, Mingos & rmtew<br>
This file has been generated by doctcod.</p>
<p>
<table width='100%'>
<tr>
<td width="33%"><a href="https://github.com/libtcod/libtcod">libtcod website</a></td>
<td width="33%"><a href="https://www.reddit.com/r/roguelikedev">libtcod on /r/roguelikedev</a></td>
<td width="33%">libtcod tutorials [ <a
href="http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod">Python</a> | <a
href="http://www.roguebasin.com/index.php?title=Complete_roguelike_tutorial_using_C%2B%2B_and_libtcod_-_part_1:_setting_up">C++</a> ]
</td>
</tr>
</table>
</p>
</div>
</div>
</body>
<script>
initFilter();
SyntaxHighlighter.all();
</script>
</html>