Tutorial 05: Fonts

Overview

This tutorial extends Tutorial 04 with bitmap and built-in fonts. It adds a bitmap Font and its Image to the shared Tutorial.cdc, reloads the runtime resources, and compares all embedded Arial and Courier New variants.

It also demonstrates text positioning, a text cursor, scaling, color modulation, live frame-rate text and a DebugWindow that starts hidden.

Final result

CRM64Pro Tutorial 05 font rendering

Runtime controls

• Cursor keys: Move the ship image.
• Plus / Minus: Change the bitmap-font scale.
• D: Show or hide the debug window.
• Grave key: Show or hide the built-in console.
• Any key or mouse click: Write the input event to the log.
• Q or ESC: Exit the tutorial.

Prerequisites

• CRM64Pro GDK installed and configured with a supported C++17 compiler.
• Tutorial package downloaded and fully extracted, preserving its folder structure.
• Run Tutorial 02 and Tutorial 04 first so Tutorial.cdc contains the background, ship and cursor resources.
• Included assets available under bin/Base/: in_font.png.
• Write access to the platform output directory.

What you will learn

• Create a Font from an Image and transfer image ownership.
• Save and load a Font resource through a CDC archive.
• Configure kerning, space width and the text cursor.
• Load embedded fonts with FontMgr::getBuiltin().
• Position, scale and color text.
• Display current render and logic rates.

Step by step

1. Verify the shared archive

Font::save() can create a new archive, but this tutorial must extend the archive prepared by the earlier tutorials. The prerequisite check prevents an incomplete font-only Tutorial.cdc from being created.

// Tutorial 05 introduces one new resource. Earlier tutorials already added
// the background, ship and cursor to the CDC.
mLog.msg(LL_INFO, "  Find Tutorial 04 CDC: %s ... ", OUTPUT_CDC);
if(!mC64.tool().fileExists(OUTPUT_CDC))
{
    logTaskFailed(mLog);
    return false;
}
logTaskOk(mLog);

2. Create a bitmap Font

The font image is loaded through ImageMgr and uses black as its transparent color. FontMgr creates an empty Font, then assignImage() transfers ownership of the Image to it. The tutorial configures its spacing and cursor character.

mLog.msg(LL_INFO, "  Load bitmap font image: %s ... ", RESOURCE_FONT_IMAGE);
Sint32 idFontImage = mC64.imageMgr().loadFromFile(RESOURCE_FONT_IMAGE, "tutorialFontImageFile");
Image* pFontImage = mC64.imageMgr().get(idFontImage);
if(idFontImage < 0 || pFontImage == nullptr)
{
    logTaskFailed(mLog, idFontImage);
    return false;
}
pFontImage->setColorKey(0, 0, 0);
logTaskOk(mLog);
 
mLog.msg(LL_INFO, "  Create font from image ... ");
Sint32 idFontFile = mC64.fontMgr().create(RESOURCE_FONT_CDC_NAME);
Font* pFontFile = mC64.fontMgr().get(idFontFile);
if(idFontFile < 0 || pFontFile == nullptr)
{
    logTaskFailed(mLog, idFontFile);
    mC64.imageMgr().close(idFontImage);
    return false;
}
if(pFontFile->assignImage(idFontImage, 1) < 0)
{
    logTaskFailed(mLog);
    mC64.fontMgr().close(idFontFile);
    mC64.imageMgr().close(idFontImage);
    return false;
}
pFontFile->setKerning(1);
pFontFile->setSpaceWidth(6);
pFontFile->setTextCursor('|');
logTaskOk(mLog);

3. Save the Font to Tutorial.cdc

Font::save() stores both the Font block and its owned Image block. Closing the temporary Font also releases the Image before a fresh runtime copy is loaded.

// Save appends or replaces the font resource in Tutorial.cdc.
mLog.msg(LL_INFO, "  Save font to CDC ... ");
if(pFontFile->save(OUTPUT_CDC, RESOURCE_FONT_CDC_NAME) < 0)
{
    logTaskFailed(mLog);
    mC64.fontMgr().close(idFontFile);
    return false;
}
logTaskOk(mLog);
 
// Close the temporary font. The tutorial loads a fresh copy from CDC next.
mLog.msg(LL_INFO, "  Close temporary font ... ");
mC64.fontMgr().close(idFontFile);
logTaskOk(mLog);

4. Load and select the custom cursor

The background, ship and cursor retain their existing CDC names. Load the Cursor from Tutorial.cdc, then select and show it.

