Mercurial > sdl-ios-xcode
view docs/html/sdlenablekeyrepeat.html @ 302:8a86bdf34f0f
Added Atari joystick support (thanks Patrice!)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Thu, 07 Mar 2002 20:23:11 +0000 |
parents | e5bc29de3f0a |
children | 355632dca928 |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_EnableKeyRepeat</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.64 "><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 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" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlgetmousestate.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLENABLEKEYREPEAT" >SDL_EnableKeyRepeat</A ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN5451" ></A ><H2 >Name</H2 >SDL_EnableKeyRepeat -- Set keyboard repeat rate.</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN5454" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN5455" ></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="AEN5461" ></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="AEN5472" ></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 WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlenableunicode.html" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlgetmousestate.html" >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" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_GetMouseState</TD ></TR ></TABLE ></DIV ></BODY ></HTML >