usbloadergx/source/FreeTypeGX.cpp

/*
 * FreeTypeGX is a wrapper class for libFreeType which renders a compiled
 * FreeType parsable font into a GX texture for Wii homebrew development.
 * Copyright (C) 2008 Armin Tamzarian
 * Modified by Tantric, 2009
 *
 * This file is part of FreeTypeGX.
 *
 * FreeTypeGX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FreeTypeGX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FreeTypeGX.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <sys/stat.h>
#include "FreeTypeGX.h"
#include "settings/cfg.h"

#include "main.h"

/*! \struct ftgxCharData_
 *
 * Font face character glyph relevant data structure.
 */
typedef struct ftgxCharData_ {
    int16_t renderOffsetX;		/**< Texture X axis bearing offset. */
    uint16_t glyphAdvanceX;		/**< Character glyph X coordinate advance in pixels. */
    uint16_t glyphIndex;		/**< Charachter glyph index in the font face. */

    uint16_t textureWidth;		/**< Texture width in pixels/bytes. */
    uint16_t textureHeight;		/**< Texture glyph height in pixels/bytes. */

    int16_t renderOffsetY;		/**< Texture Y axis bearing offset. */
    int16_t renderOffsetMax;	/**< Texture Y axis bearing maximum value. */
    int16_t renderOffsetMin;	/**< Texture Y axis bearing minimum value. */

    uint32_t* glyphDataTexture;	/**< Glyph texture bitmap data buffer. */
} ftgxCharData;

/*! \struct ftgxDataOffset_
 *
 * Offset structure which hold both a maximum and minimum value.
 */
typedef struct ftgxDataOffset_ {
    int16_t ascender;	/**< Maximum data offset. */
    int16_t descender;	/**< Minimum data offset. */
    int16_t max;	/**< Maximum data offset. */
    int16_t min;	/**< Minimum data offset. */
} ftgxDataOffset;


/**
 * Default constructor for the FreeTypeGX class.
 *
 * @param textureFormat	Optional format (GX_TF_*) of the texture as defined by the libogc gx.h header file. If not specified default value is GX_TF_RGBA8.
 * @param vertexIndex	Optional vertex format index (GX_VTXFMT*) of the glyph textures as defined by the libogc gx.h header file. If not specified default value is GX_VTXFMT1.
 */
FreeTypeGX::FreeTypeGX(uint8_t textureFormat, uint8_t vertexIndex) : ftFace(NULL), ftFace_fromFile(NULL) {
    FT_Init_FreeType(&this->ftLibrary);

    this->textureFormat = textureFormat;
    this->setVertexFormat(vertexIndex);
    this->setCompatibilityMode(FTGX_COMPATIBILITY_NONE);
}

/**
 * Default destructor for the FreeTypeGX class.
 */
FreeTypeGX::~FreeTypeGX() {
    this->unloadFont();
    FT_Done_FreeType(this->ftLibrary);
}

/**
 * Convert a short char sctring to a wide char string.
 *
 * This routine converts a supplied shot character string into a wide character string.
 * Note that it is the user's responsibility to clear the returned buffer once it is no longer needed.
 *
 * @param strChar	Character string to be converted.
 * @return Wide character representation of supplied character string.
 */
wchar_t* FreeTypeGX::charToWideChar(char* strChar) {
    wchar_t *strWChar;
    strWChar = new wchar_t[strlen(strChar) + 1];

    // UTF-8
    int	bt;
    bt = mbstowcs(strWChar, strChar, strlen(strChar));
    if (bt > 0) {
        strWChar[bt] = (wchar_t)'\0';
        return strWChar;
    }

    char *tempSrc = strChar;
    wchar_t *tempDest = strWChar;
    while ((*tempDest++ = *tempSrc++));

    return strWChar;
}

/**
 *
 * \overload
 */
wchar_t* FreeTypeGX::charToWideChar(const char* strChar) {
    return FreeTypeGX::charToWideChar((char*) strChar);
}