mLog.msg(LL_INFO, "  Load cursor from CDC ... ");
state.idCursor = mC64.cursorMgr().load(OUTPUT_CDC, RESOURCE_CURSOR_CDC_NAME);
Cursor* pCursor = mC64.cursorMgr().get(state.idCursor);
if(state.idCursor < 0 || pCursor == nullptr)
{
    logTaskFailed(mLog, state.idCursor);
    Main::terminate();
    return -1;
}
logTaskOk(mLog);
 
mLog.msg(LL_INFO, "  Select cursor ... ");
if(mC64.cursorMgr().select(state.idCursor) < 0 ||
   !mC64.cursorMgr().show())
{
    logTaskFailed(mLog);
    Main::terminate();
    return -1;
}
logTaskOk(mLog);

5. Load and color the bitmap Font

FontMgr loads the saved resource by name. A Font renders through an Image, so changing that Image's color modulation changes the text color.

mLog.msg(LL_INFO, "  Load bitmap font from CDC ... ");
state.idBitmapFont = mC64.fontMgr().load(OUTPUT_CDC, RESOURCE_FONT_CDC_NAME);
Font* pBitmapFont = mC64.fontMgr().get(state.idBitmapFont);
if(state.idBitmapFont < 0 || pBitmapFont == nullptr)
{
    logTaskFailed(mLog, state.idBitmapFont);
    Main::terminate();
    return -1;
}
logTaskOk(mLog);
 
// Fonts use an Image internally. Image color modulation changes the rendered text color.
Image* pBitmapFontImage = mC64.imageMgr().get(pBitmapFont->getImage());
if(pBitmapFontImage) pBitmapFontImage->setColorMod(255, 220, 120);

6. Load the embedded font set

FontMgr::getBuiltin() returns the requested embedded Font. The tutorial loads one font for status text and all eight variants for the visual comparison.

mLog.msg(LL_INFO, "  Load built-in font ... ");
state.idBuiltInFont = mC64.fontMgr().getBuiltin("CourierNew10White");
Font* pBuiltInFont = mC64.fontMgr().get(state.idBuiltInFont);
if(state.idBuiltInFont < 0 || pBuiltInFont == nullptr)
{
    logTaskFailed(mLog, state.idBuiltInFont);
    Main::terminate();
    return -1;
}
logTaskOk(mLog);
 
// Preload every embedded font used by the visual comparison.
mLog.msg(LL_INFO, "  Load embedded font samples ... ");
for(Sint32 i = 0; i < iBuiltinSampleCount; ++i)
{
    state.idBuiltinSamples[i] = mC64.fontMgr().getBuiltin(szBuiltinSampleNames[i]);
    if(state.idBuiltinSamples[i] < 0 || mC64.fontMgr().get(state.idBuiltinSamples[i]) == nullptr)
    {
        logTaskFailed(mLog, state.idBuiltinSamples[i]);
        Main::terminate();
        return -1;
    }
}
logTaskOk(mLog);

7. Render positioned and scaled text

The built-in Font displays live frame rates. The bitmap Font demonstrates normal rendering, its configured text cursor, Position helpers and renderEx() scaling.

// Draw text at the requested screen position.
static void renderText(Font* pBitmapFont, Font* pBuiltInFont, const TutorialState& rState)
{
    if(pBuiltInFont)
    {
        char szRates[96];
        snprintf(szRates, sizeof(szRates), "Render: %d fps   Logic: %d fps", rState.iCurrentRenderRate, rState.iCurrentLogicRate);
        pBuiltInFont->setPosition(10, 10);
        pBuiltInFont->render(szRates);
 
        pBuiltInFont->setPosition(10, 30);
        pBuiltInFont->render("Built-in font: CourierNew10White");
    }
 
    if(!pBitmapFont) return;
 
    pBitmapFont->setPosition(10, 70);
    pBitmapFont->render("CDC bitmap font: Tutorial_font");
 
    pBitmapFont->setPosition(10, 105);
    pBitmapFont->render("This line shows the font cursor", true, 14);
 
    char szScale[96];
    snprintf(szScale, sizeof(szScale), "Scaled renderEx text: %.1f", rState.fFontScale);
    pBitmapFont->setPosition(Position(PH_CENTER, 0), Position(PH_BOTTOM, -58));
    pBitmapFont->renderEx(szScale, false, -1, rState.fFontScale, rState.fFontScale);
 
    pBitmapFont->setPosition(Position(PH_CENTER, 0), Position(PH_BOTTOM, -28));
    pBitmapFont->render("Position helpers place this text at bottom center");
}

