CSFML
Window/Window.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24
25 #ifndef SFML_WINDOW_H
26 #define SFML_WINDOW_H
27
29 // Headers
31 #include <SFML/Window/Export.h>
32 #include <SFML/Window/Event.h>
33 #include <SFML/Window/VideoMode.h>
34 #include <SFML/Window/WindowHandle.h>
35 #include <SFML/Window/Types.h>
36 #include <SFML/System/Vector2.h>
37
38
43 typedef enum
44 {
45 sfNone = 0,
46 sfTitlebar = 1 << 0,
47 sfResize = 1 << 1,
48 sfClose = 1 << 2,
49 sfFullscreen = 1 << 3,
50 sfDefaultStyle = sfTitlebar | sfResize | sfClose
51 } sfWindowStyle;
52
53
58 typedef enum
59 {
60 sfContextDefault = 0,
61 sfContextCore = 1 << 0,
62 sfContextDebug = 1 << 2
63 } sfContextAttribute;
64
65
70 typedef struct
71 {
72 unsigned int depthBits;
73 unsigned int stencilBits;
74 unsigned int antialiasingLevel;
75 unsigned int majorVersion;
76 unsigned int minorVersion;
77 sfUint32 attributeFlags;
78 sfBool sRgbCapable;
79 } sfContextSettings;
80
81
103 CSFML_WINDOW_API sfWindow* sfWindow_create(sfVideoMode mode, const char* title, sfUint32 style, const sfContextSettings* settings);
104
126 CSFML_WINDOW_API sfWindow* sfWindow_createUnicode(sfVideoMode mode, const sfUint32* title, sfUint32 style, const sfContextSettings* settings);
127
144 CSFML_WINDOW_API sfWindow* sfWindow_createFromHandle(sfWindowHandle handle, const sfContextSettings* settings);
145
152 CSFML_WINDOW_API void sfWindow_destroy(sfWindow* window);
153
166 CSFML_WINDOW_API void sfWindow_close(sfWindow* window);
167
180 CSFML_WINDOW_API sfBool sfWindow_isOpen(const sfWindow* window);
181
195 CSFML_WINDOW_API sfContextSettings sfWindow_getSettings(const sfWindow* window);
196
212 CSFML_WINDOW_API sfBool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
213
231 CSFML_WINDOW_API sfBool sfWindow_waitEvent(sfWindow* window, sfEvent* event);
232
241 CSFML_WINDOW_API sfVector2i sfWindow_getPosition(const sfWindow* window);
242
254 CSFML_WINDOW_API void sfWindow_setPosition(sfWindow* window, sfVector2i position);
255
267 CSFML_WINDOW_API sfVector2u sfWindow_getSize(const sfWindow* window);
268
276 CSFML_WINDOW_API void sfWindow_setSize(sfWindow* window, sfVector2u size);
277
285 CSFML_WINDOW_API void sfWindow_setTitle(sfWindow* window, const char* title);
286
294 CSFML_WINDOW_API void sfWindow_setUnicodeTitle(sfWindow* window, const sfUint32* title);
295
308 CSFML_WINDOW_API void sfWindow_setIcon(sfWindow* window, unsigned int width, unsigned int height, const sfUint8* pixels);
309
317 CSFML_WINDOW_API void sfWindow_setVisible(sfWindow* window, sfBool visible);
318
331 CSFML_WINDOW_API void sfWindow_setVerticalSyncEnabled(sfWindow* window, sfBool enabled);
332
340 CSFML_WINDOW_API void sfWindow_setMouseCursorVisible(sfWindow* window, sfBool visible);
341
355 CSFML_WINDOW_API void sfWindow_setMouseCursorGrabbed(sfWindow* window, sfBool grabbed);
356
370 CSFML_WINDOW_API void sfWindow_setKeyRepeatEnabled(sfWindow* window, sfBool enabled);
371
383 CSFML_WINDOW_API void sfWindow_setFramerateLimit(sfWindow* window, unsigned int limit);
384
395 CSFML_WINDOW_API void sfWindow_setJoystickThreshold(sfWindow* window, float threshold);
396
414 CSFML_WINDOW_API sfBool sfWindow_setActive(sfWindow* window, sfBool active);
415
428 CSFML_WINDOW_API void sfWindow_requestFocus(sfWindow* window);
429
440 CSFML_WINDOW_API sfBool sfWindow_hasFocus(const sfWindow* window);
441
453 CSFML_WINDOW_API void sfWindow_display(sfWindow* window);
454
469 CSFML_WINDOW_API sfWindowHandle sfWindow_getSystemHandle(const sfWindow* window);
470
471
472 #endif // SFML_WINDOW_H
sfWindow_destroy
CSFML_WINDOW_API void sfWindow_destroy(sfWindow *window)
Destroy a window.
sfResize
Titlebar + resizable border + maximize button.
Definition: Window/Window.h:47
sfWindow_createFromHandle
CSFML_WINDOW_API sfWindow * sfWindow_createFromHandle(sfWindowHandle handle, const sfContextSettings *settings)
Construct a window from an existing control.
sfContextAttribute
sfContextAttribute
Enumeration of the context attribute flags.
Definition: Window/Window.h:58
sfContextSettings::antialiasingLevel
unsigned int antialiasingLevel
Level of antialiasing.
Definition: Window/Window.h:74
sfContextSettings::stencilBits
unsigned int stencilBits
Bits of the stencil buffer.
Definition: Window/Window.h:73
sfWindow
struct sfWindow sfWindow
Definition: Window/Types.h:30
sfNone
No border / title bar (this flag and all others are mutually exclusive)
Definition: Window/Window.h:45
sfTitlebar
Title bar + fixed border.
Definition: Window/Window.h:46
sfWindow_waitEvent
CSFML_WINDOW_API sfBool sfWindow_waitEvent(sfWindow *window, sfEvent *event)
Wait for an event and return it.
sfContextSettings::minorVersion
unsigned int minorVersion
Minor number of the context version to create.
Definition: Window/Window.h:76
sfWindow_setMouseCursorGrabbed
CSFML_WINDOW_API void sfWindow_setMouseCursorGrabbed(sfWindow *window, sfBool grabbed)
Grab or release the mouse cursor.
sfWindow_setActive
CSFML_WINDOW_API sfBool sfWindow_setActive(sfWindow *window, sfBool active)
Activate or deactivate a window as the current target for OpenGL rendering.
sfContextDebug
Debug attribute.
Definition: Window/Window.h:62
sfContextSettings::sRgbCapable
sfBool sRgbCapable
Whether the context framebuffer is sRGB capable.
Definition: Window/Window.h:78
sfContextSettings::majorVersion
unsigned int majorVersion
Major number of the context version to create.
Definition: Window/Window.h:75
sfWindow_setVisible
CSFML_WINDOW_API void sfWindow_setVisible(sfWindow *window, sfBool visible)
Show or hide a window.
sfWindow_create
CSFML_WINDOW_API sfWindow * sfWindow_create(sfVideoMode mode, const char *title, sfUint32 style, const sfContextSettings *settings)
Construct a new window.
Export.h
sfWindow_setPosition
CSFML_WINDOW_API void sfWindow_setPosition(sfWindow *window, sfVector2i position)
Change the position of a window on screen.
sfBool
int sfBool
Definition: Config.h:153
CSFML_WINDOW_API
#define CSFML_WINDOW_API
Definition: Window/Export.h:43
sfWindow_setTitle
CSFML_WINDOW_API void sfWindow_setTitle(sfWindow *window, const char *title)
Change the title of a window.
sfClose
Titlebar + close button.
Definition: Window/Window.h:48
sfVector2i
2-component vector of integers
Definition: Vector2.h:38
sfEvent
sfEvent defines a system event and its parameters
Definition: Event.h:220
sfVector2u
2-component vector of unsigned integers
Definition: Vector2.h:49
sfContextDefault
Non-debug, compatibility context (this and the core attribute are mutually exclusive) ...
Definition: Window/Window.h:60
sfWindow_getSystemHandle
CSFML_WINDOW_API sfWindowHandle sfWindow_getSystemHandle(const sfWindow *window)
Get the OS-specific handle of the window.
sfWindow_hasFocus
CSFML_WINDOW_API sfBool sfWindow_hasFocus(const sfWindow *window)
Check whether the window has the input focus.
sfWindow_display
CSFML_WINDOW_API void sfWindow_display(sfWindow *window)
Display on screen what has been rendered to the window so far.
sfFullscreen
Fullscreen mode (this flag and all others are mutually exclusive)
Definition: Window/Window.h:49
sfWindow_setFramerateLimit
CSFML_WINDOW_API void sfWindow_setFramerateLimit(sfWindow *window, unsigned int limit)
Limit the framerate to a maximum fixed frequency.
sfWindow_setKeyRepeatEnabled
CSFML_WINDOW_API void sfWindow_setKeyRepeatEnabled(sfWindow *window, sfBool enabled)
Enable or disable automatic key-repeat.
Vector2.h
sfWindow_requestFocus
CSFML_WINDOW_API void sfWindow_requestFocus(sfWindow *window)
Request the current window to be made the active foreground window.
sfWindow_pollEvent
CSFML_WINDOW_API sfBool sfWindow_pollEvent(sfWindow *window, sfEvent *event)
Pop the event on top of event queue, if any, and return it.
sfContextCore
Core attribute.
Definition: Window/Window.h:61
Types.h
sfUint32
unsigned int sfUint32
Definition: Config.h:176
sfWindow_getSettings
CSFML_WINDOW_API sfContextSettings sfWindow_getSettings(const sfWindow *window)
Get the settings of the OpenGL context of a window.
sfWindow_setIcon
CSFML_WINDOW_API void sfWindow_setIcon(sfWindow *window, unsigned int width, unsigned int height, const sfUint8 *pixels)
Change a window&#39;s icon.
sfContextSettings::attributeFlags
sfUint32 attributeFlags
The attribute flags to create the context with.
Definition: Window/Window.h:77
WindowHandle.h
sfWindow_getSize
CSFML_WINDOW_API sfVector2u sfWindow_getSize(const sfWindow *window)
Get the size of the rendering region of a window.
sfWindow_setJoystickThreshold
CSFML_WINDOW_API void sfWindow_setJoystickThreshold(sfWindow *window, float threshold)
Change the joystick threshold.
sfWindow_isOpen
CSFML_WINDOW_API sfBool sfWindow_isOpen(const sfWindow *window)
Tell whether or not a window is opened.
sfWindow_createUnicode
CSFML_WINDOW_API sfWindow * sfWindow_createUnicode(sfVideoMode mode, const sfUint32 *title, sfUint32 style, const sfContextSettings *settings)
Construct a new window (with a UTF-32 title)
sfVideoMode
sfVideoMode defines a video mode (width, height, bpp, frequency) and provides functions for getting m...
Definition: VideoMode.h:41
VideoMode.h
sfWindow_close
CSFML_WINDOW_API void sfWindow_close(sfWindow *window)
Close a window and destroy all the attached resources.
sfWindow_setUnicodeTitle
CSFML_WINDOW_API void sfWindow_setUnicodeTitle(sfWindow *window, const sfUint32 *title)
Change the title of a window (with a UTF-32 string)
sfUint8
unsigned char sfUint8
Definition: Config.h:168
sfWindow_setMouseCursorVisible
CSFML_WINDOW_API void sfWindow_setMouseCursorVisible(sfWindow *window, sfBool visible)
Show or hide the mouse cursor.
sfWindow_setVerticalSyncEnabled
CSFML_WINDOW_API void sfWindow_setVerticalSyncEnabled(sfWindow *window, sfBool enabled)
Enable or disable vertical synchronization.
Event.h
sfWindow_getPosition
CSFML_WINDOW_API sfVector2i sfWindow_getPosition(const sfWindow *window)
Get the position of a window.
sfDefaultStyle
Default window style.
Definition: Window/Window.h:50
sfWindow_setSize
CSFML_WINDOW_API void sfWindow_setSize(sfWindow *window, sfVector2u size)
Change the size of the rendering region of a window.
sfWindowStyle
sfWindowStyle
Enumeration of window creation styles.
Definition: Window/Window.h:43
sfContextSettings
Structure defining the window&#39;s creation settings.
Definition: Window/Window.h:70
sfContextSettings::depthBits
unsigned int depthBits
Bits of the depth buffer.
Definition: Window/Window.h:72