misc/builddeps/win32/sdl/include/SDL2/SDL_test_font.h

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