include/psp2/pgf.h

Go to the documentation of this file.

#ifndef _PSP2_PGF_H_
#define _PSP2_PGF_H_

#include <psp2/types.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* typedef */

typedef SceUID SceFontLibHandle;
typedef SceUID SceFontHandle;

/* struct */

enum {
    SCE_FONT_ERROR_OUT_OF_MEMORY        = 0x80460001,
    SCE_FONT_ERROR_INVALID_LIBID        = 0x80460002,
    SCE_FONT_ERROR_INVALID_PARAMETER    = 0x80460003,
    SCE_FONT_ERROR_HANDLER_OPEN_FAILED  = 0x80460005,
    SCE_FONT_ERROR_TOO_MANY_OPEN_FONTS  = 0x80460009,
    SCE_FONT_ERROR_INVALID_FONT_DATA    = 0x8046000a,
};

typedef struct SceSceFontNewLibParams {
    void *userData;
    unsigned int numFonts;
    void *cacheData;

    // Driver callbacks.
    void *(*allocFunc)(void *, unsigned int);
    void  (*freeFunc)(void *, void *);
    void *openFunc;
    void *closeFunc;
    void *readFunc;
    void *seekFunc;
    void *errorFunc;
    void *ioFinishFunc;
} SceFontNewLibParams;

typedef enum FontFamily {
    FONT_FAMILY_SANS_SERIF  = 1,
    FONT_FAMILY_SERIF   = 2,
} FontFamily;

typedef enum FontStyle {
    FONT_STYLE_REGULAR  = 1,
    FONT_STYLE_ITALIC   = 2,
    FONT_STYLE_BOLD = 5,
    FONT_STYLE_BOLD_ITALIC  = 6,
    FONT_STYLE_DB   = 103, // Demi-Bold / semi-bold
} FontStyle;

typedef enum FontLanguage {
    FONT_LANGUAGE_JAPANESE  = 1,
    FONT_LANGUAGE_LATIN = 2,
    FONT_LANGUAGE_KOREAN    = 3,
    FONT_LANGUAGE_CHINESE   = 4,
}FontLanguage;

typedef enum FontPixelFormat {
    FONT_PIXELFORMAT_4  = 0, // 2 pixels packed in 1 byte (natural order)
    FONT_PIXELFORMAT_4_REV  = 1, // 2 pixels packed in 1 byte (reversed order)
    FONT_PIXELFORMAT_8  = 2, // 1 pixel in 1 byte
    FONT_PIXELFORMAT_24 = 3, // 1 pixel in 3 bytes (RGB)
    FONT_PIXELFORMAT_32 = 4, // 1 pixel in 4 bytes (RGBA)
} FontPixelFormat;

typedef struct SceFontImageRect {
    short width;
    short height;
} SceFontImageRect;

typedef struct SceFontGlyphImage {
    FontPixelFormat pixelFormat;
    int xPos64;
    int yPos64;
    unsigned short bufWidth;
    unsigned short bufHeight;
    unsigned short bytesPerLine;
    unsigned short pad;
    unsigned int bufferPtr;
} SceFontGlyphImage;

typedef struct SceFontStyle {
    float fontH;
    float fontV;
    float fontHRes;
    float fontVRes;
    float fontWeight;
    unsigned short fontFamily;
    unsigned short fontStyle;
    // Check.
    unsigned short fontStyleSub;
    unsigned short fontLanguage;
    unsigned short fontRegion;
    unsigned short fontCountry;
    char fontName[64];
    char fontFileName[64];
    unsigned int fontAttributes;
    unsigned int fontExpire;
} SceFontStyle;

typedef struct SceFontCharInfo {
    unsigned int bitmapWidth;
    unsigned int bitmapHeight;
    unsigned int bitmapLeft;
    unsigned int bitmapTop;
    // Glyph metrics (in 26.6 signed fixed-point).
    unsigned int sfp26Width;
    unsigned int sfp26Height;
    int sfp26Ascender;
    int sfp26Descender;
    int sfp26BearingHX;
    int sfp26BearingHY;
    int sfp26BearingVX;
    int sfp26BearingVY;
    int sfp26AdvanceH;
    int sfp26AdvanceV;
    short shadowFlags;
    short shadowId;
} SceFontCharInfo;

