orx: include/display/orxScreenshot.h Source File

Go to the documentation of this file.
00001 /* Orx - Portable Game Engine
00002  *
00003  * Copyright (c) 2008-2011 Orx-Project
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  *
00018  *    2. Altered source versions must be plainly marked as such, and must not be
00019  *    misrepresented as being the original software.
00020  *
00021  *    3. This notice may not be removed or altered from any source
00022  *    distribution.
00023  */
00024 
00043 #ifndef _orxSCREENSHOT_H_
00044 #define _orxSCREENSHOT_H_
00045 
00046 #include "orxInclude.h"
00047 
00048 
00052 #if defined(__orxIPHONE__)
00053 
00054   #define orxSCREENSHOT_KZ_DEFAULT_DIRECTORY_NAME "../Documents"
00055   #define orxSCREENSHOT_KZ_DEFAULT_BASE_NAME      "screenshot-"
00056   #define orxSCREENSHOT_KZ_DEFAULT_EXTENSION      "png"
00057   #define orxSCREENSHOT_KU32_DEFAULT_DIGITS       4
00058 
00059 #elif defined(__orxANDROID__)
00060 
00061   #define orxSCREENSHOT_KZ_DEFAULT_DIRECTORY_NAME "."
00062   #define orxSCREENSHOT_KZ_DEFAULT_BASE_NAME      "screenshot-"
00063   #define orxSCREENSHOT_KZ_DEFAULT_EXTENSION      "png"
00064   #define orxSCREENSHOT_KU32_DEFAULT_DIGITS       4
00065 
00066 #else
00067 
00068   #define orxSCREENSHOT_KZ_DEFAULT_DIRECTORY_NAME "."
00069   #define orxSCREENSHOT_KZ_DEFAULT_BASE_NAME      "screenshot-"
00070   #define orxSCREENSHOT_KZ_DEFAULT_EXTENSION      "tga"
00071   #define orxSCREENSHOT_KU32_DEFAULT_DIGITS       4
00072 
00073 #endif
00074 
00075 
00078 extern orxDLLAPI void orxFASTCALL       orxScreenshot_Setup();
00079 
00083 extern orxDLLAPI orxSTATUS orxFASTCALL  orxScreenshot_Init();
00084 
00087 extern orxDLLAPI void orxFASTCALL       orxScreenshot_Exit();
00088 
00092 extern orxDLLAPI orxSTATUS orxFASTCALL  orxScreenshot_Capture();
00093 
00094 #endif /* _orxSCREENSHOT_H_ */
00095