Modules/print/Usage - Revision history

Aoineko at 16:39, 13 January 2025

2025-01-13T16:39:40Z

Aoineko: /* Sprites */

2025-01-13T16:38:46Z

‎Sprites

Aoineko: /* Font mode compatibility matrix */

2025-01-13T16:34:52Z

‎Font mode compatibility matrix

Aoineko: /* Font mode compatibility matrix */

2025-01-13T16:34:27Z

‎Font mode compatibility matrix

Aoineko: /* Font mode compatibility matrix */

2025-01-13T16:34:11Z

‎Font mode compatibility matrix

Aoineko at 16:33, 13 January 2025

2025-01-13T16:33:24Z

Aoineko at 16:27, 13 January 2025

2025-01-13T16:27:29Z

Aoineko at 16:25, 13 January 2025

2025-01-13T16:25:01Z

Aoineko at 16:15, 13 January 2025

2025-01-13T16:15:47Z

Aoineko at 16:04, 13 January 2025

2025-01-13T16:04:20Z

← Older revision		Revision as of 16:39, 13 January 2025
Line 1:		Line 1:
−	Use of this module begins with the initialization of a font. Then you can use all the functions to ~~display~~ text.	+	Use of this module begins with the initialization of a font. Then you can use all the functions to draw text on screen.

	=== Modes ===		=== Modes ===

@@ Line 76: / Line 76: @@
 Requirement:
-* Compatible with all sprite enabled screen modes: Screen 1 to 8.
+* Compatible with all sprite enabled screen modes:
 * You need to activate {{C|PRINT_USE_SPRITE}} compile option in your library configuration ({{C|msxgl_config.h}}).

@@ Line 89: / Line 89: @@
 </syntaxhighlight>
-=== Font mode compatibility matrix ===
+=== Font modes compatibility matrix ===
 {| class="wikitable"

← Older revision		Revision as of 16:34, 13 January 2025
Line 105:		Line 105:
	\| Sprites \|\| ❌ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️		\| Sprites \|\| ❌ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️
	\|}		\|}
−
−
−	~~// > PRINT_MODE_TEXT Draw characters as pattern names (text mode). Need PRINT_USE_TEXT compile option.~~
−	~~// > PRINT_MODE_BITMAP Draw characters from RAM (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.~~
−	~~// > PRINT_MODE_BITMAP_TRANS Draw characters from RAM with transparency (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.~~
−	~~// > PRINT_MODE_BITMAP_VRAM Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.~~
−	~~// > PRINT_MODE_SPRITE Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system). Need PRINT_USE_SPRITE compile option.~~

@@ Line 99: / Line 99: @@
 | Text || ✔️ || ✔️ || ✔️ || ❌ || ✔️ || ❌ || ❌ || ❌ || ❌ || ❌ || ❌
 |-
-| Bitmap|| ❌ || ❌ || ❌ || ❌ || ❌ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️
+| Bitmap|| ❌ || ❌ || ❌ || ❌ || ❌ || ✔️ || ✔️ || ✔️ || ✔️ || ❔ || ❔
 |-
-| VRAM || ❌ || ❌ || ❌ || ❌ || ❌ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️
+| VRAM || ❌ || ❌ || ❌ || ❌ || ❌ || ✔️ || ✔️ || ✔️ || ✔️ || ❔ || ❔
 |-
 | Sprites || ❌ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️ || ✔️

← Older revision		Revision as of 16:33, 13 January 2025
Line 90:		Line 90:

	=== Font mode compatibility matrix ===		=== Font mode compatibility matrix ===
		+
		+	{\| class="wikitable"
		+	!rowspan="2"\| Font mode
		+	!colspan="11"\| Screen modes
		+	\|-
		+	! 0 \|\| 1 \|\| 2 \|\| 3 \|\| 4 \|\| 5 \|\| 6 \|\| 7 \|\| 8 \|\| 10 \|\| 12
		+	\|-
		+	\| Text \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ❌ \|\| ✔️ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌
		+	\|-
		+	\| Bitmap\|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️
		+	\|-
		+	\| VRAM \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ❌ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️
		+	\|-
		+	\| Sprites \|\| ❌ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️ \|\| ✔️
		+	\|}
		+
		+
		+	// > PRINT_MODE_TEXT Draw characters as pattern names (text mode). Need PRINT_USE_TEXT compile option.
		+	// > PRINT_MODE_BITMAP Draw characters from RAM (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.
		+	// > PRINT_MODE_BITMAP_TRANS Draw characters from RAM with transparency (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.
		+	// > PRINT_MODE_BITMAP_VRAM Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.
		+	// > PRINT_MODE_SPRITE Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system). Need PRINT_USE_SPRITE compile option.

