include/SDL_test_font.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 25 Oct 2018 12:54:42 -0700
changeset 12357 40f09c8c517b
parent 11811 5d94cb6b24d3
child 12503 806492103856
permissions -rw-r--r--
Added SDL_JoystickGetXInputUserIndex()
slouken@6688
     1
/*
slouken@6688
     2
  Simple DirectMedia Layer
slouken@11811
     3
  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
slouken@6688
     4
slouken@6688
     5
  This software is provided 'as-is', without any express or implied
slouken@6688
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@6688
     7
  arising from the use of this software.
slouken@6688
     8
slouken@6688
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@6688
    10
  including commercial applications, and to alter it and redistribute it
slouken@6688
    11
  freely, subject to the following restrictions:
slouken@6688
    12
slouken@6688
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@6688
    14
     claim that you wrote the original software. If you use this software
slouken@6688
    15
     in a product, an acknowledgment in the product documentation would be
slouken@6688
    16
     appreciated but is not required.
slouken@6688
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@6688
    18
     misrepresented as being the original software.
slouken@6688
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@6688
    20
*/
slouken@6688
    21
slouken@6688
    22
/**
slouken@6688
    23
 *  \file SDL_test_font.h
slouken@7191
    24
 *
slouken@6688
    25
 *  Include file for SDL test framework.
slouken@6688
    26
 *
slouken@6688
    27
 *  This code is a part of the SDL2_test library, not the main SDL library.
slouken@6688
    28
 */
slouken@6688
    29
slouken@10638
    30
#ifndef SDL_test_font_h_
slouken@10638
    31
#define SDL_test_font_h_
slouken@6688
    32
slouken@6688
    33
#include "begin_code.h"
slouken@6688
    34
/* Set up for C function definitions, even when using C++ */
slouken@6688
    35
#ifdef __cplusplus
slouken@6688
    36
extern "C" {
slouken@6688
    37
#endif
slouken@6688
    38
slouken@6688
    39
/* Function prototypes */
slouken@6688
    40
slouken@8206
    41
#define FONT_CHARACTER_SIZE  8
slouken@8206
    42
slouken@8206
    43
/**
slouken@8206
    44
 *  \brief Draw a string in the currently set font.
slouken@8206
    45
 *
slouken@8206
    46
 *  \param renderer The renderer to draw on.
slouken@8206
    47
 *  \param x The X coordinate of the upper left corner of the character.
slouken@8206
    48
 *  \param y The Y coordinate of the upper left corner of the character.
slouken@8206
    49
 *  \param c The character to draw.
slouken@8206
    50
 *
slouken@8206
    51
 *  \returns Returns 0 on success, -1 on failure.
slouken@8206
    52
 */
slouken@11465
    53
int SDLTest_DrawCharacter(SDL_Renderer *renderer, int x, int y, char c);
slouken@8206
    54
slouken@6688
    55
/**
slouken@6688
    56
 *  \brief Draw a string in the currently set font.
slouken@6688
    57
 *
slouken@6688
    58
 *  \param renderer The renderer to draw on.
slouken@6688
    59
 *  \param x The X coordinate of the upper left corner of the string.
slouken@6688
    60
 *  \param y The Y coordinate of the upper left corner of the string.
slouken@6688
    61
 *  \param s The string to draw.
slouken@6688
    62
 *
slouken@6688
    63
 *  \returns Returns 0 on success, -1 on failure.
slouken@6688
    64
 */
slouken@11465
    65
int SDLTest_DrawString(SDL_Renderer *renderer, int x, int y, const char *s);
slouken@6688
    66
slouken@6688
    67
slouken@11465
    68
/**
slouken@11465
    69
 *  \brief Cleanup textures used by font drawing functions.
slouken@11465
    70
 */
slouken@11467
    71
void SDLTest_CleanupTextDrawing(void);
slouken@11465
    72
slouken@6688
    73
/* Ends C function definitions when using C++ */
slouken@6688
    74
#ifdef __cplusplus
slouken@6688
    75
}
slouken@6688
    76
#endif
slouken@6688
    77
#include "close_code.h"
slouken@6688
    78
slouken@10638
    79
#endif /* SDL_test_font_h_ */
slouken@6688
    80
slouken@6688
    81
/* vi: set ts=4 sw=4 expandtab: */