Tao.Sdl SDK Documentation

SdlTtf.TTF_OpenFontIndexRW Method 

Open a font file using RWOps with an index and create a font of the specified point size. Some .fon fonts will have several sizes embedded in the file, so the point size becomes the index of choosing which size. If the value is too high, the last indexed size will be the default.

[Visual Basic]
Public Shared Function TTF_OpenFontIndexRW( _
   ByVal src As IntPtr, _
   ByVal freesrc As Integer, _
   ByVal ptsize As Integer, _
   ByVal index As Long _
) As IntPtr
[C#]
public static IntPtr TTF_OpenFontIndexRW(
   IntPtr src,
   int freesrc,
   int ptsize,
   long index
);

Parameters

src
The font is loaded from this.
freesrc
A non-zero value mean is will automatically close/free the src for you.
ptsize
Point size (based on 72DPI) to load font as. This basically translates to pixel height.
index
choose a font face from a multiple font face containing file. The first face is always index 0.

Return Value

a pointer to the font as a TTF_Font. NULL is returned on errors.

Remarks

Load src, face index, for use as a font, at ptsize size. This can load TTF and FON formats. Using SDL_RWops is not covered here, but they enable you to load from almost any source. NOTE: src is not checked for NULL, so be careful.

Binds to C-function in SDL_ttf.h

            TTF_Font *TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index)
            

Example

            // load font.ttf, face 0, at size 16 into font
                    TTF_Font *font;
                    font=TTF_OpenFontRW(SDL_RWFromFile("font.ttf"), 1, 16, 0);
                    if(!font)
                {
                    printf("TTF_OpenFontIndexRW: %s\n", TTF_GetError());
                    // handle error
                }
            

See Also

SdlTtf Class | Tao.Sdl Namespace | TTF_OpenFontIndex | TTF_OpenFontRW | TTF_CloseFont