ascension: src/ascension/font.h@9dbfc0031887

     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 #ifndef ASC_MAX_FONTS

    34 /** The maximum number of style/size combinations that can be loaded in parallel. */

    35 #define ASC_MAX_FONTS 64u

    36 #endif // ASC_MAX_FONTS

    38 enum AscFontStyle {

    39     ASC_FONT_REGULAR,

    40     ASC_FONT_BOLD,

    41     ASC_FONT_ITALIC,

    42     ASC_FONT_BOLD_ITALIC,

    43 };

    45 typedef struct AscFont {

    46     /**

    47      * Style of the font.

    48      */

    49     enum AscFontStyle style;

    50     /**

    51      * Point size.

    52      */

    53     int size;

    54     /**

    55      * Pointer to the SDL TTF font structure.

    56      */

    57     TTF_Font *ptr;

    58 } AscFont;

    60 /**

    61  * Loads a font with the given style and size.

    62  *

    63  * The font is cached and returned faster the next time you call this

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

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

    66  *

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

    68  * different sizes at the same time, and you should not keep the pointer

    69  * returned by this function too long, because you would risking cache misses.

    70  *

    71  * @param style the style

    72  * @param size the point size

    73  * @return a pointer to the font structure (do not free)

    74  */

    75 AscFont const *asc_font(enum AscFontStyle style, int size);

    77 /**

    78  * Unloads all cached fonts from the context.

    79  */

    80 void asc_font_cache_clear(void);

    82 /**

    83  * Checks, if the font is still loaded and reloads it, if required.

    84  *

    85  * There is no need to call this function manually. Every Ascension function

    86  * that you pass a font will do that for you and use the returned pointer in

    87  * case of a cache miss.

    88  *

    89  * @param font the font to validate

    90  * @return \p font, or a pointer to the new location of the loaded font

    91  */

    92 AscFont const *asc_font_cache_validate(AscFont const *font);

    94 #endif //ASCENSION_FONT_H

Mercurial > hg > ascension / file revision