/**
 * Setup the vertex attribute formats for the glyph textures.
 *
 * This function sets up the vertex format for the glyph texture on the specified vertex format index.
 * Note that this function should not need to be called except if the vertex formats are cleared or the specified
 * vertex format index is modified.
 *
 * @param vertexIndex	Vertex format index (GX_VTXFMT*) of the glyph textures as defined by the libogc gx.h header file.
*/
void FreeTypeGX::setVertexFormat(uint8_t vertexIndex) {
    this->vertexIndex = vertexIndex;

    GX_SetVtxAttrFmt(this->vertexIndex, GX_VA_POS, GX_POS_XY, GX_S16, 0);
    GX_SetVtxAttrFmt(this->vertexIndex, GX_VA_TEX0, GX_TEX_ST, GX_F32, 0);
    GX_SetVtxAttrFmt(this->vertexIndex, GX_VA_CLR0, GX_CLR_RGBA, GX_RGBA8, 0);
}

/**
 * Sets the TEV and VTX rendering compatibility requirements for the class.
 *
 * This sets up the default TEV opertion and VTX descriptions rendering values for the class. This ensures that FreeTypeGX
 * can remain compatible with external liraries or project code. Certain external libraries or code by design or lack of
 * foresight assume that the TEV opertion and VTX descriptions values will remain constant or are always returned to a
 * certain value. This will enable compatibility with those libraries and any other code which cannot or will not be changed.
 *
 * @param compatibilityMode	Compatibility descritor (FTGX_COMPATIBILITY_*) as defined in FreeTypeGX.h
*/
void FreeTypeGX::setCompatibilityMode(uint32_t compatibilityMode) {
    this->compatibilityMode = compatibilityMode;
}

/**
 * Sets the TEV operation and VTX descriptor values after texture rendering it complete.
 *
 * This function calls the GX_SetTevOp and GX_SetVtxDesc functions with the compatibility parameters specified
 * in setCompatibilityMode.
 */
void FreeTypeGX::setDefaultMode() {
    if (this->compatibilityMode) {
        switch (this->compatibilityMode & 0x00FF) {
        case FTGX_COMPATIBILITY_DEFAULT_TEVOP_GX_MODULATE:
            GX_SetTevOp(GX_TEVSTAGE0, GX_MODULATE);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_TEVOP_GX_DECAL:
            GX_SetTevOp(GX_TEVSTAGE0, GX_DECAL);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_TEVOP_GX_BLEND:
            GX_SetTevOp(GX_TEVSTAGE0, GX_BLEND);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_TEVOP_GX_REPLACE:
            GX_SetTevOp(GX_TEVSTAGE0, GX_REPLACE);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_TEVOP_GX_PASSCLR:
            GX_SetTevOp(GX_TEVSTAGE0, GX_PASSCLR);
            break;
        default:
            break;
        }

        switch (this->compatibilityMode & 0xFF00) {
        case FTGX_COMPATIBILITY_DEFAULT_VTXDESC_GX_NONE:
            GX_SetVtxDesc(GX_VA_TEX0, GX_NONE);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_VTXDESC_GX_DIRECT:
            GX_SetVtxDesc(GX_VA_TEX0, GX_DIRECT);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_VTXDESC_GX_INDEX8:
            GX_SetVtxDesc(GX_VA_TEX0, GX_INDEX8);
            break;
        case FTGX_COMPATIBILITY_DEFAULT_VTXDESC_GX_INDEX16:
            GX_SetVtxDesc(GX_VA_TEX0, GX_INDEX16);
            break;
        default:
            break;
        }
    }
}

/**
 * Loads and processes a specified true type font buffer to a specific point size.
 *
 * This routine takes a precompiled true type font buffer and loads the necessary processed data into memory. This routine should be called before drawText will succeed.
 *
 * @param fontPath		filename with path to load font from file in memory.
 * @param fontBuffer	A pointer in memory to a precompiled true type font buffer.
 * @param bufferSize	Size of the true type font buffer in bytes.
 * @param pointSize	The desired point size this wrapper's configured font face.
 * @param cacheAll	Optional flag to specify if all font characters should be cached when the class object is created. If specified as false the characters only become cached the first time they are used. If not specified default value is false.
 */
