Miguel Ruiz / SDL_lib

SDL standard library

Dependents:   H261_encoder

SDL_error.h@0:dda4f4550403, 2016-09-07 (annotated)

Committer:
miruga27
Date:
Wed Sep 07 18:46:53 2016 +0000
Revision:
0:dda4f4550403
7/09/2016;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
miruga27 0:dda4f4550403 1 /*
miruga27 0:dda4f4550403 2 Simple DirectMedia Layer
miruga27 0:dda4f4550403 3 Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
miruga27 0:dda4f4550403 4
miruga27 0:dda4f4550403 5 This software is provided 'as-is', without any express or implied
miruga27 0:dda4f4550403 6 warranty. In no event will the authors be held liable for any damages
miruga27 0:dda4f4550403 7 arising from the use of this software.
miruga27 0:dda4f4550403 8
miruga27 0:dda4f4550403 9 Permission is granted to anyone to use this software for any purpose,
miruga27 0:dda4f4550403 10 including commercial applications, and to alter it and redistribute it
miruga27 0:dda4f4550403 11 freely, subject to the following restrictions:
miruga27 0:dda4f4550403 12
miruga27 0:dda4f4550403 13 1. The origin of this software must not be misrepresented; you must not
miruga27 0:dda4f4550403 14 claim that you wrote the original software. If you use this software
miruga27 0:dda4f4550403 15 in a product, an acknowledgment in the product documentation would be
miruga27 0:dda4f4550403 16 appreciated but is not required.
miruga27 0:dda4f4550403 17 2. Altered source versions must be plainly marked as such, and must not be
miruga27 0:dda4f4550403 18 misrepresented as being the original software.
miruga27 0:dda4f4550403 19 3. This notice may not be removed or altered from any source distribution.
miruga27 0:dda4f4550403 20 */
miruga27 0:dda4f4550403 21
miruga27 0:dda4f4550403 22 /**
miruga27 0:dda4f4550403 23 * \file SDL_error.h
miruga27 0:dda4f4550403 24 *
miruga27 0:dda4f4550403 25 * Simple error message routines for SDL.
miruga27 0:dda4f4550403 26 */
miruga27 0:dda4f4550403 27
miruga27 0:dda4f4550403 28 #ifndef _SDL_error_h
miruga27 0:dda4f4550403 29 #define _SDL_error_h
miruga27 0:dda4f4550403 30
miruga27 0:dda4f4550403 31 #include "SDL_stdinc.h"
miruga27 0:dda4f4550403 32
miruga27 0:dda4f4550403 33 #include "begin_code.h"
miruga27 0:dda4f4550403 34 /* Set up for C function definitions, even when using C++ */
miruga27 0:dda4f4550403 35 #ifdef __cplusplus
miruga27 0:dda4f4550403 36 extern "C" {
miruga27 0:dda4f4550403 37 #endif
miruga27 0:dda4f4550403 38
miruga27 0:dda4f4550403 39 /* Public functions */
miruga27 0:dda4f4550403 40 /* SDL_SetError() unconditionally returns -1. */
miruga27 0:dda4f4550403 41 extern DECLSPEC int SDLCALL SDL_SetError(const char *fmt, ...);
miruga27 0:dda4f4550403 42 extern DECLSPEC const char *SDLCALL SDL_GetError(void);
miruga27 0:dda4f4550403 43 extern DECLSPEC void SDLCALL SDL_ClearError(void);
miruga27 0:dda4f4550403 44
miruga27 0:dda4f4550403 45 /**
miruga27 0:dda4f4550403 46 * \name Internal error functions
miruga27 0:dda4f4550403 47 *
miruga27 0:dda4f4550403 48 * \internal
miruga27 0:dda4f4550403 49 * Private error reporting function - used internally.
miruga27 0:dda4f4550403 50 */
miruga27 0:dda4f4550403 51 /* @{ */
miruga27 0:dda4f4550403 52 #define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM)
miruga27 0:dda4f4550403 53 #define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED)
miruga27 0:dda4f4550403 54 #define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))
miruga27 0:dda4f4550403 55 typedef enum
miruga27 0:dda4f4550403 56 {
miruga27 0:dda4f4550403 57 SDL_ENOMEM,
miruga27 0:dda4f4550403 58 SDL_EFREAD,
miruga27 0:dda4f4550403 59 SDL_EFWRITE,
miruga27 0:dda4f4550403 60 SDL_EFSEEK,
miruga27 0:dda4f4550403 61 SDL_UNSUPPORTED,
miruga27 0:dda4f4550403 62 SDL_LASTERROR
miruga27 0:dda4f4550403 63 } SDL_errorcode;
miruga27 0:dda4f4550403 64 /* SDL_Error() unconditionally returns -1. */
miruga27 0:dda4f4550403 65 extern DECLSPEC int SDLCALL SDL_Error(SDL_errorcode code);
miruga27 0:dda4f4550403 66 /* @} *//* Internal error functions */
miruga27 0:dda4f4550403 67
miruga27 0:dda4f4550403 68 /* Ends C function definitions when using C++ */
miruga27 0:dda4f4550403 69 #ifdef __cplusplus
miruga27 0:dda4f4550403 70 }
miruga27 0:dda4f4550403 71 #endif
miruga27 0:dda4f4550403 72 #include "close_code.h"
miruga27 0:dda4f4550403 73
miruga27 0:dda4f4550403 74 #endif /* _SDL_error_h */
miruga27 0:dda4f4550403 75
miruga27 0:dda4f4550403 76 /* vi: set ts=4 sw=4 expandtab: */