This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
sdlenableunicode.html
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_EnableUNICODE</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Event Functions."
HREF="eventfunctions.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GetKeyName"
HREF="sdlgetkeyname.html"><LINK
REL="NEXT"
TITLE="SDL_EnableKeyRepeat"
HREF="sdlenablekeyrepeat.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlgetkeyname.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlenablekeyrepeat.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLENABLEUNICODE"
74
75
></A
>SDL_EnableUNICODE</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN5805"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_EnableUNICODE -- Enable UNICODE translation</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN5808"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN5809"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_EnableUNICODE</B
></CODE
>(int enable);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
118
NAME="AEN5815"
119
120
121
122
></A
><H2
>Description</H2
><P
123
>Enables/Disables Unicode keyboard translation.</P
124
><P
125
126
127
128
129
>To obtain the character codes corresponding to received keyboard events,
Unicode translation must first be turned on using this function. The
translation incurs a slight overhead for each keyboard event and is therefore
disabled by default. For each subsequently received key down event, the
<TT
130
131
132
133
CLASS="STRUCTFIELD"
><I
>unicode</I
></TT
134
135
> member of the
<A
136
137
138
139
140
HREF="sdlkeysym.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_keysym</SPAN
></A
141
142
143
144
145
146
147
148
149
150
151
152
153
154
> structure
will then contain the corresponding character code, or zero for keysyms that do
not correspond to any character code.</P
><P
>A value of 1 for <TT
CLASS="PARAMETER"
><I
>enable</I
></TT
> enables Unicode translation;
0 disables it, and -1 leaves it unchanged (useful for querying the current
translation mode).</P
><P
>Note that only key press events will be translated, not release events.</P
155
156
157
158
></DIV
><DIV
CLASS="REFSECT1"
><A
159
NAME="AEN5825"
160
161
162
163
></A
><H2
>Return Value</H2
><P
164
165
166
167
168
169
170
>Returns the previous translation mode (<SPAN
CLASS="RETURNVALUE"
>0</SPAN
> or <SPAN
CLASS="RETURNVALUE"
>1</SPAN
>).</P
171
172
173
174
></DIV
><DIV
CLASS="REFSECT1"
><A
175
NAME="AEN5830"
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
></A
><H2
>See Also</H2
><P
><A
HREF="sdlkeysym.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_keysym</SPAN
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
193
SUMMARY="Footer navigation table"
194
195
196
197
198
199
200
201
202
203
204
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlgetkeyname.html"
205
ACCESSKEY="P"
206
207
208
209
210
211
212
213
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
214
ACCESSKEY="H"
215
216
217
218
219
220
221
222
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlenablekeyrepeat.html"
223
ACCESSKEY="N"
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetKeyName</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="eventfunctions.html"
239
ACCESSKEY="U"
240
241
242
243
244
245
246
247
248
249
250
251
252
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_EnableKeyRepeat</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>