SFML - Simple and Fast Multimedia Library

SFML 3.1.0
Loading...
Searching...
No Matches
WindowHandle.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 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#pragma once
26
28// Headers
30#include <SFML/Config.hpp>
31
32// Windows' HWND is a type alias for struct HWND__*
33#if defined(SFML_SYSTEM_WINDOWS)
34struct HWND__; // NOLINT(bugprone-reserved-identifier)
35#endif
36
37namespace sf
38{
39#if defined(SFML_SYSTEM_WINDOWS)
40
41// Window handle is HWND (HWND__*) on Windows
42using WindowHandle = HWND__*;
43
44#elif defined(SFML_SYSTEM_LINUX) || defined(SFML_SYSTEM_FREEBSD) || defined(SFML_SYSTEM_OPENBSD) || \
45 defined(SFML_SYSTEM_NETBSD)
46
47// Window handle is Window (unsigned long) on Unix - X11
48using WindowHandle = unsigned long;
49
50#elif defined(SFML_SYSTEM_MACOS)
51
52// Window handle is NSWindow or NSView (void*) on macOS - Cocoa
53using WindowHandle = void*;
54
55#elif defined(SFML_SYSTEM_IOS)
56
57// Window handle is UIWindow (void*) on iOS - UIKit
58using WindowHandle = void*;
59
60#elif defined(SFML_SYSTEM_ANDROID)
61
62// Window handle is ANativeWindow* (void*) on Android
63using WindowHandle = void*;
64
65#elif defined(SFML_DOXYGEN)
66
67// Define type alias symbol so that Doxygen can attach some documentation to it
68 using WindowHandle = "platform-specific";
69
70#endif
71
72} // namespace sf
73
74
Config.hpp
sf::WindowHandle
"platform-specific" WindowHandle
Low-level window handle type, specific to each platform.
Definition WindowHandle.hpp:68
sf
Definition AudioResource.hpp:36