@@ Line 22: / Line 22: @@
 ==== Bitmap ====
-Draw characters from RAM (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.
+Draw characters from RAM (real-time unpack font data and draw it).
 Requirement:
@@ Line 40: / Line 40: @@
 ==== Bitmap with transparency ====
-Draw characters from RAM with transparency (R-T unpack font data and draw it).
+Draw characters from RAM with transparency (real-time unpack font data and draw it).
 Same mode than Bitmap but a little bit slower.
@@ Line 56: / Line 56: @@
 ==== VRAM ====
-Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.
+Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy).
-slower to initialize, quicker to draw
+slower to initialize, far quicker to draw.
 Example using bitmap render mode for MSX2:
@@ Line 70: / Line 73: @@
 ==== Sprites ====
-Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system). Need PRINT_USE_SPRITE compile option.
+Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system).
 Example using sprite render mode:

@@ Line 40: / Line 40: @@
 ==== Bitmap with transparency ====
-// > PRINT_MODE_BITMAP_TRANS    Draw characters from RAM with transparency (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.
+Can be activated using:
-// > PRINT_MODE_BITMAP_VRAM     Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.
+<syntaxhighlight lang="c">
-// > PRINT_MODE_SPRITE          Draw characters from sprites (load font data as sprite pattern in VRAM then display characters using sprite system). Need PRINT_USE_SPRITE compile option.
+#include "font/font_mgl_sample6.h"
-* Bitmap (draw text from RAM to VRAM for bitmap screen modes),
+==== VRAM ====
-** Bitmap with transparency.
+Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.
-* VRAM (put font on VRAM and draw from there; slower to initialize, quicker to draw),
+slower to initialize, quicker to draw
@@ Line 56: / Line 63: @@
 <syntaxhighlight lang="c">
 #include "font/font_mgl_sample6.h"
 Print_SetVRAMFont(g_Font_MGL_Sample6, 212, COLOR_WHITE);
@@ Line 67: / Line 68: @@
 Print_DrawText("VRAM mode");
 </syntaxhighlight>
 Example using sprite render mode:

@@ Line 5: / Line 5: @@
 ==== Text ====
-Draw characters as pattern names (text mode). Need {{C|PRINT_USE_TEXT}} compile option.
+Draw characters as pattern names (text mode).
 // > PRINT_MODE_BITMAP_TRANS    Draw characters from RAM with transparency (R-T unpack font data and draw it). Need PRINT_USE_BITMAP or PRINT_USE_VRAM compile option.
 // > PRINT_MODE_BITMAP_VRAM     Draw characters from VRAM (font data is upack once in VRAM thne drawing is done by VRAM copy). Need PRINT_USE_VRAM compile option.
@@ Line 13: / Line 47: @@
 * Bitmap (draw text from RAM to VRAM for bitmap screen modes),
 ** Bitmap with transparency.
@@ Line 19: / Line 52: @@
 * Sprite (draw text using sprites).
 Example using bitmap render mode for MSX2:

@@ Line 1: / Line 1: @@
 Use of this module begins with the initialization of a font. Then you can use all the functions to display text.
-You have several render mode:
+=== Modes ===
 * Text (using tiles/characters set for tiled-based screen modes),
 * Bitmap (draw text from RAM to VRAM for bitmap screen modes),
@@ Line 42: / Line 53: @@
 Print_DrawText("SPRT");
 </syntaxhighlight>