Mercurial > sdl-ios-xcode
annotate docs/html/sdlenablekeyrepeat.html @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Sun, 10 Jun 2001 19:31:57 +0000 |
parents | 74212992fb08 |
children | e5bc29de3f0a |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_EnableKeyRepeat</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Event Functions." | |
14 HREF="eventfunctions.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_EnableUNICODE" | |
17 HREF="sdlenableunicode.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_GetMouseState" | |
20 HREF="sdlgetmousestate.html"></HEAD | |
21 ><BODY | |
22 CLASS="REFENTRY" | |
23 BGCOLOR="#FFF8DC" | |
24 TEXT="#000000" | |
25 LINK="#0000ee" | |
26 VLINK="#551a8b" | |
27 ALINK="#ff0000" | |
28 ><DIV | |
29 CLASS="NAVHEADER" | |
30 ><TABLE | |
31 WIDTH="100%" | |
32 BORDER="0" | |
33 CELLPADDING="0" | |
34 CELLSPACING="0" | |
35 ><TR | |
36 ><TH | |
37 COLSPAN="3" | |
38 ALIGN="center" | |
39 >SDL Library Documentation</TH | |
40 ></TR | |
41 ><TR | |
42 ><TD | |
43 WIDTH="10%" | |
44 ALIGN="left" | |
45 VALIGN="bottom" | |
46 ><A | |
47 HREF="sdlenableunicode.html" | |
48 >Prev</A | |
49 ></TD | |
50 ><TD | |
51 WIDTH="80%" | |
52 ALIGN="center" | |
53 VALIGN="bottom" | |
54 ></TD | |
55 ><TD | |
56 WIDTH="10%" | |
57 ALIGN="right" | |
58 VALIGN="bottom" | |
59 ><A | |
60 HREF="sdlgetmousestate.html" | |
61 >Next</A | |
62 ></TD | |
63 ></TR | |
64 ></TABLE | |
65 ><HR | |
66 ALIGN="LEFT" | |
67 WIDTH="100%"></DIV | |
68 ><H1 | |
69 ><A | |
70 NAME="SDLENABLEKEYREPEAT" | |
71 >SDL_EnableKeyRepeat</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
76 NAME="AEN5292" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_EnableKeyRepeat -- Set keyboard repeat rate.</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
84 NAME="AEN5295" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
91 NAME="AEN5296" |
0 | 92 ></A |
93 ><P | |
94 ></P | |
95 ><PRE | |
96 CLASS="FUNCSYNOPSISINFO" | |
97 >#include "SDL.h"</PRE | |
98 ><P | |
99 ><CODE | |
100 ><CODE | |
101 CLASS="FUNCDEF" | |
102 >int <B | |
103 CLASS="FSFUNC" | |
104 >SDL_EnableKeyRepeat</B | |
105 ></CODE | |
106 >(int delay, int interval);</CODE | |
107 ></P | |
108 ><P | |
109 ></P | |
110 ></DIV | |
111 ></DIV | |
112 ><DIV | |
113 CLASS="REFSECT1" | |
114 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
115 NAME="AEN5302" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
120 >Enables or disables the keyboard repeat rate. <TT | |
121 CLASS="PARAMETER" | |
122 ><I | |
123 >delay</I | |
124 ></TT | |
125 > specifies how long the key must be pressed before it begins repeating, it then repeats at the speed specified by <TT | |
126 CLASS="PARAMETER" | |
127 ><I | |
128 >interval</I | |
129 ></TT | |
130 >. Both <TT | |
131 CLASS="PARAMETER" | |
132 ><I | |
133 >delay</I | |
134 ></TT | |
135 > and <TT | |
136 CLASS="PARAMETER" | |
137 ><I | |
138 >interval</I | |
139 ></TT | |
140 > are expressed in milliseconds.</P | |
141 ><P | |
142 >Setting <TT | |
143 CLASS="PARAMETER" | |
144 ><I | |
145 >delay</I | |
146 ></TT | |
147 > to 0 disables key repeating completely. Good default values are <TT | |
148 CLASS="LITERAL" | |
149 >SDL_DEFAULT_REPEAT_DELAY</TT | |
150 > and <SPAN | |
151 CLASS="SYMBOL" | |
152 >SDL_DEFAULT_REPEAT_INTERVAL</SPAN | |
153 >.</P | |
154 ></DIV | |
155 ><DIV | |
156 CLASS="REFSECT1" | |
157 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
158 NAME="AEN5313" |
0 | 159 ></A |
160 ><H2 | |
161 >Return Value</H2 | |
162 ><P | |
163 >Returns <SPAN | |
164 CLASS="RETURNVALUE" | |
165 >0</SPAN | |
166 > on success and <SPAN | |
167 CLASS="RETURNVALUE" | |
168 >-1</SPAN | |
169 > on failure.</P | |
170 ></DIV | |
171 ><DIV | |
172 CLASS="NAVFOOTER" | |
173 ><HR | |
174 ALIGN="LEFT" | |
175 WIDTH="100%"><TABLE | |
176 WIDTH="100%" | |
177 BORDER="0" | |
178 CELLPADDING="0" | |
179 CELLSPACING="0" | |
180 ><TR | |
181 ><TD | |
182 WIDTH="33%" | |
183 ALIGN="left" | |
184 VALIGN="top" | |
185 ><A | |
186 HREF="sdlenableunicode.html" | |
187 >Prev</A | |
188 ></TD | |
189 ><TD | |
190 WIDTH="34%" | |
191 ALIGN="center" | |
192 VALIGN="top" | |
193 ><A | |
194 HREF="index.html" | |
195 >Home</A | |
196 ></TD | |
197 ><TD | |
198 WIDTH="33%" | |
199 ALIGN="right" | |
200 VALIGN="top" | |
201 ><A | |
202 HREF="sdlgetmousestate.html" | |
203 >Next</A | |
204 ></TD | |
205 ></TR | |
206 ><TR | |
207 ><TD | |
208 WIDTH="33%" | |
209 ALIGN="left" | |
210 VALIGN="top" | |
211 >SDL_EnableUNICODE</TD | |
212 ><TD | |
213 WIDTH="34%" | |
214 ALIGN="center" | |
215 VALIGN="top" | |
216 ><A | |
217 HREF="eventfunctions.html" | |
218 >Up</A | |
219 ></TD | |
220 ><TD | |
221 WIDTH="33%" | |
222 ALIGN="right" | |
223 VALIGN="top" | |
224 >SDL_GetMouseState</TD | |
225 ></TR | |
226 ></TABLE | |
227 ></DIV | |
228 ></BODY | |
229 ></HTML | |
230 > |