Window.h

Go to the documentation of this file.
00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2008-2008 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages 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 freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_WINDOW_H
00026 #define SFML_WINDOW_H
00027 
00029 // Headers
00031 #include <SFML/Config.h>
00032 #include <SFML/Window/Event.h>
00033 #include <SFML/Window/Input.h>
00034 #include <SFML/Window/VideoMode.h>
00035 #include <SFML/Window/WindowHandle.h>
00036 
00037 
00042 typedef struct sfWindow sfWindow;
00043 
00044 
00049 enum
00050 {
00051     sfNone       = 0,      
00052     sfTitlebar   = 1 << 0, 
00053     sfResize     = 1 << 1, 
00054     sfClose      = 1 << 2, 
00055     sfFullscreen = 1 << 3  
00056 };
00057 
00058 
00062 typedef struct
00063 {
00064     unsigned int DepthBits;         
00065     unsigned int StencilBits;       
00066     unsigned int AntialiasingLevel; 
00067 } sfWindowSettings;
00068 
00069 
00079 CSFML_API sfWindow* sfWindow_Create(sfVideoMode Mode, const char* Title, unsigned long Style, sfWindowSettings Params);
00080 
00088 CSFML_API sfWindow* sfWindow_CreateFromHandle(sfWindowHandle Handle, sfWindowSettings Params);
00089 
00096 CSFML_API void sfWindow_Destroy(sfWindow* Window);
00097 
00104 CSFML_API void sfWindow_Close(sfWindow* Window);
00105 
00112 CSFML_API sfBool sfWindow_IsOpened(sfWindow* Window);
00113 
00122 CSFML_API unsigned int sfWindow_GetWidth(sfWindow* Window);
00123 
00132 CSFML_API unsigned int sfWindow_GetHeight(sfWindow* Window);
00133 
00142 CSFML_API sfWindowSettings sfWindow_GetSettings(sfWindow* Window);
00143 
00153 CSFML_API sfBool sfWindow_GetEvent(sfWindow* Window, sfEvent* Event);
00154 
00162 CSFML_API void sfWindow_UseVerticalSync(sfWindow* Window, sfBool Enabled);
00163 
00171 CSFML_API void sfWindow_ShowMouseCursor(sfWindow* Window, sfBool Show);
00172 
00181 CSFML_API void sfWindow_SetCursorPosition(sfWindow* Window, unsigned int Left, unsigned int Top);
00182 
00192 CSFML_API void sfWindow_SetPosition(sfWindow* Window, int Left, int Top);
00193 
00202 CSFML_API void sfWindow_SetSize(sfWindow* Window, unsigned int Width, unsigned int Height);
00203 
00211 CSFML_API void sfWindow_Show(sfWindow* Window, sfBool State);
00212 
00221 CSFML_API void sfWindow_EnableKeyRepeat(sfWindow* Window, sfBool Enabled);
00222 
00232 CSFML_API void sfWindow_SetIcon(sfWindow* Window, unsigned int Width, unsigned int Height, sfUint8* Pixels);
00233 
00243 CSFML_API sfBool sfWindow_SetActive(sfWindow* Window, sfBool Active);
00244 
00251 CSFML_API void sfWindow_Display(sfWindow* Window);
00252 
00261 CSFML_API sfInput* sfWindow_GetInput(sfWindow* Window);
00262 
00271 CSFML_API void sfWindow_SetFramerateLimit(sfWindow* Window, unsigned int Limit);
00272 
00281 CSFML_API float sfWindow_GetFrameTime(sfWindow* Window);
00282 
00291 CSFML_API void sfWindow_SetJoystickThreshold(sfWindow* Window, float Threshold);
00292 
00293 
00294 #endif // SFML_WINDOW_H