SDL_test_font.h

00001 /*
00002   Simple DirectMedia Layer
00003   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
00004 
00005   This software is provided 'as-is', without any express or implied
00006   warranty.  In no event will the authors be held liable for any damages
00007   arising from the use of this software.
00008 
00009   Permission is granted to anyone to use this software for any purpose,
00010   including commercial applications, and to alter it and redistribute it
00011   freely, subject to the following restrictions:
00012 
00013   1. The origin of this software must not be misrepresented; you must not
00014      claim that you wrote the original software. If you use this software
00015      in a product, an acknowledgment in the product documentation would be
00016      appreciated but is not required.
00017   2. Altered source versions must be plainly marked as such, and must not be
00018      misrepresented as being the original software.
00019   3. This notice may not be removed or altered from any source distribution.
00020 */
00021 
00022 /**
00023  *  \file SDL_test_font.h
00024  *
00025  *  Include file for SDL test framework.
00026  *
00027  *  This code is a part of the SDL2_test library, not the main SDL library.
00028  */
00029 
00030 #ifndef _SDL_test_font_h
00031 #define _SDL_test_font_h
00032 
00033 #include "begin_code.h"
00034 /* Set up for C function definitions, even when using C++ */
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 /* Function prototypes */
00040 
00041 #define FONT_CHARACTER_SIZE  8
00042 
00043 /**
00044  *  \brief Draw a string in the currently set font.
00045  *
00046  *  \param renderer The renderer to draw on.
00047  *  \param x The X coordinate of the upper left corner of the character.
00048  *  \param y The Y coordinate of the upper left corner of the character.
00049  *  \param c The character to draw.
00050  *
00051  *  \returns Returns 0 on success, -1 on failure.
00052  */
00053 int SDLTest_DrawCharacter( SDL_Renderer *renderer, int x, int y, char c );
00054 
00055 /**
00056  *  \brief Draw a string in the currently set font.
00057  *
00058  *  \param renderer The renderer to draw on.
00059  *  \param x The X coordinate of the upper left corner of the string.
00060  *  \param y The Y coordinate of the upper left corner of the string.
00061  *  \param s The string to draw.
00062  *
00063  *  \returns Returns 0 on success, -1 on failure.
00064  */
00065 int SDLTest_DrawString( SDL_Renderer * renderer, int x, int y, const char *s );
00066 
00067 
00068 /* Ends C function definitions when using C++ */
00069 #ifdef __cplusplus
00070 }
00071 #endif
00072 #include "close_code.h"
00073 
00074 #endif /* _SDL_test_font_h */
00075 
00076 /* vi: set ts=4 sw=4 expandtab: */