84PCE:Syscalls:0207B4 - Revision history

MateoConLechuga at 03:09, 26 May 2015

2015-05-26T03:09:21Z

MateoConLechuga: /* Destroys */

2015-05-26T03:02:36Z

‎Destroys

MateoConLechuga: /* Destroys */

2015-05-26T03:01:56Z

‎Destroys

MateoConLechuga: /* Destroys */

2015-05-26T03:01:38Z

‎Destroys

MateoConLechuga at 03:01, 26 May 2015

2015-05-26T03:01:08Z

MateoConLechuga at 02:59, 26 May 2015

2015-05-26T02:59:31Z

MateoConLechuga: /* Destroys */

2015-05-26T02:45:06Z

‎Destroys

MateoConLechuga: /* Inputs */

2015-05-26T02:43:32Z

‎Inputs

MateoConLechuga: Created page with "PutMap 0207B4 - PutMap == Synopsis == '''Hypothesized Official Name:''' PutMap '''BCALL Address:''' 02..."

2015-05-26T02:41:46Z

Created page with "PutMap 0207B4 - PutMap == Synopsis == '''Hypothesized Official Name:''' PutMap '''BCALL Address:''' 02..."

New page

[[Category:84PCE:BCALLs:By Name|PutMap]]
[[Category:84PCE:BCALLs:By Address|0207B4 - PutMap]]

== Synopsis ==
'''Hypothesized Official Name:''' PutMap

'''BCALL Address:''' 0207B4h

Displays a character in the large (fixed-width) font.