8. Adjust scale and update live values

Plus and minus clamp the scale between 0.5 and 2.0. After event processing, a quit request exits before the final state and logic update.

else if(event.key.key == SDLK_PLUS || event.key.key == SDLK_KP_PLUS)
{
    state.fFontScale = clampFloat(state.fFontScale + 0.1f, 0.5f, 2.0f);
}
else if(event.key.key == SDLK_MINUS || event.key.key == SDLK_KP_MINUS)
{
    state.fFontScale = clampFloat(state.fFontScale - 0.1f, 0.5f, 2.0f);
}
else if(event.key.key == SDLK_D)
{
    toggleDebugWindow(pDebug);
}

if(!bRunning) break;
state.fMouseX = mC64.cursorMgr().getX();
state.fMouseY = mC64.cursorMgr().getY();
state.iCurrentRenderRate = static_cast<Sint32>(mC64.timer().getCurrentRFR());
state.iCurrentLogicRate = static_cast<Sint32>(mC64.timer().getCurrentLFR());
updateLogic(state, pPlayerImage, 1.0f / static_cast<float>(iLogicRate));

9. Release resources in ownership order

Fonts and cursors can own Images, so they are closed before ImageMgr and the CDC archives.

mLog.msg(LL_INFO, "  Close fonts ... ");
mC64.fontMgr().close(0);
logTaskOk(mLog);
mLog.msg(LL_INFO, "  Close cursors ... ");
mC64.cursorMgr().close(0);
logTaskOk(mLog);
mLog.msg(LL_INFO, "  Close images ... ");
mC64.imageMgr().close(0);
logTaskOk(mLog);
mLog.msg(LL_INFO, "  Close CDC archives ... ");
mC64.archiveMgr().close(0);
logTaskOk(mLog);
Main::terminate();

Complete source

The tutorial source is authoritative. The following listing is included directly from validation/source/Tutorial_05_Font.cpp.

/* ----------------------------------------------------------------------
    CRM64Pro GDK - Roberto Prieto
    Copyright (C) 2013-2026 MegaStorm Systems
 
    This software is provided 'as-is', without any express or implied
    warranty. In no event will the authors be held liable for any damages
    arising from the use of this software.
 
    Permission is granted to anyone to use this software for any purpose,
    including commercial applications, and to alter it and redistribute it
    freely, subject to the following restrictions:
 
    1. The origin of this software must not be misrepresented; you must not
       claim that you wrote the original software.
    2. Altered source versions must be plainly marked as such, and must not be
       misrepresented as being the original software.
    3. This notice may not be removed or altered from any source distribution.
 
------------------------------------------------------------------------
                        Tutorial 05: Font
------------------------------------------------------------------------
 
    Overview:
    This tutorial extends Tutorial 04 Cursor with bitmap and built-in fonts.
    Tutorial 04 adds the custom cursor to Tutorial.cdc. This tutorial adds a
    bitmap font, then loads all runtime resources from the CDC. It also renders
    the complete embedded font set for a visual size and style comparison.
 
    Key concepts:
    - Add a bitmap Font resource to an existing CDC file.
    - Load Image, Cursor and Font resources from a CDC file.
    - Use built-in fonts through FontMgr::getBuiltin().
    - Compare all embedded Arial and Courier New font variants.
    - Render text with positions, cursor display, scaling and color changes.
    - Show current render and logic rates on screen.
    - Keep the debug window available but hidden by default.
 
    Controls:
    - Cursor Keys: Move the ship image.
    - Plus / Minus: Change font scale.
    - D: Toggle debug window.
    - Grave: Toggle console.
    - Any Key/Mouse: Logs events.
    - Q / ESC: Quit.
 
    Loop order:
    - Process input events.
    - Run one fixed logic update.
    - Let Main::update() call the screen render callback.
------------------------------------------------------------------------ */
 
#include "CRM64Pro.h"
#include "RunParameter.h"
 
using namespace CRM64Pro;
 
#define BASEDIR "Base/"
#ifdef CRM64PRO_PLATFORM_WINDOWS
#define OUTPUTDIR "Win64/"
#elif defined(CRM64PRO_PLATFORM_LINUX)
#define OUTPUTDIR "Linux/"
#elif defined(CRM64PRO_PLATFORM_MACOS)
#define OUTPUTDIR "macOS/"
#endif
 
