docs/man3/SDL_EnableKeyRepeat.3
author Aaron Wishnick <schnarf@gmail.com>
Wed, 18 Jun 2008 04:51:10 +0000
branchgsoc2008_audio_resampling
changeset 2655 b8e736c8a5a8
parent 2283 546f7c1eb755
child 4311 1238da4a7112
permissions -rw-r--r--
Added beginnings of resampling code.
     1 .TH "SDL_EnableKeyRepeat" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
     2 .SH "NAME"
     3 SDL_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
    11 Enables 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
    13 Setting \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
    16 Returns \fB0\fR on success and \fB-1\fR on failure\&.
    17 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59