uint16_t FreeTypeGX::loadFont(char* fontPath, uint8_t* fontBuffer, FT_Long bufferSize, FT_UInt pointSize, bool cacheAll) {
    this->unloadFont();
    this->ftPointSize = pointSize;
    struct stat st;

    if (fontPath && (stat(fontPath, &st)==0)) {
        FILE *fontfile = fopen(fontPath, "rb");
        if (fontfile) {
            FT_Long ftFace_fromFile_Size;

            fseek(fontfile, 0, SEEK_END);
            ftFace_fromFile_Size = ftell(fontfile);
            fseek(fontfile, 0, SEEK_SET);
            ftFace_fromFile = (uint8_t*)malloc(ftFace_fromFile_Size);
            if (ftFace_fromFile != NULL) {
                fread(ftFace_fromFile, 1, ftFace_fromFile_Size, fontfile);
                FT_New_Memory_Face(this->ftLibrary, ftFace_fromFile, ftFace_fromFile_Size, 0, &this->ftFace);
            }
            fclose(fontfile);
        }
    }
    if (ftFace_fromFile == NULL)
        FT_New_Memory_Face(this->ftLibrary, (FT_Byte *)fontBuffer, bufferSize, 0, &this->ftFace);

    if (this->ftPointSize > 0)
        FT_Set_Pixel_Sizes(this->ftFace, 0, this->ftPointSize);

    this->ftSlot = this->ftFace->glyph;
    this->ftKerningEnabled = FT_HAS_KERNING(this->ftFace);

    if (cacheAll) {
        return this->cacheGlyphDataComplete();
    }

    return 0;
}

/**
 *
 * \overload
 */
uint16_t FreeTypeGX::loadFont(const char* fontPath, const uint8_t* fontBuffer, FT_Long bufferSize, FT_UInt pointSize, bool cacheAll) {
    return this->loadFont((char*)fontPath, (uint8_t *)fontBuffer, bufferSize, pointSize, cacheAll);
}

void FreeTypeGX::unloadFont() {
    clearGlyphData();

    if (this->ftFace) {
        FT_Done_Face(this->ftFace);
        this->ftFace = NULL;
    }
    if (this->ftFace_fromFile) {
        free(this->ftFace_fromFile);
        this->ftFace_fromFile = NULL;
    }
}
/**
 * Clears all loaded font glyph data.
 *
 * This routine clears all members of the font map structure and frees all allocated memory back to the system.
 */
void FreeTypeGX::clearGlyphData() {
    if (this->fontData.size() == 0)
        return;

    GX_DrawDone();
    GX_Flush();

    for ( std::map<wchar_t, ftgxCharData>::iterator i = this->fontData.begin(); i != this->fontData.end(); i++) {
        free(i->second.glyphDataTexture);
    }

    this->fontData.clear();
}

void FreeTypeGX::changeSize(FT_UInt vPointSize, FT_UInt hPointSize/*=0*/) {
    this->clearGlyphData();
    this->ftPointSize = vPointSize;
    FT_Set_Pixel_Sizes(this->ftFace, hPointSize, this->ftPointSize);
}

/**
 * Adjusts the texture data buffer to necessary width for a given texture format.
 *
 * This routine determines adjusts the given texture width into the required width to hold the necessary texture data for proper alignment.
 *
 * @param textureWidth	The initial guess for the texture width.
 * @param textureFormat	The texture format to which the data is to be converted.
 * @return The correctly adjusted texture width.
 */
