Main Page | Data Structures | File List | Data Fields | Globals | Related Pages

include/dkey.h File Reference

Interface: debounced key driver. More...

#include <config.h>
#include <tm.h>

Include dependency graph for dkey.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Defines

#define KEY_ONOFF   0x01
 the on/off key is pressed

#define KEY_RUN   0x02
 the run key is pressed

#define KEY_VIEW   0x04
 the view key is pressed

#define KEY_PRGM   0x08
 the program key is pressed

#define KEY_ANY   0x0f
 any of the keys


Functions

wakeup_t dkey_pressed (wakeup_t data)
 wakeup if any of the given keys is pressed.

wakeup_t dkey_released (wakeup_t data)
 wakeup if all of the given keys are released.

int getchar ()
 wait for keypress and return key code.


Variables

volatile unsigned char dkey_multi
 the currently active keys

volatile unsigned char dkey
 the current key


Detailed Description

Interface: debounced key driver.

Author:
Markus L. Noga <markus@noga.de>

Definition in file dkey.h.


Define Documentation

#define KEY_ANY   0x0f
 

any of the keys

Definition at line 49 of file dkey.h.

#define KEY_ONOFF   0x01
 

the on/off key is pressed

Definition at line 44 of file dkey.h.

#define KEY_PRGM   0x08
 

the program key is pressed

Definition at line 47 of file dkey.h.

#define KEY_RUN   0x02
 

the run key is pressed

Definition at line 45 of file dkey.h.

#define KEY_VIEW   0x04
 

the view key is pressed

Definition at line 46 of file dkey.h.


Function Documentation

wakeup_t dkey_pressed wakeup_t  data  ) 
 

wakeup if any of the given keys is pressed.

wakeup_t dkey_released wakeup_t  data  ) 
 

wakeup if all of the given keys are released.

int getchar  ) 
 

wait for keypress and return key code.

key combinations not admissible.


Variable Documentation

volatile unsigned char dkey
 

the current key

this is not a bitmask - at most one key at a time.

Definition at line 65 of file dkey.h.

volatile unsigned char dkey_multi
 

the currently active keys

this is a bitmask - multi-key combinations are admissible.

Definition at line 60 of file dkey.h.


brickOS is released under the Mozilla Public License.
Original code copyright 1998-2002 by the authors.

Generated on Mon Feb 16 21:01:53 2004 for brickOS C by doxygen 1.3.5