Miguel Ruiz / SDL_lib

SDL standard library

Dependents:   H261_encoder

SDL_quit.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_quit.h
miruga27 0:dda4f4550403 24 *
miruga27 0:dda4f4550403 25 * Include file for SDL quit event handling.
miruga27 0:dda4f4550403 26 */
miruga27 0:dda4f4550403 27
miruga27 0:dda4f4550403 28 #ifndef _SDL_quit_h
miruga27 0:dda4f4550403 29 #define _SDL_quit_h
miruga27 0:dda4f4550403 30
miruga27 0:dda4f4550403 31 #include "SDL_stdinc.h"
miruga27 0:dda4f4550403 32 #include "SDL_error.h"
miruga27 0:dda4f4550403 33
miruga27 0:dda4f4550403 34 /**
miruga27 0:dda4f4550403 35 * \file SDL_quit.h
miruga27 0:dda4f4550403 36 *
miruga27 0:dda4f4550403 37 * An ::SDL_QUIT event is generated when the user tries to close the application
miruga27 0:dda4f4550403 38 * window. If it is ignored or filtered out, the window will remain open.
miruga27 0:dda4f4550403 39 * If it is not ignored or filtered, it is queued normally and the window
miruga27 0:dda4f4550403 40 * is allowed to close. When the window is closed, screen updates will
miruga27 0:dda4f4550403 41 * complete, but have no effect.
miruga27 0:dda4f4550403 42 *
miruga27 0:dda4f4550403 43 * SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
miruga27 0:dda4f4550403 44 * and SIGTERM (system termination request), if handlers do not already
miruga27 0:dda4f4550403 45 * exist, that generate ::SDL_QUIT events as well. There is no way
miruga27 0:dda4f4550403 46 * to determine the cause of an ::SDL_QUIT event, but setting a signal
miruga27 0:dda4f4550403 47 * handler in your application will override the default generation of
miruga27 0:dda4f4550403 48 * quit events for that signal.
miruga27 0:dda4f4550403 49 *
miruga27 0:dda4f4550403 50 * \sa SDL_Quit()
miruga27 0:dda4f4550403 51 */
miruga27 0:dda4f4550403 52
miruga27 0:dda4f4550403 53 /* There are no functions directly affecting the quit event */
miruga27 0:dda4f4550403 54
miruga27 0:dda4f4550403 55 #define SDL_QuitRequested() \
miruga27 0:dda4f4550403 56 (SDL_PumpEvents(), (SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUIT,SDL_QUIT) > 0))
miruga27 0:dda4f4550403 57
miruga27 0:dda4f4550403 58 #endif /* _SDL_quit_h */