uint16_t FreeTypeGX::adjustTextureWidth(uint16_t textureWidth, uint8_t textureFormat) {
    uint16_t alignment;

    switch (textureFormat) {
    case GX_TF_I4:		/* 8x8 Tiles - 4-bit Intensity */
    case GX_TF_I8:		/* 8x4 Tiles - 8-bit Intensity */
    case GX_TF_IA4:		/* 8x4 Tiles - 4-bit Intensity, , 4-bit Alpha */
        alignment = 8;
        break;

    case GX_TF_IA8:		/* 4x4 Tiles - 8-bit Intensity, 8-bit Alpha */
    case GX_TF_RGB565:	/* 4x4 Tiles - RGB565 Format */
    case GX_TF_RGB5A3:	/* 4x4 Tiles - RGB5A3 Format */
    case GX_TF_RGBA8:	/* 4x4 Tiles - RGBA8 Dual Cache Line Format */
    default:
        alignment = 4;
        break;
    }
    return textureWidth % alignment == 0 ? textureWidth : alignment + textureWidth - (textureWidth % alignment);

}

/**
 * Adjusts the texture data buffer to necessary height for a given texture format.
 *
 * This routine determines adjusts the given texture height into the required height to hold the necessary texture data for proper alignment.
 *
 * @param textureHeight	The initial guess for the texture height.
 * @param textureFormat	The texture format to which the data is to be converted.
 * @return The correctly adjusted texture height.
 */
uint16_t FreeTypeGX::adjustTextureHeight(uint16_t textureHeight, uint8_t textureFormat) {
    uint16_t alignment;

    switch (textureFormat) {
    case GX_TF_I4:		/* 8x8 Tiles - 4-bit Intensity */
        alignment = 8;
        break;

    case GX_TF_I8:		/* 8x4 Tiles - 8-bit Intensity */
    case GX_TF_IA4:		/* 8x4 Tiles - 4-bit Intensity, , 4-bit Alpha */
    case GX_TF_IA8:		/* 4x4 Tiles - 8-bit Intensity, 8-bit Alpha */
    case GX_TF_RGB565:	/* 4x4 Tiles - RGB565 Format */
    case GX_TF_RGB5A3:	/* 4x4 Tiles - RGB5A3 Format */
    case GX_TF_RGBA8:	/* 4x4 Tiles - RGBA8 Dual Cache Line Format */
    default:
        alignment = 4;
        break;
    }
    return textureHeight % alignment == 0 ? textureHeight : alignment + textureHeight - (textureHeight % alignment);

}

/**
 * Caches the given font glyph in the instance font texture buffer.
 *
 * This routine renders and stores the requested glyph's bitmap and relevant information into its own quickly addressible
 * structure within an instance-specific map.
 *
 * @param charCode	The requested glyph's character code.
 * @return A pointer to the allocated font structure.
 */
ftgxCharData *FreeTypeGX::cacheGlyphData(wchar_t charCode) {
    FT_UInt gIndex;
    uint16_t textureWidth = 0, textureHeight = 0;

    gIndex = FT_Get_Char_Index( this->ftFace, charCode );
    if (!FT_Load_Glyph(this->ftFace, gIndex, FT_LOAD_DEFAULT )) {
        FT_Render_Glyph( this->ftSlot, FT_RENDER_MODE_NORMAL );

        if (this->ftSlot->format == FT_GLYPH_FORMAT_BITMAP) {
            FT_Bitmap *glyphBitmap = &this->ftSlot->bitmap;

            textureWidth = adjustTextureWidth(glyphBitmap->width, this->textureFormat);
            textureHeight = adjustTextureHeight(glyphBitmap->rows, this->textureFormat);

            this->fontData[charCode] = (ftgxCharData) {
                this->ftSlot->bitmap_left,
                this->ftSlot->advance.x >> 6,
                gIndex,
                textureWidth,
                textureHeight,
                this->ftSlot->bitmap_top,
                this->ftSlot->bitmap_top,
                glyphBitmap->rows - this->ftSlot->bitmap_top,
                NULL
            };
            this->loadGlyphData(glyphBitmap, &this->fontData[charCode]);

            return &this->fontData[charCode];
        }
    }

    return NULL;
}