=== Inputs ===
* A = character to display
* ([[84PCE:RAM:8459|curRow]]), ([[84PCE:RAM:845A|curCol]]) = row and column to display the character
* [[84PCE:Flags:4A#Bit_4|putmapDrawColor]] = 1 to use curFGColor/curBGColor (0 to use black/white)
* ([[84PCE:RAM:A015|curFGColor]]) = foreground color
* ([[84PCE:RAM:A017|curBGColor]]) = background color
* [[84PCE:Flags:05#Bit_3|textInverse]] = 1 to swap foreground and background colors
* [[84PCE:Flags:05#Bit_1|textEraseBelow]] = 1 to erase a two-pixel border below the character
* [[84PCE:Flags:08#Bit_0|preClrForMode]] = 1 to erase a two-pixel border to the left of the character
* [[84PCE:Flags:0D#Bit_1|appTextSave]] = 1 to save the character in [[84PCSE:RAM:8560|textShadow]] (and pixel shadow, unless textDisplayOnly set)
* [[84PCE:Flags:4A#Bit_3|putmapUsePixShad2]] = 1 to use the secondary pixel shadow buffer
* [[84PCE:Flags:4C#Bit_5|textDisplayOnly]] = 1 to disable use of the pixel shadow buffer
* LCD output mode is assumed to be row major, left to right, top to bottom (R03 = 1038h), and the window assumed to be full height (R50 = 0, R51 = 239)

=== Outputs ===
* Character displayed
* preClrForMode cleared
* LCD output window reset to full width (R52 = 0, R53 = 319)
* If appTextSave set, character stored at the appropriate address in textShadow
* If appTextSave set and textDisplayOnly cleared, character bitmap drawn in the appropriate pixel shadow buffer

=== Destroys ===
* Interrupts disabled
* [[84PCE:Hooks:9E7D|Font hook]] and [[84PCE:Hooks:9EAD|Localize hook]] are called
* [[84PCE:RAM:845F|curY]]
* [[84PCE:RAM:8462|curXRow]]
* [[84PCE:RAM:8463|lFont_record]]
* [[84PCE:RAM:A5A0|A5A0h]] (2 bytes)
* [[84PCE:RAM:A5A4|A5A4h]] (1 byte)

== Comments ==
This routine is called by all of the other fixed-width text display routines, so the flags and variables listed above will also affect, e.g., [[84PCSE:BCALLs:4501|PutS]]. In contrast to most text display routines, this routine does not change curRow/curCol (and does not handle $D6, the newline character, in any special way.)

PutMap will "draw" the input character in up to three places: the LCD itself, the textShadow buffer (which stores the ASCII characters drawn on screen), and the current pixel shadow buffer (which stores a 1-bit image of the current screen contents.) The effect of the flags is shown below:

{|
|-
! TextSave !! DisplayOnly !! UsePixShad2 !! Effect
|-
| 0 || * || * || Draw to LCD only
|-
| 1 || 1 || * || Draw to LCD and [[84PCSE:RAM:8560|textShadow]]
|-
| 1 || 0 || 0 || Draw to LCD, textShadow, and [[84PCSE:RAM:Page3:8941|pixelShadow]]
|-
| 1 || 0 || 1 || Draw to LCD, textShadow, and [[84PCSE:RAM:Page3:AA11|pixelShadow2]]
|}

Note that the putmapDrawColor flag and curFGColor/curBGColor have no effect on what is drawn in the pixel shadow - only textInverse has any effect on that. So if you draw some colored text and the screen is later scrolled, it will always be redrawn in black and white.

Clearing appTextSave, or setting textDisplayOnly, will speed up text display significantly, at the cost of making ScrollUp/ScrollDown not work correctly. For some programs, it may be better to do this, and implement scrolling yourself if need be. You will also want to do so if you intend to use the pixel shadow buffer(s) as scratch memory.

The right and top borders of the character are always drawn. If textInverse is cleared, the left border will be drawn only if preClrForMode is set, and the bottom border will be drawn only if textEraseBelow is set. If textInverse is set, all four borders will always be drawn. Note that preClrForMode is always cleared after displaying a character.

@@ Line 32: / Line 32: @@
 === Destroys ===
 * Interrupts disabled
-* [[84PCE:Hooks:9E7D|Font hook]] and [[84PCE:Hooks:9EAD|Localize hook]] are called
+* [[84PCE:Hooks:020130|Font hook]] and [[84PCE:Hooks:020134|Localize hook]] are called
 * [[84PCE:RAM:D00599|curY]]
 * [[84PCE:RAM:D0059C|curXRow]]

@@ Line 35: / Line 35: @@
 * [[84PCE:RAM:D00599|curY]]
 * [[84PCE:RAM:D0059C|curXRow]]
-* [[84PCE:RAM:8463|lFont_record]]
+* [[84PCE:RAM:D005A4|lFont_record]]
 == Comments ==

@@ Line 52: / Line 52: @@
 | 1 || 1 || * || Draw to LCD and [[84PCE:RAM:D006C0|textShadow]]
 |-
-| 1 || 0 || 0 || Draw to LCD, textShadow, and [[84PCE:RAM:8941|pixelShadow]]
+| 1 || 0 || 0 || Draw to LCD, textShadow, and [[84PCE:RAM:D031F6:|pixelShadow]]
 |-
-| 1 || 0 || 1 || Draw to LCD, textShadow, and [[84PCE:RAM:AA11|pixelShadow2]]
+| 1 || 0 || 1 || Draw to LCD, textShadow, and [[84PCE:RAM:D052C6:|pixelShadow2]]
 |}

@@ Line 1: / Line 1: @@
-[[Category:84PCE:BCALLs:By Name|PutMap]]
+[[Category:84PCE:Syscalls:By Name|PutMap]]
-[[Category:84PCE:BCALLs:By Address|0207B4 - PutMap]]
+[[Category:84PCE:Syscalls:By Address|0207B4 - PutMap]]
 == Synopsis ==
 '''Hypothesized Official Name:''' PutMap
-'''BCALL Address:''' 0207B4h
+'''Syscall Address:''' 0207B4h
 Displays a character in the large (fixed-width) font.

@@ Line 18: / Line 18: @@
 * [[84PCE:Flags:05#Bit_1|textEraseBelow]] = 1 to erase a two-pixel border below the character
 * [[84PCE:Flags:08#Bit_0|preClrForMode]] = 1 to erase a two-pixel border to the left of the character
-* [[84PCE:Flags:0D#Bit_1|appTextSave]] = 1 to save the character in [[84PCE:RAM:8560|textShadow]] (and pixel shadow, unless textDisplayOnly set)
+* [[84PCE:Flags:0D#Bit_1|appTextSave]] = 1 to save the character in [[84PCE:RAM:D006C0|textShadow]] (and pixel shadow, unless textDisplayOnly set)
 * [[84PCE:Flags:4A#Bit_3|putmapUsePixShad2]] = 1 to use the secondary pixel shadow buffer
 * [[84PCE:Flags:4C#Bit_5|textDisplayOnly]] = 1 to disable use of the pixel shadow buffer
@@ Line 50: / Line 50: @@
 | 0 || * || * || Draw to LCD only
 |-
-| 1 || 1 || * || Draw to LCD and [[84PCSE:RAM:8560|textShadow]]
+| 1 || 1 || * || Draw to LCD and [[84PCE:RAM:D006C0|textShadow]]
 |-
-| 1 || 0 || 0 || Draw to LCD, textShadow, and [[84PCSE:RAM:Page3:8941|pixelShadow]]
+| 1 || 0 || 0 || Draw to LCD, textShadow, and [[84PCE:RAM:8941|pixelShadow]]
 |-
-| 1 || 0 || 1 || Draw to LCD, textShadow, and [[84PCSE:RAM:Page3:AA11|pixelShadow2]]
+| 1 || 0 || 1 || Draw to LCD, textShadow, and [[84PCE:RAM:AA11|pixelShadow2]]
 |}

@@ Line 11: / Line 11: @@
 === Inputs ===
 * A = character to display
-* ([[84PCE:RAM:8459|curRow]]), ([[84PCE:RAM:845A|curCol]]) = row and column to display the character
+* ([[84PCE:RAM:D00595|curRow]]), ([[84PCE:RAM:D00596|curCol]]) = Row and column to display the character
 * [[84PCE:Flags:4A#Bit_4|putmapDrawColor]] = 1 to use curFGColor/curBGColor (0 to use black/white)
-* ([[84PCE:RAM:A015|curFGColor]]) = foreground color
+* ([[84PCE:RAM:D0268A|textFGColor]]) = Foreground color
-* ([[84PCE:RAM:A017|curBGColor]]) = background color
+* ([[84PCE:RAM:D02688|textBGColor]]) = Background color
 * [[84PCE:Flags:05#Bit_3|textInverse]] = 1 to swap foreground and background colors
 * [[84PCE:Flags:05#Bit_1|textEraseBelow]] = 1 to erase a two-pixel border below the character
 * [[84PCE:Flags:08#Bit_0|preClrForMode]] = 1 to erase a two-pixel border to the left of the character
-* [[84PCE:Flags:0D#Bit_1|appTextSave]] = 1 to save the character in [[84PCSE:RAM:8560|textShadow]] (and pixel shadow, unless textDisplayOnly set)
+* [[84PCE:Flags:0D#Bit_1|appTextSave]] = 1 to save the character in [[84PCE:RAM:8560|textShadow]] (and pixel shadow, unless textDisplayOnly set)
 * [[84PCE:Flags:4A#Bit_3|putmapUsePixShad2]] = 1 to use the secondary pixel shadow buffer
 * [[84PCE:Flags:4C#Bit_5|textDisplayOnly]] = 1 to disable use of the pixel shadow buffer