Copyright (c) 2013 Tristan Louet

This file is part of sdlKeyBinder.

sdlKeyBinder is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

sdlKeyBinder is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. you should have received a copy of the GNU General Public License along with sdlKeyBinder. If not, see http://www.gnu.org/licenses/.

Please report any bug to tristan.louet.dev@gmail.com Please also feel free to ask any question or make any suggestion at the same email address. I'll also be glad to know of every modification you made for your own usage that I could implement too !

Please write [SKB] at the beginning of your mail object so I can know what's the pupose of it.

What is this library ?

The purpose of this library written in C is to provide a tool helping handle of the keyboard inputs while using the SDL.

You can have a keyBinder typed variable that you have to update at each SDL_KEYUP or SDL_KEYDOWN event so that it can keep for you the information of each key that is down or up. You can see an example of using keyBinders in that way in "example.c".

As you will see, testing if a key is currently pressed is as simple as calling to skbIsPressed(), assuming you correctly called skbKeyPressed() and skbKeyReleased when it was necessary.

The second fonctionality of a keyBinder is key-handlers functions. By calling skbBindKeyHandler(keyBinder kb, int key, (*keyHandler)(void)), you can inform the keyBinder that the function "keyHandler" has to be called every time the function skbHandle(kb) is used but ONLY IF the skbIsPressed(kb, key) returns 1.