/**
 * Locates each character in this wrapper's configured font face and proccess them.
 *
 * This routine locates each character in the configured font face and renders the glyph's bitmap.
 * Each bitmap and relevant information is loaded into its own quickly addressible structure within an instance-specific map.
 */
uint16_t FreeTypeGX::cacheGlyphDataComplete() {
    uint16_t i = 0;
    FT_UInt gIndex;
    FT_ULong charCode = FT_Get_First_Char( this->ftFace, &gIndex );
    while ( gIndex != 0 ) {

        if (this->cacheGlyphData(charCode) != NULL) {
            i++;
        }

        charCode = FT_Get_Next_Char( this->ftFace, charCode, &gIndex );
    }

    return i;
}

/**
 * Loads the rendered bitmap into the relevant structure's data buffer.
 *
 * This routine does a simple byte-wise copy of the glyph's rendered 8-bit grayscale bitmap into the structure's buffer.
 * Each byte is converted from the bitmap's intensity value into the a uint32_t RGBA value.
 *
 * @param bmp	A pointer to the most recently rendered glyph's bitmap.
 * @param charData	A pointer to an allocated ftgxCharData structure whose data represent that of the last rendered glyph.
 */
void FreeTypeGX::loadGlyphData(FT_Bitmap *bmp, ftgxCharData *charData) {

    uint32_t *glyphData = (uint32_t *)memalign(32, charData->textureWidth * charData->textureHeight * 4);
    memset(glyphData, 0x00, charData->textureWidth * charData->textureHeight * 4);

    for (uint16_t imagePosY = 0; imagePosY < bmp->rows; imagePosY++) {
        for (uint16_t imagePosX = 0; imagePosX < bmp->width; imagePosX++) {
            uint32_t pixel = (uint32_t) bmp->buffer[imagePosY * bmp->width + imagePosX];
            glyphData[imagePosY * charData->textureWidth + imagePosX] = 0x00000000 | (pixel << 24) | (pixel << 16) | (pixel << 8) | pixel;
        }
    }

    switch (this->textureFormat) {
    case GX_TF_I4:
        charData->glyphDataTexture = Metaphrasis::convertBufferToI4(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_I8:
        charData->glyphDataTexture = Metaphrasis::convertBufferToI8(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_IA4:
        charData->glyphDataTexture = Metaphrasis::convertBufferToIA4(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_IA8:
        charData->glyphDataTexture = Metaphrasis::convertBufferToIA8(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_RGB565:
        charData->glyphDataTexture = Metaphrasis::convertBufferToRGB565(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_RGB5A3:
        charData->glyphDataTexture = Metaphrasis::convertBufferToRGB5A3(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    case GX_TF_RGBA8:
    default:
        charData->glyphDataTexture = Metaphrasis::convertBufferToRGBA8(glyphData, charData->textureWidth, charData->textureHeight);
        break;
    }

    free(glyphData);
}

/**
 * Determines the x offset of the rendered string.
 *
 * This routine calculates the x offset of the rendered string based off of a supplied positional format parameter.
 *
 * @param width	Current pixel width of the string.
 * @param format	Positional format of the string.
 */
int16_t FreeTypeGX::getStyleOffsetWidth(uint16_t width, uint16_t format) {

    switch (format & FTGX_JUSTIFY_MASK) {
    case FTGX_JUSTIFY_LEFT:
        return 0;

    default:
    case FTGX_JUSTIFY_CENTER:
        return -(width >> 1);

    case FTGX_JUSTIFY_RIGHT:
        return -width;
    }

    return 0;
}

/**
 * Determines the y offset of the rendered string.
 *
 * This routine calculates the y offset of the rendered string based off of a supplied positional format parameter.
 *
 * @param offset	Current pixel offset data of the string.
 * @param format	Positional format of the string.
 */
int16_t FreeTypeGX::getStyleOffsetHeight(ftgxDataOffset *offset, uint16_t format) {
    switch (format & FTGX_ALIGN_MASK) {
    case FTGX_ALIGN_TOP:
        return offset->ascender;

    default:
    case FTGX_ALIGN_MIDDLE:
        return  (offset->ascender + offset->descender + 1) >> 1;

    case FTGX_ALIGN_BOTTOM:
        return offset->descender;

    case FTGX_ALIGN_BASELINE:
        return 0;

    case FTGX_ALIGN_GLYPH_TOP:
        return offset->max;

    case FTGX_ALIGN_GLYPH_MIDDLE:
        return (offset->max + offset->min + 1) >> 1;

    case FTGX_ALIGN_GLYPH_BOTTOM:
        return offset->min;
    }

    return 0;
}

/**
 * Processes the supplied text string and prints the results at the specified coordinates.
 *
 * This routine processes each character of the supplied text string, loads the relevant preprocessed bitmap buffer,
 * a texture from said buffer, and loads the resultant texture into the EFB.
 *
 * @param x	Screen X coordinate at which to output the text.
 * @param y Screen Y coordinate at which to output the text. Note that this value corresponds to the text string origin and not the top or bottom of the glyphs.
 * @param text	NULL terminated string to output.
 * @param color	Optional color to apply to the text characters. If not specified default value is ftgxWhite: (GXColor){0xff, 0xff, 0xff, 0xff}
 * @param textStyle	Flags which specify any styling which should be applied to the rendered string.
 * @return The number of characters printed.
 */
uint16_t FreeTypeGX::drawText(int16_t x, int16_t y, wchar_t *text, GXColor color, uint16_t textStyle) {
    uint16_t strLength = wcslen(text);
    uint16_t x_pos = x, printed = 0;
    uint16_t x_offset = 0, y_offset = 0;
    GXTexObj glyphTexture;
    FT_Vector pairDelta;
    ftgxDataOffset offset;

    if (textStyle & FTGX_JUSTIFY_MASK) {
        x_offset = this->getStyleOffsetWidth(this->getWidth(text), textStyle);
    }
    if (textStyle & FTGX_ALIGN_MASK) {
        y_offset = this->getStyleOffsetHeight(this->getOffset(text, &offset), textStyle);
    }

    for (uint16_t i = 0; i < strLength; i++) {

        ftgxCharData* glyphData = NULL;
        if ( this->fontData.find(text[i]) != this->fontData.end() ) {
            glyphData = &this->fontData[text[i]];
        } else {
            glyphData = this->cacheGlyphData(text[i]);
        }

        if (glyphData != NULL) {

            if (this->ftKerningEnabled && i) {
                FT_Get_Kerning( this->ftFace, this->fontData[text[i - 1]].glyphIndex, glyphData->glyphIndex, FT_KERNING_DEFAULT, &pairDelta );
                x_pos += pairDelta.x >> 6;
            }

            GX_InitTexObj(&glyphTexture, glyphData->glyphDataTexture, glyphData->textureWidth, glyphData->textureHeight, this->textureFormat, GX_CLAMP, GX_CLAMP, GX_FALSE);
            this->copyTextureToFramebuffer(&glyphTexture, glyphData->textureWidth, glyphData->textureHeight, x_pos + glyphData->renderOffsetX + x_offset, y - glyphData->renderOffsetY + y_offset, color);

            x_pos += glyphData->glyphAdvanceX;
            printed++;
        }
    }

    if (textStyle & FTGX_STYLE_MASK) {
        this->drawTextFeature(x + x_offset, y + y_offset, this->getWidth(text), this->getOffset(text, &offset), textStyle, color);
    }

    return printed;
}

/**
 * \overload
 */
uint16_t FreeTypeGX::drawText(int16_t x, int16_t y, wchar_t const *text, GXColor color, uint16_t textStyle) {
    return this->drawText(x, y, (wchar_t *)text, color, textStyle);
}

void FreeTypeGX::drawTextFeature(int16_t x, int16_t y, uint16_t width, ftgxDataOffset *offsetData, uint16_t format, GXColor color) {
    uint16_t featureHeight = this->ftPointSize >> 4 > 0 ? this->ftPointSize >> 4 : 1;

    if (format & FTGX_STYLE_UNDERLINE ) {
        switch (format & FTGX_ALIGN_MASK) {
            /*
            			case FTGX_ALIGN_TOP:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y + offsetData->max + 1, color);
            				break;
            			case FTGX_ALIGN_MIDDLE:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y + ((offsetData->max - offsetData->min + 1) >> 1), color);
            				break;
            			case FTGX_ALIGN_BOTTOM:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y - offsetData->min, color);
            				break;
            */
        default:
            this->copyFeatureToFramebuffer(width, featureHeight, x, y + 1, color);
            break;
        }
    }

    if (format & FTGX_STYLE_STRIKE ) {
        switch (format & FTGX_ALIGN_MASK) {
            /*
            			case FTGX_ALIGN_TOP:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y + ((offsetData->max - offsetData->min + 1) >> 1), color);
            				break;
            			case FTGX_ALIGN_MIDDLE:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y, color);
            				break;
            			case FTGX_ALIGN_BOTTOM:
            				this->copyFeatureToFramebuffer(width, featureHeight, x, y - ((offsetData->max + offsetData->min) >> 1), color);
            				break;
            */
        default:
//				this->copyFeatureToFramebuffer(width, featureHeight, x, y - ((offsetData->max - offsetData->min) >> 1), color);
            this->copyFeatureToFramebuffer(width, featureHeight, x, y - ((offsetData->max) >> 1), color);
            break;
        }
    }
}

/**
 * Processes the supplied string and return the width of the string in pixels.
 *
 * This routine processes each character of the supplied text string and calculates the width of the entire string.
 * Note that if precaching of the entire font set is not enabled any uncached glyph will be cached after the call to this function.
 *
 * @param text	NULL terminated string to calculate.
 * @return The width of the text string in pixels.
 */
uint16_t FreeTypeGX::getWidth(wchar_t *text) {
    uint16_t strLength = wcslen(text);
    uint16_t strWidth = 0;
    FT_Vector pairDelta;

    for (uint16_t i = 0; i < strLength; i++) {

        ftgxCharData* glyphData = NULL;
        if ( this->fontData.find(text[i]) != this->fontData.end() ) {
            glyphData = &this->fontData[text[i]];
        } else {
            glyphData = this->cacheGlyphData(text[i]);
        }

        if (glyphData != NULL) {
            if (this->ftKerningEnabled && (i > 0)) {
                FT_Get_Kerning( this->ftFace, this->fontData[text[i - 1]].glyphIndex, glyphData->glyphIndex, FT_KERNING_DEFAULT, &pairDelta );
                strWidth += pairDelta.x >> 6;
            }

            strWidth += glyphData->glyphAdvanceX;
        }
    }

    return strWidth;
}

/**
 *
 * \overload
 */
uint16_t FreeTypeGX::getWidth(wchar_t const *text) {
    return this->getWidth((wchar_t *)text);
}

/**
 * Processes the supplied string and return the height of the string in pixels.
 *
 * This routine processes each character of the supplied text string and calculates the height of the entire string.
 * Note that if precaching of the entire font set is not enabled any uncached glyph will be cached after the call to this function.
 *
 * @param text	NULL terminated string to calculate.
 * @return The height of the text string in pixels.
 */
uint16_t FreeTypeGX::getHeight(wchar_t *text) {
    ftgxDataOffset offset;
    this->getOffset(text, &offset);

    return offset.max - offset.min;
}

/**
 *
 * \overload
 */
uint16_t FreeTypeGX::getHeight(wchar_t const *text) {
    return this->getHeight((wchar_t *)text);
}

/**
 * Get the maximum offset above and minimum offset below the font origin line.
 *
 * This function calculates the maximum pixel height above the font origin line and the minimum
 * pixel height below the font origin line and returns the values in an addressible structure.
 *
 * @param text	NULL terminated string to calculate.
 * @param offset returns the max and min values above and below the font origin line
 *
 */
ftgxDataOffset* FreeTypeGX::getOffset(wchar_t *text, ftgxDataOffset* offset) {
    uint16_t strLength = wcslen(text);
    int16_t strMax = 0, strMin = 9999;

    for (uint16_t i = 0; i < strLength; i++) {

        ftgxCharData* glyphData = NULL;
        if ( this->fontData.find(text[i]) != this->fontData.end() ) {
            glyphData = &this->fontData[text[i]];
        } else {
            glyphData = this->cacheGlyphData(text[i]);
        }

        if (glyphData != NULL) {
            strMax = glyphData->renderOffsetMax > strMax ? glyphData->renderOffsetMax : strMax;
            strMin = glyphData->renderOffsetMin < strMin ? glyphData->renderOffsetMin : strMin;
        }
    }
    offset->ascender = this->ftFace->size->metrics.ascender>>6;
    offset->descender = this->ftFace->size->metrics.descender>>6;
    offset->max = strMax;
    offset->min = strMin;
    return offset;
}

/**
 *
 * \overload
 */
ftgxDataOffset* FreeTypeGX::getOffset(wchar_t const *text, ftgxDataOffset* offset) {
    return this->getOffset(text, offset);
}

/**
 * Copies the supplied texture quad to the EFB.
 *
 * This routine uses the in-built GX quad builder functions to define the texture bounds and location on the EFB target.
 *
 * @param texObj	A pointer to the glyph's initialized texture object.
 * @param texWidth	The pixel width of the texture object.
 * @param texHeight	The pixel height of the texture object.
 * @param screenX	The screen X coordinate at which to output the rendered texture.
 * @param screenY	The screen Y coordinate at which to output the rendered texture.
 * @param color	Color to apply to the texture.
 */
void FreeTypeGX::copyTextureToFramebuffer(GXTexObj *texObj, f32 texWidth, f32 texHeight, int16_t screenX, int16_t screenY, GXColor color) {

    GX_LoadTexObj(texObj, GX_TEXMAP0);
    GX_InvalidateTexAll();

    GX_SetTevOp (GX_TEVSTAGE0, GX_MODULATE);
    GX_SetVtxDesc (GX_VA_TEX0, GX_DIRECT);

    GX_Begin(GX_QUADS, this->vertexIndex, 4);
    GX_Position2s16(screenX, screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);
    GX_TexCoord2f32(0.0f, 0.0f);

    GX_Position2s16(texWidth + screenX, screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);
    GX_TexCoord2f32(1.0f, 0.0f);

    GX_Position2s16(texWidth + screenX, texHeight + screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);
    GX_TexCoord2f32(1.0f, 1.0f);

    GX_Position2s16(screenX, texHeight + screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);
    GX_TexCoord2f32(0.0f, 1.0f);
    GX_End();

    this->setDefaultMode();
}

/**
 * Creates a feature quad to the EFB.
 *
 * This function creates a simple quad for displaying underline or strikeout text styling.
 *
 * @param featureWidth	The pixel width of the quad.
 * @param featureHeight	The pixel height of the quad.
 * @param screenX	The screen X coordinate at which to output the quad.
 * @param screenY	The screen Y coordinate at which to output the quad.
 * @param color	Color to apply to the texture.
 */
void FreeTypeGX::copyFeatureToFramebuffer(f32 featureWidth, f32 featureHeight, int16_t screenX, int16_t screenY, GXColor color) {

    GX_SetTevOp (GX_TEVSTAGE0, GX_PASSCLR);
    GX_SetVtxDesc (GX_VA_TEX0, GX_NONE);

    GX_Begin(GX_QUADS, this->vertexIndex, 4);
    GX_Position2s16(screenX, screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);

    GX_Position2s16(featureWidth + screenX, screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);

    GX_Position2s16(featureWidth + screenX, featureHeight + screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);

    GX_Position2s16(screenX, featureHeight + screenY);
    GX_Color4u8(color.r, color.g, color.b, color.a);
    GX_End();

    this->setDefaultMode();
}