typedef struct SceFontInfo {
    // Glyph metrics (in 26.6 signed fixed-point).
    unsigned int maxGlyphWidthI;
    unsigned int maxGlyphHeightI;
    unsigned int maxGlyphAscenderI;
    unsigned int maxGlyphDescenderI;
    unsigned int maxGlyphLeftXI;
    unsigned int maxGlyphBaseYI;
    unsigned int minGlyphCenterXI;
    unsigned int maxGlyphTopYI;
    unsigned int maxGlyphAdvanceXI;
    unsigned int maxGlyphAdvanceYI;

    // Glyph metrics (replicated as float).
    float maxGlyphWidthF;
    float maxGlyphHeightF;
    float maxGlyphAscenderF;
    float maxGlyphDescenderF;
    float maxGlyphLeftXF;
    float maxGlyphBaseYF;
    float minGlyphCenterXF;
    float maxGlyphTopYF;
    float maxGlyphAdvanceXF;
    float maxGlyphAdvanceYF;

    // Bitmap dimensions.
    short maxGlyphWidth;
    short maxGlyphHeight;
    unsigned int charMapLength;   // Number of elements in the font's charmap.
    unsigned int shadowMapLength; // Number of elements in the font's shadow charmap.

    // Font style (used by font comparison functions).
    SceFontStyle fontStyle;

    uint8_t BPP; // Font's BPP.
    uint8_t pad[3];
} SceFontInfo;

/* prototypes */

SceFontLibHandle sceFontNewLib(SceFontNewLibParams *params, unsigned int *errorCode);
int sceFontDoneLib(SceFontLibHandle libHandle);

SceFontHandle sceFontOpen(SceFontLibHandle libHandle,
    int index, int mode, unsigned int *errorCode);

SceFontHandle sceFontOpenUserMemory(SceFontLibHandle libHandle,
    void *pMemoryFont, SceSize pMemoryFontSize, unsigned int *errorCode);

SceFontHandle sceFontOpenUserFile(SceFontLibHandle libHandle,
    char *file, int mode, unsigned int *errorCode);

int sceFontClose(SceFontHandle fontHandle);

int sceFontGetNumFontList(SceFontLibHandle libHandle, unsigned int *errorCode);

int sceFontFindOptimumFont(SceFontLibHandle libHandle,
    SceFontStyle *fontStyle, unsigned int *errorCode);

int sceFontFindFont(SceFontLibHandle libHandle,
    SceFontStyle *fontStyle, unsigned int *errorCode);

int sceFontGetFontInfo(SceFontHandle fontHandle, SceFontInfo *fontInfo);

int sceFontGetFontInfoByIndexNumber(SceFontLibHandle libHandle,
    SceFontStyle *fontStyle, int unknown, int fontIndex);

int sceFontSetResolution(SceFontLibHandle libHandle, float hRes, float vRes);

int sceFontGetFontList(SceFontLibHandle libHandle,
    SceFontStyle *fontStyle, int numFonts);

int sceFontGetCharInfo(SceFontHandle fontHandle,
    unsigned int charCode, SceFontCharInfo *charInfo);

int sceFontGetCharImageRect(SceFontHandle fontHandle,
    unsigned int charCode, SceFontImageRect *charRect);

int sceFontGetCharGlyphImage(SceFontHandle fontHandle,
    unsigned int charCode, SceFontGlyphImage *glyphImage);

int sceFontGetCharGlyphImage_Clip(SceFontHandle fontHandle,
    unsigned int charCode, SceFontGlyphImage *glyphImage,
    int clipXPos, int clipYPos, int clipWidth, int clipHeight);

float sceFontPixelToPointH(SceFontLibHandle libHandle,
    float fontPixelsH, unsigned int *errorCode);

float sceFontPixelToPointV(SceFontLibHandle libHandle,
    float fontPixelsV, unsigned int *errorCode);

float sceFontPointToPixelH(SceFontLibHandle libHandle,
    float fontPointsH, unsigned int *errorCode);

float sceFontPointToPixelV(SceFontLibHandle libHandle,
    float fontPointsV, unsigned int *errorCode);

int sceFontSetAltCharacterCode(SceFontLibHandle libHandle, unsigned int charCode);

int sceFontFlush(SceFontHandle fontHandle);

#ifdef __cplusplus
}
#endif

#endif /* _PSP2_PGF_H_ */