Libndls: Difference between revisions
Jump to navigation
Jump to search
(→Keyboard: Touchpad API) |
m (Typos) |
||
Line 1: | Line 1: | ||
''libndls'' is a set of macros and functions available as a [http://en.wikipedia.org/wiki/Static_library static library] when building with Ndless. The library is automatically linked by <tt>nspire-ld</tt> if required. | ''libndls'' is a set of macros and functions available as a [http://en.wikipedia.org/wiki/Static_library static library] when building with Ndless. The library is automatically linked by <tt>nspire-ld</tt> if required. | ||
These definitions are available in Ndless | These definitions are available in Ndless 2.0. Definitions marked with (asm) are only available in assembly. | ||
==Common types== | ==Common types== | ||
Line 20: | Line 20: | ||
*<tt>SCREEN_WIDTH</tt>: screen width in pixels | *<tt>SCREEN_WIDTH</tt>: screen width in pixels | ||
*<tt>SCREEN_HEIGHT</tt>: screen height in pixels | *<tt>SCREEN_HEIGHT</tt>: screen height in pixels | ||
*<tt>void clrscr(void</tt>): | *<tt>void clrscr(void</tt>): clear the screen | ||
==UI== | ==UI== | ||
Line 34: | Line 34: | ||
==CPU== | ==CPU== | ||
*<tt>void clear_cache(void)</tt>: | *<tt>void clear_cache(void)</tt>: flush the data cache and invalidate the instruction and data caches of the processor. Should be called before loading code dynamically, after a code patch or with self-modifying code. | ||
==Hardware== | ==Hardware== | ||
Line 44: | Line 44: | ||
==Debugging== | ==Debugging== | ||
*<tt>void halt(void)</tt>: | *<tt>void halt(void)</tt>: stop the execution flow with an endless loop. If you are using the [http://www.omnimaga.org/index.php?topic=4280.0 Ncubate] emulator, use the <tt>j</tt> debugger command to jump over the instruction. | ||
*<tt>halt</tt> (asm) (macro): similar to <tt>halt()</tt> | *<tt>halt</tt> (asm) (macro): similar to <tt>halt()</tt> |
Revision as of 14:53, 4 March 2011
libndls is a set of macros and functions available as a static library when building with Ndless. The library is automatically linked by nspire-ld if required.
These definitions are available in Ndless 2.0. Definitions marked with (asm) are only available in assembly.
Common types
- typedef enum bool {FALSE = 0, TRUE = 1} BOOL;
Data manipulation
- uint16_t bswap16(uint16_t): swap the bytes of a 2-bytes integer
- uint32_t bswap32(uint32_t): swap the bytes of a 4-bytes integer
Math
- number abs(number)
- number min(number, number)
- number max(number, number)
Screen
- SCREEN_BASE_ADDRESS: address of the screen buffer. Each grayscaled pixel is 4-bit long. 1111 is white, 0000 is black.
- SCREEN_BYTES_SIZE: size of the screen buffer
- SCREEN_WIDTH: screen width in pixels
- SCREEN_HEIGHT: screen height in pixels
- void clrscr(void): clear the screen
UI
- void show_msgbox(const char *title, const char *msg): show a message box, with a single button OK"
Keyboard
- BOOL any_key_pressed(void): non-blocking key press test. Return TRUE if one or more keys are being pressed.
- BOOL isKeyPressed(key): non-blocking key press test. key must be one of the KEY_NSPIRE_* constants defined in include/common.h.
- void wait_key_pressed(void): block until a key is pressed
- void wait_no_key_pressed(void): block until all the keys are released
- touchpad_info_t *touchpad_getinfo(void): return information on the Touchpad area such as its dimension. Return NULL if not a TI-Nspire Touchpad. See include/libndls.h for the definition of touchpad_info_t.
- int touchpad_scan(touchpad_report_t *report): check user interactions with the Touchpad area and writes to report. See include/libndls.h for the definition of touchpad_report_t. report->contact is always FALSE on TI-Nspire Clickpad. See src/arm/tests/ndless_tpad.c for an example of use.
CPU
- void clear_cache(void): flush the data cache and invalidate the instruction and data caches of the processor. Should be called before loading code dynamically, after a code patch or with self-modifying code.
Hardware
BOOL is_touchpad : TRUE on a TI-Nspire Touchpad.
Time
- void idle(void): switch to low-power state until the next interrupt occurs. The use of this function is encouraged when waiting in loops for an event to save the batteries.
- void sleep(unsigned m): delay for a specified amount of time. The CPU is regularly switched to low-power state while blocking.
Debugging
- void halt(void): stop the execution flow with an endless loop. If you are using the Ncubate emulator, use the j debugger command to jump over the instruction.
- halt (asm) (macro): similar to halt()