[sdl_omap.git] / docs / html / sdlenablekeyrepeat.html

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