nvtexfont.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003 - 2012 NVIDIA Corporation.  All rights reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA Corporation is strictly prohibited.
 *
 * This software is based upon texfont, with consent from Mark J. Kilgard,
 * provided under the following terms:
 *
 * Copyright (c) Mark J. Kilgard, 1997.
 *
 * This program is freely distributable without licensing fees  and is
 * provided without guarantee or warrantee expressed or  implied. This
 * program is -not- in the public domain.
 */

#ifndef __NV_TEXFONT_H__
#define __NV_TEXFONT_H__


#ifdef __cplusplus
extern "C" {
#endif

//
// Public data types
//

#define TXF_FORMAT_BYTE     0
#define TXF_FORMAT_BITMAP   1

typedef void * NVTexfontContext;

typedef enum {
    NV_TEXFONT_DEFAULT = 0,
    NV_TEXFONT_HELVETICA = 0,
} NVTexfontRasterFontName;

typedef enum {
    NV_VECTOR_TEXFONT_DEFAULT = 0,
    NV_VECTOR_TEXFONT_INCONSOLATA = 0
} NVTexfontVectorFontName;

typedef struct _NVTexfontRasterFont NVTexfontRasterFont;
typedef struct _NVTexfontVectorFont NVTexfontVectorFont;

//
// General functions
//

extern char*
nvtexfontErrorString(void);

extern NVTexfontContext
nvtexfontAllocContext(void);

extern void
nvtexfontFreeContext(
    NVTexfontContext tfc);

extern void
nvtexfontSetContextPos(
    NVTexfontContext tfc,
    float            x,
    float            y);

extern void
nvtexfontSetContextScale(
    NVTexfontContext tfc,
    float            scaleX,
    float            scaleY);

extern void
nvtexfontSetContextColor(
    NVTexfontContext tfc,
    float            r,
    float            g,
    float            b);

// TODO: Raster and vector font structures/functions should be merged
// TODO:   so that we initialize a font object as one or the other and
// TODO:   then use the same set of top level functions for rendering.


extern int
nvtexfontInRasterFont(
    NVTexfontRasterFont     *txf,
    int                     c);
extern NVTexfontRasterFont*
nvtexfontInitRasterFont(
    NVTexfontRasterFontName font,
    GLuint                  texobj,
    GLboolean               setupMipmaps,
    GLenum                  minFilter,
    GLenum                  magFilter);

extern void
nvtexfontUnloadRasterFont(
    NVTexfontRasterFont     *txf);

extern void
nvtexfontRenderString_All(
    NVTexfontRasterFont     *txf,
    char                    *string,
    float                   x,
    float                   y,
    float                   scaleX,
    float                   scaleY,
    float                   r,
    float                   g,
    float                   b);

extern void
nvtexfontRenderString_Pos(
    NVTexfontRasterFont     *txf,
    NVTexfontContext        tfc,
    char                    *string,
    float                   x,
    float                   y);

extern void
nvtexfontRenderString(
    NVTexfontRasterFont     *txf,
    NVTexfontContext        tfc,
    char                    *string);

extern void
nvtexfontGetStringMetrics(
    NVTexfontRasterFont     *txf,
    char                    *string,
    int                     len,
    int                     *width,
    int                     *max_ascent,
    int                     *max_descent);


extern int
nvtexfontInVectorFont(
    NVTexfontVectorFont     *vtf,
    int                     c);

extern NVTexfontVectorFont*
nvtexfontInitVectorFont(
    NVTexfontVectorFontName font,
    GLboolean               antialias,
    GLboolean               use_vbo);

extern void
nvtexfontUnloadVectorFont(
    NVTexfontVectorFont     *vtf);

extern void
nvtexfontRenderVecString_All(
    NVTexfontVectorFont     *vtf,
    char                    *string,
    float                   x,
    float                   y,
    float                   scaleX,
    float                   scaleY,
    float                   r,
    float                   g,
    float                   b);

extern void
nvtexfontRenderVecString_Pos(
    NVTexfontVectorFont     *vtf,
    NVTexfontContext        tfc,
    char                    *string,
    float                   x,
    float                   y);

extern void
nvtexfontRenderVecString(
    NVTexfontVectorFont     *vtf,
    NVTexfontContext        tfc,
    char                    *string);

#ifdef __cplusplus
}
#endif

#endif /* __NV_TEXFONT_H__ */