#define RESOURCE_FONT_IMAGE BASEDIR"in_font.png"
#define RESOURCE_BG_CDC_NAME "Tutorial_bg"
#define RESOURCE_PLAYER_CDC_NAME "Tutorial_ship"
#define RESOURCE_CURSOR_CDC_NAME "Tutorial_cursor"
#define RESOURCE_FONT_CDC_NAME "Tutorial_font"
#define OUTPUT_CDC OUTPUTDIR"Tutorial.cdc"
 
// Fixed-rate timing.
// Render rate 0 lets the screen render as often as possible. Logic rate controls movement.
static const Sint32 iLogicRate = 20;
static const Sint32 iRenderRate = 0;
 
// Window size and movement speed.
static const Sint32 iScreenW = 960;
static const Sint32 iScreenH = 540;
static const float fMoveSpeed = 220.0f;
static const Sint32 iBuiltinSampleCount = 8;
static const char* szBuiltinSampleNames[iBuiltinSampleCount] = {
    "Arial8Black",
    "Arial8White",
    "Arial10Black",
    "Arial10White",
    "CourierNew8Black",
    "CourierNew8White",
    "CourierNew10Black",
    "CourierNew10White"
};
 
// Values changed while the tutorial runs.
struct TutorialState
{
    Sint32 idBgImage = -1;
    Sint32 idPlayerImage = -1;
    Sint32 idCursor = -1;
    Sint32 idBitmapFont = -1;
    Sint32 idBuiltInFont = -1;
    Sint32 idBuiltinSamples[iBuiltinSampleCount] = {-1, -1, -1, -1, -1, -1, -1, -1};
    Sint32 idDebugWindow = -1;
    float fPlayerX = 386.0f;
    float fPlayerY = 186.0f;
    float fMouseX = 0.0f;
    float fMouseY = 0.0f;
    float fFontScale = 1.0f;
    Sint32 iCurrentRenderRate = 0;
    Sint32 iCurrentLogicRate = 0;
    Sint32 iLogicFrames = 0;
    bool bMoveLeft = false;
    bool bMoveRight = false;
    bool bMoveUp = false;
    bool bMoveDown = false;
};
 
// Keep a value inside the given range.
static float clampFloat(float fValue, float fMin, float fMax)
{
    if(fValue < fMin) return fMin;
    if(fValue > fMax) return fMax;
    return fValue;
}
 
// Helper functions used by the setup log messages.
static void logTaskOk(Log& mLog)
{
    mLog.msg(LL_DEBUG, "OK\n");
}
 
// Record a failed tutorial task.
static void logTaskFailed(Log& mLog, Sint32 iCode)
{
    mLog.msg(LL_ERROR, "FAILED (Code %d)\n", iCode);
}
 
// Record a failed tutorial task.
static void logTaskFailed(Log& mLog)
{
    mLog.msg(LL_ERROR, "FAILED\n");
}
 
// Move the ship image one fixed logic step.
static void updateLogic(TutorialState& rState, Image* pPlayerImage, float fDeltaTime)
{
    if(!pPlayerImage) return;
 
    float fDX = 0.0f;
    float fDY = 0.0f;
 
    if(rState.bMoveLeft) fDX -= fMoveSpeed * fDeltaTime;
    if(rState.bMoveRight) fDX += fMoveSpeed * fDeltaTime;
    if(rState.bMoveUp) fDY -= fMoveSpeed * fDeltaTime;
    if(rState.bMoveDown) fDY += fMoveSpeed * fDeltaTime;
 
    const float fMaxX = static_cast<float>(iScreenW - pPlayerImage->getWidth());
    const float fMaxY = static_cast<float>(iScreenH - pPlayerImage->getHeight());
    rState.fPlayerX = clampFloat(rState.fPlayerX + fDX, 0.0f, fMaxX);
    rState.fPlayerY = clampFloat(rState.fPlayerY + fDY, 0.0f, fMaxY);
    rState.iLogicFrames++;
}
 
