documentation example getkeypressedasASCII

cpctelera/src/keyboard/cpct_getKeypressedAsASCII.asm

@@ -97,6 +97,28 @@
 ;; (end code)
 ;; *Note*: Non-standar ASCII characters (>127) in this table will not match Amstrad CPC's characters.
 ;;
+;;    Next code example shows how to use this function in conjunction with <cpct_scanKeyboard>.
+;; Read the keyboard, get the key pressed and return the ASCII value.
+;; (start code)
+;;       u8 key_pressed () {
+;;       u8 key;                                   // declares symbol key 
+;;       cpct_scanKeyboard();                      // read keyboard
+;;       key = cpct_getKeypressedAsASCII ();       // returns the ASCII value associated to the pressed key 
+;;       return key;
+;;       }
+;; (end code)
+;;
+;;    Next code example shows how to use this function in conjunction with <cpct_scanKeyboard>,<cpct_drawCharM1>
+;;    This code scans the keyboard and displays the pressed key in the upper left of the screen.
+;; (start code)
+;;       void print_key(){
+;;       u8 key;                                   // declares symbol key
+;;       cpct_scanKeyboard();                      // read keyboard
+;;       key = cpct_getKeypressedAsASCII();        // returns ASCII value to key symbol
+;;       cpct_drawCharM1 ((u8*)0xc000, key);       // prints on the screen the pressed key 
+;;       }
+;; (end code)
+;;
 ;; Destroyed Register values: 
 ;;    AF, BC, DE, HL
 ;;