examples: Add example of loading rich text fonts from RAM

examples/text/font_from_ram/Makefile

@@ -0,0 +1,220 @@
+#---------------------------------------------------------------------------------
+.SUFFIXES:
+#---------------------------------------------------------------------------------
+
+ifeq ($(strip $(DEVKITARM)),)
+$(error "Please set DEVKITARM in your environment. export DEVKITARM=<path to>devkitARM")
+endif
+
+include $(DEVKITARM)/ds_rules
+
+#---------------------------------------------------------------------------------
+# TARGET is the name of the output
+# BUILD is the directory where object files & intermediate files will be placed
+# SOURCES is a list of directories containing source code
+# INCLUDES is a list of directories containing extra header files
+# DATA is a list of directories containing binary files embedded using bin2o
+# GRAPHICS is a list of directories containing image files to be converted with grit
+# AUDIO is a list of directories containing audio to be converted by maxmod
+# ICON is the image used to create the game icon, leave blank to use default rule
+# NITRO is a directory that will be accessible via NitroFS
+#---------------------------------------------------------------------------------
+TARGET   := $(shell basename $(CURDIR))
+BUILD    := build
+SOURCES  := source
+INCLUDES := include
+DATA     := data
+GRAPHICS := graphics
+AUDIO    :=
+ICON     :=
+
+# specify a directory which contains the nitro filesystem
+# this is relative to the Makefile
+NITRO    :=
+
+# These set the information text in the nds file
+GAME_TITLE     := $(shell basename $(CURDIR))
+GAME_SUBTITLE1 := Nitro Engine example
+GAME_SUBTITLE2 := github.com/AntonioND/nitro-engine
+
+#---------------------------------------------------------------------------------
+# options for code generation
+#---------------------------------------------------------------------------------
+ARCH := -marm -mthumb-interwork -march=armv5te -mtune=arm946e-s
+
+CFLAGS   := -g -Wall -O3\
+            $(ARCH) $(INCLUDE) -DARM9
+CXXFLAGS := $(CFLAGS) -fno-rtti -fno-exceptions
+ASFLAGS  := -g $(ARCH)
+LDFLAGS   = -specs=ds_arm9.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map)
+
+#---------------------------------------------------------------------------------
+# any extra libraries we wish to link with the project (order is important)
+#---------------------------------------------------------------------------------
+LIBS := -lNE -lfat -lnds9
+
+# automatigically add libraries for NitroFS
+ifneq ($(strip $(NITRO)),)
+LIBS := -lfilesystem -lfat $(LIBS)
+endif
+# automagically add maxmod library
+ifneq ($(strip $(AUDIO)),)
+LIBS := -lmm9 $(LIBS)
+endif
+
+#---------------------------------------------------------------------------------
+# list of directories containing libraries, this must be the top level containing
+# include and lib
+#---------------------------------------------------------------------------------
+LIBDIRS := $(LIBNDS) $(PORTLIBS) $(DEVKITPRO)/nitro-engine
+
+#---------------------------------------------------------------------------------
+# no real need to edit anything past this point unless you need to add additional
+# rules for different file extensions
+#---------------------------------------------------------------------------------
+ifneq ($(BUILD),$(notdir $(CURDIR)))
+#---------------------------------------------------------------------------------
+
+export OUTPUT := $(CURDIR)/$(TARGET)
+
+export VPATH := $(CURDIR)/$(subst /,,$(dir $(ICON)))\
+                $(foreach dir,$(SOURCES),$(CURDIR)/$(dir))\
+                $(foreach dir,$(DATA),$(CURDIR)/$(dir))\
+                $(foreach dir,$(GRAPHICS),$(CURDIR)/$(dir))
+
+export DEPSDIR := $(CURDIR)/$(BUILD)
+
+CFILES   := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c)))
+CPPFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.cpp)))
+SFILES   := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.s)))
+PNGFILES := $(foreach dir,$(GRAPHICS),$(notdir $(wildcard $(dir)/*.png)))
+BINFILES := $(foreach dir,$(DATA),$(notdir $(wildcard $(dir)/*.*)))
+
+# prepare NitroFS directory
+ifneq ($(strip $(NITRO)),)
+  export NITRO_FILES := $(CURDIR)/$(NITRO)
+endif
+
+# get audio list for maxmod
+ifneq ($(strip $(AUDIO)),)
+  export MODFILES	:=	$(foreach dir,$(notdir $(wildcard $(AUDIO)/*.*)),$(CURDIR)/$(AUDIO)/$(dir))
+
+  # place the soundbank file in NitroFS if using it
+  ifneq ($(strip $(NITRO)),)
+    export SOUNDBANK := $(NITRO_FILES)/soundbank.bin
+
+  # otherwise, needs to be loaded from memory
+  else
+    export SOUNDBANK := soundbank.bin
+    BINFILES += $(SOUNDBANK)
+  endif
+endif
+
+#---------------------------------------------------------------------------------
+# use CXX for linking C++ projects, CC for standard C
+#---------------------------------------------------------------------------------
+ifeq ($(strip $(CPPFILES)),)
+#---------------------------------------------------------------------------------
+  export LD := $(CC)
+#---------------------------------------------------------------------------------
+else
+#---------------------------------------------------------------------------------
+  export LD := $(CXX)
+#---------------------------------------------------------------------------------
+endif
+#---------------------------------------------------------------------------------
+
+export OFILES_BIN   :=	$(addsuffix .o,$(BINFILES))
+
+export OFILES_SOURCES := $(CPPFILES:.cpp=.o) $(CFILES:.c=.o) $(SFILES:.s=.o)
+
+export OFILES := $(PNGFILES:.png=.o) $(OFILES_BIN) $(OFILES_SOURCES)
+
+export HFILES := $(PNGFILES:.png=.h) $(addsuffix .h,$(subst .,_,$(BINFILES)))
+
+export INCLUDE  := $(foreach dir,$(INCLUDES),-iquote $(CURDIR)/$(dir))\
+                   $(foreach dir,$(LIBDIRS),-I$(dir)/include)\
+                   -I$(CURDIR)/$(BUILD)
+export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib)
+
+ifeq ($(strip $(ICON)),)
+  icons := $(wildcard *.bmp)
+
+  ifneq (,$(findstring $(TARGET).bmp,$(icons)))
+    export GAME_ICON := $(CURDIR)/$(TARGET).bmp
+  else
+    ifneq (,$(findstring icon.bmp,$(icons)))
+      export GAME_ICON := $(CURDIR)/icon.bmp
+    endif
+  endif
+else
+  ifeq ($(suffix $(ICON)), .grf)
+    export GAME_ICON := $(CURDIR)/$(ICON)
+  else
+    export GAME_ICON := $(CURDIR)/$(BUILD)/$(notdir $(basename $(ICON))).grf
+  endif
+endif
+
+.PHONY: $(BUILD) clean
+
+#---------------------------------------------------------------------------------
+$(BUILD):
+	@mkdir -p $@
+	@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
+
+#---------------------------------------------------------------------------------
+clean:
+	@echo clean ...
+	@rm -fr $(BUILD) $(TARGET).elf $(TARGET).nds $(SOUNDBANK)
+
+#---------------------------------------------------------------------------------
+else
+
+#---------------------------------------------------------------------------------
+# main targets
+#---------------------------------------------------------------------------------
+$(OUTPUT).nds: $(OUTPUT).elf $(GAME_ICON)
+$(OUTPUT).elf: $(OFILES)
+
+# source files depend on generated headers
+$(OFILES_SOURCES) : $(HFILES)
+
+# need to build soundbank first
+$(OFILES): $(SOUNDBANK)
+
+#---------------------------------------------------------------------------------
+# rule to build solution from music files
+#---------------------------------------------------------------------------------
+$(SOUNDBANK) : $(MODFILES)
+#---------------------------------------------------------------------------------
+	mmutil $^ -d -o$@ -hsoundbank.h
+
+#---------------------------------------------------------------------------------
+%.bin.o %_bin.h : %.bin
+#---------------------------------------------------------------------------------
+	@echo $(notdir $<)
+	@$(bin2o)
+
+#---------------------------------------------------------------------------------
+# This rule creates assembly source files using grit
+# grit takes an image file and a .grit describing how the file is to be processed
+# add additional rules like this for each image extension
+# you use in the graphics folders
+#---------------------------------------------------------------------------------
+%.s %.h: %.png %.grit
+#---------------------------------------------------------------------------------
+	grit $< -fts -o$*
+
+#---------------------------------------------------------------------------------
+# Convert non-GRF game icon to GRF if needed
+#---------------------------------------------------------------------------------
+$(GAME_ICON): $(notdir $(ICON))
+#---------------------------------------------------------------------------------
+	@echo convert $(notdir $<)
+	@grit $< -g -gt -gB4 -gT FF00FF -m! -p -pe 16 -fh! -ftr
+
+-include $(DEPSDIR)/*.d
+
+#---------------------------------------------------------------------------------------
+endif
+#---------------------------------------------------------------------------------------

examples/text/font_from_ram/Makefile.blocksds

@@ -0,0 +1,7 @@
+# This is a minimal makefile only used for the examples. If you want a makefile
+# for your project, take one from the templates inside examples/templates.
+
+GFXDIRS	:= graphics
+BINDIRS	:= data
+
+include ../../Makefile.example.blocksds

examples/text/font_from_ram/font.bmfc

@@ -0,0 +1,59 @@
+# AngelCode Bitmap Font Generator configuration file
+fileVersion=1
+
+# font settings
+fontName=DejaVu Sans
+fontFile=
+charSet=0
+fontSize=32
+aa=1
+scaleH=100
+useSmoothing=1
+isBold=0
+isItalic=0
+useUnicode=1
+disableBoxChars=1
+outputInvalidCharGlyph=0
+dontIncludeKerningPairs=0
+useHinting=1
+renderFromOutline=0
+useClearType=1
+autoFitNumPages=0
+autoFitFontSizeMin=0
+autoFitFontSizeMax=0
+
+# character alignment
+paddingDown=0
+paddingUp=0
+paddingRight=0
+paddingLeft=0
+spacingHoriz=1
+spacingVert=1
+useFixedHeight=0
+forceZero=0
+widthPaddingFactor=0.00
+
+# output file
+outWidth=256
+outHeight=256
+outBitDepth=8
+fontDescFormat=2
+fourChnlPacked=0
+textureFormat=png
+textureCompression=0
+alphaChnl=1
+redChnl=0
+greenChnl=0
+blueChnl=0
+invA=0
+invR=0
+invG=0
+invB=0
+
+# outline
+outlineThickness=0
+
+# selected chars
+chars=32-126,160-255,65529-65533
+
+# imported icon images

examples/text/font_from_ram/graphics/font_16.grit

@@ -0,0 +1,2 @@
+# 16-color texture, set black as transparent color
+-gx -gb -gB4 -gT000000

examples/text/font_from_ram/graphics/font_256.grit

@@ -0,0 +1,2 @@
+# 256-color texture, set black as transparent color
+-gx -gb -gB8 -gT000000

examples/text/font_from_ram/source/main.c

@@ -0,0 +1,126 @@
+// SPDX-License-Identifier: CC0-1.0
+//
+// SPDX-FileContributor: Antonio Niño Díaz, 2024
+
+#include <stdio.h>
+
+#include <nds.h>
+#include <NEMain.h>
+
+#include "font_fnt_bin.h"
+#include "font_16.h"
+#include "font_256.h"
+
+NE_Sprite *TextSprite;
+
+void Draw3DScene(void)
+{
+    NE_ClearColorSet(RGB15(0, 7, 7), 31, 63);
+
+    NE_2DViewInit();
+
+    NE_RichTextRender3D(3, "VAWATa\ntajl", 0, 0);
+
+    NE_RichTextRender3DAlpha(2, "Text with alpha", 10, 80,
+                             POLY_ALPHA(20) | POLY_CULL_BACK, 30);
+}
+
+void Draw3DScene2(void)
+{
+    NE_ClearColorSet(RGB15(7, 0, 7), 31, 63);
+
+    NE_2DViewInit();
+
+    NE_SpriteSetPos(TextSprite, 16, 32);
+    NE_SpriteDraw(TextSprite);
+}
+
+int main(void)
+{
+    irqEnable(IRQ_HBLANK);
+    irqSet(IRQ_VBLANK, NE_VBLFunc);
+    irqSet(IRQ_HBLANK, NE_HBLFunc);
+
+    // Init 3D mode
+    NE_InitDual3D();
+    NE_InitConsole();
+
+    // Load a 16-color font to be used for rendering text as quads
+
+    NE_RichTextInit(2);
+    NE_RichTextMetadataLoadMemory(2, font_fnt_bin, font_fnt_bin_size);
+
+    {
+        NE_Material *Font16 = NE_MaterialCreate();
+        NE_MaterialTexLoad(Font16, NE_PAL16, 256, 256,
+                           NE_TEXGEN_TEXCOORD | NE_TEXTURE_COLOR0_TRANSPARENT,
+                           font_16Bitmap);
+
+        NE_Palette *Pal16 = NE_PaletteCreate();
+        NE_PaletteLoad(Pal16, font_16Pal, 16, NE_PAL16);
+
+        NE_MaterialSetPalette(Font16, Pal16);
+
+        NE_RichTextMaterialSet(2, Font16, Pal16);
+    }
+
+    // Load a 256-color font to be used for rendering text as quads
+
+    NE_RichTextInit(3);
+    NE_RichTextMetadataLoadMemory(3, font_fnt_bin, font_fnt_bin_size);
+
+    {
+        NE_Material *Font256 = NE_MaterialCreate();
+        NE_MaterialTexLoad(Font256, NE_PAL256, 256, 256,
+                           NE_TEXGEN_TEXCOORD | NE_TEXTURE_COLOR0_TRANSPARENT,
+                           font_256Bitmap);
+
+        NE_Palette *Pal256 = NE_PaletteCreate();
+        NE_PaletteLoad(Pal256, font_256Pal, 256, NE_PAL256);
+
+        NE_MaterialSetPalette(Font256, Pal256);
+
+        NE_RichTextMaterialSet(3, Font256, Pal256);
+    }
+
+    // Load a 16-color font to be used for rendering text to textures.
+
+    NE_RichTextInit(5);
+    NE_RichTextMetadataLoadMemory(5, font_fnt_bin, font_fnt_bin_size);
+    NE_RichTextBitmapSet(5, font_16Bitmap, 256, 256, NE_PAL16,
+                         font_16Pal, font_16PalLen);
+
+    // Render text to a texture using the last font we've loaded
+
+    // We don't care about the palette, passing NULL will mark the palette
+    // to be autodeleted when the material is deleted.
+    NE_Material *Material = NULL;
+    NE_RichTextRenderMaterial(5,
+                "Sample: AWAV.\nÿ_ßðñÑü(o´Áá)|\nInvalid char: ŋ",
+                &Material, NULL);
+
+    // Create a sprite to be used to render the texture we've rendered
+
+    TextSprite = NE_SpriteCreate();
+    NE_SpriteSetMaterial(TextSprite, Material);
+
+    while (1)
+    {
+        NE_WaitForVBL(0);
+
+        NE_ProcessDual(Draw3DScene, Draw3DScene2);
+
+        scanKeys();
+        if (keysHeld() & KEY_START)
+            break;
+    }
+
+    NE_SpriteDelete(TextSprite);
+    NE_MaterialDelete(Material);
+
+    NE_RichTextEnd(2);
+    NE_RichTextEnd(3);
+    NE_RichTextEnd(5);
+
+    return 0;
+}