// Draw text at the requested screen position.
static void renderText(Font* pBitmapFont, Font* pBuiltInFont, const TutorialState& rState)
{
    if(pBuiltInFont)
    {
        char szRates[96];
        snprintf(szRates, sizeof(szRates), "Render: %d fps   Logic: %d fps", rState.iCurrentRenderRate, rState.iCurrentLogicRate);
        pBuiltInFont->setPosition(10, 10);
        pBuiltInFont->render(szRates);
 
        pBuiltInFont->setPosition(10, 30);
        pBuiltInFont->render("Built-in font: CourierNew10White");
    }
 
    if(!pBitmapFont) return;
 
    pBitmapFont->setPosition(10, 70);
    pBitmapFont->render("CDC bitmap font: Tutorial_font");
 
    pBitmapFont->setPosition(10, 105);
    pBitmapFont->render("This line shows the font cursor", true, 14);
 
    char szScale[96];
    snprintf(szScale, sizeof(szScale), "Scaled renderEx text: %.1f", rState.fFontScale);
    pBitmapFont->setPosition(Position(PH_CENTER, 0), Position(PH_BOTTOM, -58));
    pBitmapFont->renderEx(szScale, false, -1, rState.fFontScale, rState.fFontScale);
 
    pBitmapFont->setPosition(Position(PH_CENTER, 0), Position(PH_BOTTOM, -28));
    pBitmapFont->render("Position helpers place this text at bottom center");
}
 
// Draw the built-in font examples.
static void renderBuiltinFontSamples(const TutorialState& rState)
{
    // Each font renders its own name so the embedded variants can be compared.
    FontMgr& mFontMgr = Main::instance().fontMgr();
    Sint32 iY = 55;
    for(Sint32 i = 0; i < iBuiltinSampleCount; ++i)
    {
        Font* pFont = mFontMgr.get(rState.idBuiltinSamples[i]);
        if(pFont)
        {
            pFont->setPosition(610, iY);
            pFont->render(szBuiltinSampleNames[i]);
            iY += pFont->getHeight() + 14;
        }
    }
}
 
// Draw the current frame. CursorMgr draws the selected cursor automatically.
static void renderFrame(Image* pBgImage, Image* pPlayerImage, Font* pBitmapFont, Font* pBuiltInFont, const TutorialState& rState)
{
    if(pBgImage) pBgImage->render();
 
    if(pPlayerImage)
    {
        SDL_FRect rDst = {
            rState.fPlayerX,
            rState.fPlayerY,
            static_cast<float>(pPlayerImage->getWidth()),
            static_cast<float>(pPlayerImage->getHeight())
        };
        pPlayerImage->render(0, nullptr, &rDst);
    }
 
    renderText(pBitmapFont, pBuiltInFont, rState);
    renderBuiltinFontSamples(rState);
}
 
// Screen render callback.
// Main::update() calls this when the screen is ready to render.
static Sint32 renderWrapper(Sint32, void* pObj)
{
    TutorialState* pState = static_cast<TutorialState*>(pObj);
    if(!pState) return 0;
 
    Main& mC64 = Main::instance();
    Image* pBgImage = mC64.imageMgr().get(pState->idBgImage);
    Image* pPlayerImage = mC64.imageMgr().get(pState->idPlayerImage);
    Font* pBitmapFont = mC64.fontMgr().get(pState->idBitmapFont);
    Font* pBuiltInFont = mC64.fontMgr().get(pState->idBuiltInFont);
    renderFrame(pBgImage, pPlayerImage, pBitmapFont, pBuiltInFont, *pState);
 
    return 0;
}
 
// Show or hide the debug window.
static void toggleDebugWindow(DebugWindow* pDebug)
{
    if(!pDebug) return;
    if(pDebug->baseWidget().status() == GS_SHOWN) pDebug->baseWidget().hide();
    else pDebug->baseWidget().show();
}
 
