SFML/System/NativeActivity.hpp

0001 ////////////////////////////////////////////////////////////
0002 //
0003 // SFML - Simple and Fast Multimedia Library
0004 // Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
0005 //
0006 // This software is provided 'as-is', without any express or implied warranty.
0007 // In no event will the authors be held liable for any damages arising from the use of this software.
0008 //
0009 // Permission is granted to anyone to use this software for any purpose,
0010 // including commercial applications, and to alter it and redistribute it freely,
0011 // subject to the following restrictions:
0012 //
0013 // 1. The origin of this software must not be misrepresented;
0014 //    you must not claim that you wrote the original software.
0015 //    If you use this software in a product, an acknowledgment
0016 //    in the product documentation would be appreciated but is not required.
0017 //
0018 // 2. Altered source versions must be plainly marked as such,
0019 //    and must not be misrepresented as being the original software.
0020 //
0021 // 3. This notice may not be removed or altered from any source distribution.
0022 //
0023 ////////////////////////////////////////////////////////////
0024
0025 #ifndef SFML_NATIVEACTIVITY_HPP
0026 #define SFML_NATIVEACTIVITY_HPP
0027
0028
0029 ////////////////////////////////////////////////////////////
0030 // Headers
0031 ////////////////////////////////////////////////////////////
0032 #include <SFML/System/Export.hpp>
0033
0034
0035 #if !defined(SFML_SYSTEM_ANDROID)
0036 #error NativeActivity.hpp: This header is Android only.
0037 #endif
0038
0039
0040 struct ANativeActivity;
0041
0042 namespace sf
0043 {
0044 ////////////////////////////////////////////////////////////
0045 /// \ingroup system
0046 /// \brief Return a pointer to the Android native activity
0047 ///
0048 /// You shouldn't have to use this function, unless you want
0049 /// to implement very specific details, that SFML doesn't
0050 /// support, or to use a workaround for a known issue.
0051 ///
0052 /// \return Pointer to Android native activity structure
0053 ///
0054 /// \sfplatform{Android,SFML/System/NativeActivity.hpp}
0055 ///
0056 ////////////////////////////////////////////////////////////
0057 SFML_SYSTEM_API ANativeActivity* getNativeActivity();
0058
0059 } // namespace sf
0060
0061
0062 #endif // SFML_NATIVEACTIVITY_HPP