Skip to content

Commit 9d64f65

Browse files
committed
Updating documentation with new function get_bank
1 parent d35f56f commit 9d64f65

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# VTUI library Programmers Reference
22

3-
Version 0.9
3+
Version 1.0
44

55
*Author: Jimmy Dansbo*
66

7-
**This is preliminary documentation and can change at any point.**
7+
**Note that this documentation can change at any point.**
88

99
This document describes the **V**ERA **T**ext **U**ser **I**nterface library.
1010

@@ -19,8 +19,11 @@ This document describes the **V**ERA **T**ext **U**ser **I**nterface library.
1919
* [initialize](#function-name-initialize)
2020
* [screen_set](#function-name-screen_set)
2121
* [set_bank](#function-name-set_bank)
22+
* [get_bank](#function-name-get_bank)
2223
* [set_stride](#function-name-set_stride)
24+
* [get_stride](#function-name-get_stride)
2325
* [set_decr](#function-name-set_decr)
26+
* [get_decr](#function-name-get_decr)
2427
* [clr_scr](#function-name-clr_scr)
2528
* [gotoxy](#function-name-gotoxy)
2629
* [plot_char](#function-name-plot_char)
@@ -54,7 +57,7 @@ A cc65 header file and wrapper has recently been developed to ease support in cc
5457

5558
The VTUI library is designed to be loaded by standard CBM kernal functions [SETLFS](https://cx16.dk/c64-kernal-routines/setlfs.html), [SETNAM](https://cx16.dk/c64-kernal-routines/setnam.html) and [LOAD](https://cx16.dk/c64-kernal-routines/load.html).
5659

57-
In several assemblers it is possible to load a binary file directly with the sourcecode. for ACME it is done something like this `VTUI !BIN "VTUI0.9.BIN"` and for CA65 it would be done like this `VTUI .INCBIN "VTUI0.9.BIN"`. The ACME and CA65 include files use this method to load the library.
60+
In several assemblers it is possible to load a binary file directly with the sourcecode. for ACME it is done something like this `VTUI !BIN "VTUI1.0.BIN"` and for CA65 it would be done like this `VTUI .INCBIN "VTUI1.0.BIN"`. The ACME and CA65 include files use this method to load the library.
5861

5962
If an assembler is used to include the binary file, be aware that the first two bytes are a loading address so base address of the actual library will be: `VTUILIB=VTUI+2`.
6063

@@ -128,6 +131,7 @@ ZP registers affected: none<br>
128131
| $04 | 40x15 text |
129132
| $05 | 20x30 text |
130133
| $06 | 20x15 text |
134+
| $FF | Swap 0 & 3 |
131135

132136
Unsupported modes will fail with .C set.
133137

@@ -151,6 +155,22 @@ ZP registers affected: none<br>
151155
|------|-----------------------|
152156
| .C | Single bit bank number (0 or 1) |
153157

158+
## Function name: get_bank
159+
Purpose: Get the current VERA bank<br>
160+
Call address: `VTUILIB+53`<br>
161+
Macro name: `VTUI_GET_BANK`<br>
162+
Routine name: `vtui_get_bank`<br>
163+
Communication registers: .C<br>
164+
Preparatory routines: none<br>
165+
Registers affected: .A<br>
166+
ZP registers affected: none<br>
167+
168+
**Description** Get the current VERA bank (high address bit). The value will be returned in .C either 0 or 1.
169+
170+
|Registers | Purpose |
171+
|------|------------|
172+
| .C | Single bit bank number (0 or 1) |
173+
154174
## Function name: set_stride
155175
Purpose: Set the VERA stride value<br>
156176
Call address: `VTUILIB+8`<br>

0 commit comments

Comments
 (0)