ascension: src/ascension/ui/font.h@8297afa1c29c

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  * Copyright 2023 Mike Becker. All rights reserved.

     4  *

     5  * Redistribution and use in source and binary forms, with or without

     6  * modification, are permitted provided that the following conditions are met:

     7  *

     8  *   1. Redistributions of source code must retain the above copyright

     9  *      notice, this list of conditions and the following disclaimer.

    10  *

    11  *   2. Redistributions in binary form must reproduce the above copyright

    12  *      notice, this list of conditions and the following disclaimer in the

    13  *      documentation and/or other materials provided with the distribution.

    14  *

    15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

    19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    25  * POSSIBILITY OF SUCH DAMAGE.

    26  */

    28 #ifndef ASCENSION_FONT_H

    29 #define ASCENSION_FONT_H

    31 #include <SDL2/SDL_ttf.h>

    33 enum AscFontStyle {

    34     ASC_FONT_REGULAR,

    35     ASC_FONT_BOLD,

    36     ASC_FONT_ITALIC,

    37     ASC_FONT_BOLD_ITALIC,

    38 };

    40 typedef struct AscFont {

    41     /**

    42      * Style of the font.

    43      */

    44     enum AscFontStyle style;

    45     /**

    46      * Point size.

    47      */

    48     int size;

    49 } AscFont;

    51 /**

    52  * Activates a font with the given style and size.

    53  *

    54  * The font is cached and activated faster the next time you call this

    55  * function with the same arguments. However, when you reach the maximum

    56  * number of fonts, the cache is completely cleared and rebuilt.

    57  *

    58  * That means in general, that you should not be using too many fonts of

    59  * different sizes at the same time.

    60  *

    61  * @param style the style

    62  * @param size the point size

    63  */

    64 void asc_font(enum AscFontStyle style, int size);

    66 /**

    67  * Loads the specified font.

    68  *

    69  * Loaded fonts are kept within a font cache and returned faster

    70  * on the next invocation.

    71  *

    72  * You will almost never need to use this function on your own.

    73  * Ascension UI elements are loading the required fonts for you.

    74  *

    75  * @param font the font description

    76  * @return a pointer to the SDL TTF font handle, or \c NULL on error

    77  */

    78 TTF_Font *asc_font_load(AscFont font);

    80 #endif //ASCENSION_FONT_H

Mercurial > hg > ascension / file revision