SFML logo
  • Main Page
  • Data Structures
  • Files
  • File List

Window.h

00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2009 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/VideoMode.h>
00034 #include <SFML/Window/WindowHandle.h>
00035 #include <SFML/Window/Types.h>
00036 
00037 
00042 enum
00043 {
00044     sfNone       = 0,      
00045     sfTitlebar   = 1 << 0, 
00046     sfResize     = 1 << 1, 
00047     sfClose      = 1 << 2, 
00048     sfFullscreen = 1 << 3  
00049 };
00050 
00051 
00055 typedef struct
00056 {
00057     unsigned int DepthBits;         
00058     unsigned int StencilBits;       
00059     unsigned int AntialiasingLevel; 
00060 } sfWindowSettings;
00061 
00062 
00072 CSFML_API sfWindow* sfWindow_Create(sfVideoMode Mode, const char* Title, unsigned long Style, sfWindowSettings Params);
00073 
00081 CSFML_API sfWindow* sfWindow_CreateFromHandle(sfWindowHandle Handle, sfWindowSettings Params);
00082 
00089 CSFML_API void sfWindow_Destroy(sfWindow* Window);
00090 
00097 CSFML_API void sfWindow_Close(sfWindow* Window);
00098 
00105 CSFML_API sfBool sfWindow_IsOpened(sfWindow* Window);
00106 
00115 CSFML_API unsigned int sfWindow_GetWidth(sfWindow* Window);
00116 
00125 CSFML_API unsigned int sfWindow_GetHeight(sfWindow* Window);
00126 
00135 CSFML_API sfWindowSettings sfWindow_GetSettings(sfWindow* Window);
00136 
00146 CSFML_API sfBool sfWindow_GetEvent(sfWindow* Window, sfEvent* Event);
00147 
00155 CSFML_API void sfWindow_UseVerticalSync(sfWindow* Window, sfBool Enabled);
00156 
00164 CSFML_API void sfWindow_ShowMouseCursor(sfWindow* Window, sfBool Show);
00165 
00174 CSFML_API void sfWindow_SetCursorPosition(sfWindow* Window, unsigned int Left, unsigned int Top);
00175 
00185 CSFML_API void sfWindow_SetPosition(sfWindow* Window, int Left, int Top);
00186 
00195 CSFML_API void sfWindow_SetSize(sfWindow* Window, unsigned int Width, unsigned int Height);
00196 
00204 CSFML_API void sfWindow_Show(sfWindow* Window, sfBool State);
00205 
00214 CSFML_API void sfWindow_EnableKeyRepeat(sfWindow* Window, sfBool Enabled);
00215 
00225 CSFML_API void sfWindow_SetIcon(sfWindow* Window, unsigned int Width, unsigned int Height, sfUint8* Pixels);
00226 
00236 CSFML_API sfBool sfWindow_SetActive(sfWindow* Window, sfBool Active);
00237 
00244 CSFML_API void sfWindow_Display(sfWindow* Window);
00245 
00254 CSFML_API sfInput* sfWindow_GetInput(sfWindow* Window);
00255 
00264 CSFML_API void sfWindow_SetFramerateLimit(sfWindow* Window, unsigned int Limit);
00265 
00274 CSFML_API float sfWindow_GetFrameTime(sfWindow* Window);
00275 
00284 CSFML_API void sfWindow_SetJoystickThreshold(sfWindow* Window, float Threshold);
00285 
00286 
00287 #endif // SFML_WINDOW_H

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::