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