// Add the font resource to the tutorial archive.
static bool addFontToCDC(Main& mC64, Log& mLog)
{
    // Tutorial 05 introduces one new resource. Earlier tutorials already added
    // the background, ship and cursor to the CDC.
    mLog.msg(LL_INFO, "  Find Tutorial 04 CDC: %s ... ", OUTPUT_CDC);
    if(!mC64.tool().fileExists(OUTPUT_CDC))
    {
        logTaskFailed(mLog);
        return false;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Load bitmap font image: %s ... ", RESOURCE_FONT_IMAGE);
    Sint32 idFontImage = mC64.imageMgr().loadFromFile(RESOURCE_FONT_IMAGE, "tutorialFontImageFile");
    Image* pFontImage = mC64.imageMgr().get(idFontImage);
    if(idFontImage < 0 || pFontImage == nullptr)
    {
        logTaskFailed(mLog, idFontImage);
        return false;
    }
    pFontImage->setColorKey(0, 0, 0);
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Create font from image ... ");
    Sint32 idFontFile = mC64.fontMgr().create(RESOURCE_FONT_CDC_NAME);
    Font* pFontFile = mC64.fontMgr().get(idFontFile);
    if(idFontFile < 0 || pFontFile == nullptr)
    {
        logTaskFailed(mLog, idFontFile);
        mC64.imageMgr().close(idFontImage);
        return false;
    }
    if(pFontFile->assignImage(idFontImage, 1) < 0)
    {
        logTaskFailed(mLog);
        mC64.fontMgr().close(idFontFile);
        mC64.imageMgr().close(idFontImage);
        return false;
    }
    pFontFile->setKerning(1);
    pFontFile->setSpaceWidth(6);
    pFontFile->setTextCursor('|');
    logTaskOk(mLog);
 
    // Save appends or replaces the font resource in Tutorial.cdc.
    mLog.msg(LL_INFO, "  Save font to CDC ... ");
    if(pFontFile->save(OUTPUT_CDC, RESOURCE_FONT_CDC_NAME) < 0)
    {
        logTaskFailed(mLog);
        mC64.fontMgr().close(idFontFile);
        return false;
    }
    logTaskOk(mLog);
 
    // Close the temporary font. The tutorial loads a fresh copy from CDC next.
    mLog.msg(LL_INFO, "  Close temporary font ... ");
    mC64.fontMgr().close(idFontFile);
    logTaskOk(mLog);
 
    return true;
}
 
// Run the tutorial application and release its resources.
int main(int argc, char* argv[])
{
    eConfigRendererDriver eRenderer = CRD_SOFTWARE;
    if(!runParameterReadRender(argc, argv, eRenderer)) return 1;
 
    // Start CRM64Pro memory tracking before creating engine resources.
    // atexit() releases memory tracking data when the program exits.
    CMem::setStatsLevel(CMem::MSL_NORMAL);
    atexit(CMem::destroy);
 
    // Main gives access to the CRM64Pro managers.
    Main& mC64 = Main::instance();
    Log& mLog = *mC64.logMgr().get();
 
    TutorialState state;
 
    // Write log output to stdout and to a file under validation/bin.
    mLog.init("Tutorial_05_Font", LL_DEBUG, LM_FILE | LM_STDOUT, OUTPUTDIR"Tutorial_05_Font.log");
 
    mLog.msg(LL_INFO, "\nSETUP: screen and timing\n");
 
    // Initialize the timer before calling Main::update().
    // setRate() receives render frames per second, then logic frames per second.
    mLog.msg(LL_INFO, "  Initialize timer ... ");
    if(!mC64.timer().init())
    {
        logTaskFailed(mLog);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Set frame rates (render=%d, logic=%d) ... ", iRenderRate, iLogicRate);
    if(!mC64.timer().setRate(iRenderRate, iLogicRate))
    {
        logTaskFailed(mLog);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    // Add a 1 ms idle delay inside Main::update().
    mC64.configMgr().setMTFriendly(1);
 
    // Configure and show the default screen.
    Screen* pScreen = mC64.configMgr().get();
    pScreen->setSize(iScreenW, iScreenH);
    pScreen->setDriver(eRenderer);
    pScreen->setTitle("CRM64Pro - Tutorial 05: Font");
 
    mLog.msg(LL_INFO, "  Create screen (%dx%d) ... ", iScreenW, iScreenH);
    if(pScreen->show() < 0)
    {
        mLog.msg(LL_CRITICAL, "FAILED\n");
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Set render callback ... ");
    if(!pScreen->setRenderCallback([&state](Sint32 iMode) { return renderWrapper(iMode, &state); }))
    {
        logTaskFailed(mLog);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "\nRESOURCES: add font and load from CDC\n");
 
    if(!addFontToCDC(mC64, mLog))
    {
        Main::terminate();
        return -1;
    }
 
    // From this point, all runtime resources are loaded from Tutorial.cdc or built in.
    mLog.msg(LL_INFO, "  Load background image from CDC ... ");
    state.idBgImage = mC64.imageMgr().load(OUTPUT_CDC, RESOURCE_BG_CDC_NAME);
    if(state.idBgImage < 0)
    {
        logTaskFailed(mLog, state.idBgImage);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Load ship image from CDC ... ");
    state.idPlayerImage = mC64.imageMgr().load(OUTPUT_CDC, RESOURCE_PLAYER_CDC_NAME);
    if(state.idPlayerImage < 0)
    {
        logTaskFailed(mLog, state.idPlayerImage);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    Image* pPlayerImage = mC64.imageMgr().get(state.idPlayerImage);
    if(pPlayerImage == nullptr)
    {
        logTaskFailed(mLog);
        Main::terminate();
        return -1;
    }
 
    mLog.msg(LL_INFO, "  Load cursor from CDC ... ");
    state.idCursor = mC64.cursorMgr().load(OUTPUT_CDC, RESOURCE_CURSOR_CDC_NAME);
    Cursor* pCursor = mC64.cursorMgr().get(state.idCursor);
    if(state.idCursor < 0 || pCursor == nullptr)
    {
        logTaskFailed(mLog, state.idCursor);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Select cursor ... ");
    if(mC64.cursorMgr().select(state.idCursor) < 0 ||
       !mC64.cursorMgr().show())
    {
        logTaskFailed(mLog);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "  Load bitmap font from CDC ... ");
    state.idBitmapFont = mC64.fontMgr().load(OUTPUT_CDC, RESOURCE_FONT_CDC_NAME);
    Font* pBitmapFont = mC64.fontMgr().get(state.idBitmapFont);
    if(state.idBitmapFont < 0 || pBitmapFont == nullptr)
    {
        logTaskFailed(mLog, state.idBitmapFont);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    // Fonts use an Image internally. Image color modulation changes the rendered text color.
    Image* pBitmapFontImage = mC64.imageMgr().get(pBitmapFont->getImage());
    if(pBitmapFontImage) pBitmapFontImage->setColorMod(255, 220, 120);
 
    mLog.msg(LL_INFO, "  Load built-in font ... ");
    state.idBuiltInFont = mC64.fontMgr().getBuiltin("CourierNew10White");
    Font* pBuiltInFont = mC64.fontMgr().get(state.idBuiltInFont);
    if(state.idBuiltInFont < 0 || pBuiltInFont == nullptr)
    {
        logTaskFailed(mLog, state.idBuiltInFont);
        Main::terminate();
        return -1;
    }
    logTaskOk(mLog);
 
    // Preload every embedded font used by the visual comparison.
    mLog.msg(LL_INFO, "  Load embedded font samples ... ");
    for(Sint32 i = 0; i < iBuiltinSampleCount; ++i)
    {
        state.idBuiltinSamples[i] = mC64.fontMgr().getBuiltin(szBuiltinSampleNames[i]);
        if(state.idBuiltinSamples[i] < 0 || mC64.fontMgr().get(state.idBuiltinSamples[i]) == nullptr)
        {
            logTaskFailed(mLog, state.idBuiltinSamples[i]);
            Main::terminate();
            return -1;
        }
    }
    logTaskOk(mLog);
 
    mLog.msg(LL_INFO, "\nTOOLS: debug window and console\n");
 
    // The DebugWindow is available, but this tutorial starts with it hidden.
    mLog.msg(LL_INFO, "  Create debug window ... ");
    state.idDebugWindow = mC64.guiMgr().create("Debug", CRM64PRO_GUI_DEBUGWINDOW);
    DebugWindow* pDebug = mC64.guiMgr().getDebugWindow(state.idDebugWindow);
    if(!pDebug)
    {
        logTaskFailed(mLog, state.idDebugWindow);
        Main::terminate();
        return -1;
    }
    pDebug->baseWidget().setPosition(Position(PH_RIGHT, -120), Position(PH_TOP, 10));
    pDebug->addWatch("Player X", nullptr, &state.fPlayerX);
    pDebug->addWatch("Player Y", nullptr, &state.fPlayerY);
    pDebug->addWatch("Mouse X", nullptr, &state.fMouseX);
    pDebug->addWatch("Mouse Y", nullptr, &state.fMouseY);
    pDebug->addWatch("Font scale", nullptr, &state.fFontScale);
    pDebug->addWatch("Render fps", &state.iCurrentRenderRate);
    pDebug->addWatch("Logic fps", &state.iCurrentLogicRate);
    pDebug->addWatch("Logic frames", &state.iLogicFrames);
    pDebug->baseWidget().hide();
    logTaskOk(mLog);
 
    // Main creates the default Console. Log output is also sent there.
    Console* pConsole = mC64.guiMgr().getConsole();
    if(pConsole) pConsole->print("Tutorial 05: Font ready. Press ` to toggle the console.\n");
 
    mLog.msg(LL_INFO, "\nCONTROLS\n");
    mLog.msg(LL_INFO, "  [Q] / [ESC] Quit\n");
    mLog.msg(LL_INFO, "  [Arrow Keys] Move the ship image\n");
    mLog.msg(LL_INFO, "  [+] / [-] Change font scale\n");
    mLog.msg(LL_INFO, "  [D] Toggle debug window\n");
    mLog.msg(LL_INFO, "  [`] Toggle console\n");
    mLog.msg(LL_INFO, "  Any key or mouse button logs the input event\n");
    mLog.msg(LL_INFO, "\nRUNNING\n");
 
    SDL_Event event;
    bool bRunning = true;
    while(bRunning)
    {
        // Main::update() processes input, runs internal GUI logic and calls the
        // screen render callback when a render frame is ready.
        while(mC64.update(&event))
        {
            if(event.type == SDL_EVENT_QUIT)
            {
                bRunning = false;
            }
            else if(event.type == SDL_EVENT_KEY_DOWN)
            {
                // SDL3 stores the key value in event.key.key.
                mLog.msg(LL_INFO, "  Key pressed: %s (%d)\n", SDL_GetKeyName(event.key.key), event.key.key);
 
                if(event.key.key == SDLK_Q || event.key.key == SDLK_ESCAPE)
                {
                    bRunning = false;
                }
                else if(event.key.key == SDLK_LEFT)
                {
                    state.bMoveLeft = true;
                }
                else if(event.key.key == SDLK_RIGHT)
                {
                    state.bMoveRight = true;
                }
                else if(event.key.key == SDLK_UP)
                {
                    state.bMoveUp = true;
                }
                else if(event.key.key == SDLK_DOWN)
                {
                    state.bMoveDown = true;
                }
                else if(event.key.key == SDLK_PLUS || event.key.key == SDLK_KP_PLUS)
                {
                    state.fFontScale = clampFloat(state.fFontScale + 0.1f, 0.5f, 2.0f);
                }
                else if(event.key.key == SDLK_MINUS || event.key.key == SDLK_KP_MINUS)
                {
                    state.fFontScale = clampFloat(state.fFontScale - 0.1f, 0.5f, 2.0f);
                }
                else if(event.key.key == SDLK_D)
                {
                    toggleDebugWindow(pDebug);
                }
            }
            else if(event.type == SDL_EVENT_KEY_UP)
            {
                if(event.key.key == SDLK_LEFT) state.bMoveLeft = false;
                else if(event.key.key == SDLK_RIGHT) state.bMoveRight = false;
                else if(event.key.key == SDLK_UP) state.bMoveUp = false;
                else if(event.key.key == SDLK_DOWN) state.bMoveDown = false;
            }
            else if(event.type == SDL_EVENT_MOUSE_BUTTON_DOWN)
            {
                mLog.msg(LL_INFO, "  Mouse clicked: button %d at %d, %d\n", event.button.button, (Sint32)event.button.x, (Sint32)event.button.y);
            }
        }
 
        if(!bRunning) break;
        state.fMouseX = mC64.cursorMgr().getX();
        state.fMouseY = mC64.cursorMgr().getY();
        state.iCurrentRenderRate = static_cast<Sint32>(mC64.timer().getCurrentRFR());
        state.iCurrentLogicRate = static_cast<Sint32>(mC64.timer().getCurrentLFR());
        updateLogic(state, pPlayerImage, 1.0f / static_cast<float>(iLogicRate));
    }
 
    // Close resources owned by this tutorial.
    mC64.fontMgr().info();
    mLog.msg(LL_INFO, "\nCLEANUP\n");
    mLog.msg(LL_INFO, "  Close debug window ... ");
    mC64.guiMgr().close(state.idDebugWindow);
    logTaskOk(mLog);
    mLog.msg(LL_INFO, "  Close fonts ... ");
    mC64.fontMgr().close(0);
    logTaskOk(mLog);
    mLog.msg(LL_INFO, "  Close cursors ... ");
    mC64.cursorMgr().close(0);
    logTaskOk(mLog);
    mLog.msg(LL_INFO, "  Close images ... ");
    mC64.imageMgr().close(0);
    logTaskOk(mLog);
    mLog.msg(LL_INFO, "  Close CDC archives ... ");
    mC64.archiveMgr().close(0);
    logTaskOk(mLog);
    Main::terminate();
 
    return 0;
}

Navigation

Previous: Tutorial 04 - Custom cursor

Back to the tutorials index

The next tutorial introduces immediate GFX drawing and image filters.

Continue with Tutorial 06: GFX drawing