SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

WindowHandle.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 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_WINDOWHANDLE_HPP
26#define SFML_WINDOWHANDLE_HPP
27
29// Headers
31#include <SFML/Config.hpp>
32
33// Windows' HWND is a typedef on struct HWND__*
34#if defined(SFML_SYSTEM_WINDOWS)
35 struct HWND__;
36#endif
37
38 namespace sf
39{
40#if defined(SFML_SYSTEM_WINDOWS)
41
42 // Window handle is HWND (HWND__*) on Windows
43 typedef HWND__* WindowHandle;
44
45#elif defined(SFML_SYSTEM_LINUX) || defined(SFML_SYSTEM_FREEBSD) || defined(SFML_SYSTEM_OPENBSD)
46
47 // Window handle is Window (unsigned long) on Unix - X11
48 typedef unsigned long WindowHandle;
49
50#elif defined(SFML_SYSTEM_MACOS)
51
52 // Window handle is NSWindow or NSView (void*) on Mac OS X - Cocoa
53 typedef void* WindowHandle;
54
55#elif defined(SFML_SYSTEM_IOS)
56
57 // Window handle is UIWindow (void*) on iOS - UIKit
58 typedef void* WindowHandle;
59
60#elif defined(SFML_SYSTEM_ANDROID)
61
62 // Window handle is ANativeWindow* (void*) on Android
63 typedef void* WindowHandle;
64
65#elif defined(SFML_DOXYGEN)
66
67 // Define typedef symbol so that Doxygen can attach some documentation to it
68 typedef "platform-specific" WindowHandle;
69
70#endif
71
72} // namespace sf
73
74
75#endif // SFML_WINDOWHANDLE_HPP
76
sf::WindowHandle
platform specific WindowHandle
Define a low-level window handle type, specific to each platform.
Definition: WindowHandle.hpp:68