SDL-1.2.14
[sdl_omap.git] / docs / man3 / SDL_EnableKeyRepeat.3
CommitLineData
e14743d1 1.TH "SDL_EnableKeyRepeat" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
2.SH "NAME"
3SDL_EnableKeyRepeat \- Set keyboard repeat rate\&.
4.SH "SYNOPSIS"
5.PP
6\fB#include "SDL\&.h"
7.sp
8\fBint \fBSDL_EnableKeyRepeat\fP\fR(\fBint delay, int interval\fR);
9.SH "DESCRIPTION"
10.PP
11Enables or disables the keyboard repeat rate\&. \fBdelay\fR specifies how long the key must be pressed before it begins repeating, it then repeats at the speed specified by \fBinterval\fR\&. Both \fBdelay\fR and \fBinterval\fR are expressed in milliseconds\&.
12.PP
13Setting \fBdelay\fR to 0 disables key repeating completely\&. Good default values are \fBSDL_DEFAULT_REPEAT_DELAY\fP and \fISDL_DEFAULT_REPEAT_INTERVAL\fP\&.
14.SH "RETURN VALUE"
15.PP
16Returns \fB0\fR on success and \fB-1\fR on failure\&.
17.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59