mirror of https://github.com/mosra/magnum.git
Vladimír Vondruš
10 years ago
7 changed files with 371 additions and 1 deletions
@ -0,0 +1,230 @@ |
|||||||
|
#ifndef Magnum_Platform_WindowlessIosApplication_h |
||||||
|
#define Magnum_Platform_WindowlessIosApplication_h |
||||||
|
/*
|
||||||
|
This file is part of Magnum. |
||||||
|
|
||||||
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015 |
||||||
|
Vladimír Vondruš <mosra@centrum.cz> |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a |
||||||
|
copy of this software and associated documentation files (the "Software"), |
||||||
|
to deal in the Software without restriction, including without limitation |
||||||
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||||
|
and/or sell copies of the Software, and to permit persons to whom the |
||||||
|
Software is furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included |
||||||
|
in all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||||
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||||
|
DEALINGS IN THE SOFTWARE. |
||||||
|
*/ |
||||||
|
|
||||||
|
/** @file
|
||||||
|
* @brief Class @ref Magnum::Platform::WindowlessIosApplication, macro @ref MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN() |
||||||
|
*/ |
||||||
|
|
||||||
|
#include <memory> |
||||||
|
#include <Corrade/Containers/EnumSet.h> |
||||||
|
|
||||||
|
#include "Magnum/Magnum.h" |
||||||
|
#include "Magnum/OpenGL.h" |
||||||
|
#include "Magnum/Platform/Platform.h" |
||||||
|
|
||||||
|
#ifdef __OBJC__ |
||||||
|
@class EAGLContext; |
||||||
|
#else |
||||||
|
struct EAGLContext; |
||||||
|
#endif |
||||||
|
|
||||||
|
namespace Magnum { namespace Platform { |
||||||
|
|
||||||
|
/**
|
||||||
|
@brief Windowless iOS application |
||||||
|
|
||||||
|
Application for offscreen rendering using EAGL on iOS. Does not have any |
||||||
|
default framebuffer. It is built if `WITH_WINDOWLESSIOSAPPLICATION` is enabled |
||||||
|
in CMake. |
||||||
|
|
||||||
|
## Bootstrap application |
||||||
|
|
||||||
|
Fully contained windowless application using @ref WindowlessIosApplication |
||||||
|
along with CMake setup is available in `windowless` branch of |
||||||
|
[Magnum Bootstrap](https://github.com/mosra/magnum-bootstrap) repository,
|
||||||
|
download it as [tar.gz](https://github.com/mosra/magnum-bootstrap/archive/windowless.tar.gz)
|
||||||
|
or [zip](https://github.com/mosra/magnum-bootstrap/archive/windowless.zip)
|
||||||
|
file. After extracting the downloaded archive you can build and run the |
||||||
|
application with these four commands: |
||||||
|
|
||||||
|
mkdir build && cd build |
||||||
|
cmake .. |
||||||
|
cmake --build . |
||||||
|
./src/MyApplication # or ./src/Debug/MyApplication |
||||||
|
|
||||||
|
See @ref cmake for more information. |
||||||
|
|
||||||
|
## General usage |
||||||
|
|
||||||
|
In CMake you need to request `WindowlessIosApplication` component and link to |
||||||
|
`Magnum::WindowlessIosApplication` target. If no other windowless application |
||||||
|
is requested, you can also use generic `Magnum::WindowlessApplication` alias to |
||||||
|
simplify porting. Again, see @ref building and @ref cmake for more information. |
||||||
|
|
||||||
|
Place your code into @ref exec(). The subclass can be then used in main |
||||||
|
function using @ref MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN() macro. See |
||||||
|
@ref platform for more information. |
||||||
|
@code |
||||||
|
class MyApplication: public Platform::WindowlessIosApplication { |
||||||
|
// implement required methods...
|
||||||
|
}; |
||||||
|
MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN(MyApplication) |
||||||
|
@endcode |
||||||
|
|
||||||
|
If no other application header is included, this class is also aliased to |
||||||
|
`Platform::WindowlessApplication` and the macro is aliased to |
||||||
|
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()` to simplify porting. |
||||||
|
*/ |
||||||
|
class WindowlessIosApplication { |
||||||
|
public: |
||||||
|
/** @brief Application arguments */ |
||||||
|
struct Arguments { |
||||||
|
/** @brief Constructor */ |
||||||
|
/*implicit*/ constexpr Arguments(int& argc, char** argv) noexcept: argc{argc}, argv{argv} {} |
||||||
|
|
||||||
|
int& argc; /**< @brief Argument count */ |
||||||
|
char** argv; /**< @brief Argument values */ |
||||||
|
}; |
||||||
|
|
||||||
|
class Configuration; |
||||||
|
|
||||||
|
/** @copydoc Sdl2Application::Sdl2Application(const Arguments&, const Configuration&) */ |
||||||
|
#ifdef DOXYGEN_GENERATING_OUTPUT |
||||||
|
explicit WindowlessIosApplication(const Arguments& arguments, const Configuration& configuration = Configuration()); |
||||||
|
#else |
||||||
|
/* To avoid "invalid use of incomplete type" */ |
||||||
|
explicit WindowlessIosApplication(const Arguments& arguments, const Configuration& configuration); |
||||||
|
explicit WindowlessIosApplication(const Arguments& arguments); |
||||||
|
#endif |
||||||
|
|
||||||
|
/** @copydoc Sdl2Application::Sdl2Application(const Arguments&, std::nullptr_t) */ |
||||||
|
explicit WindowlessIosApplication(const Arguments& arguments, std::nullptr_t); |
||||||
|
|
||||||
|
/** @brief Copying is not allowed */ |
||||||
|
WindowlessIosApplication(const WindowlessIosApplication&) = delete; |
||||||
|
|
||||||
|
/** @brief Moving is not allowed */ |
||||||
|
WindowlessIosApplication(WindowlessIosApplication&&) = delete; |
||||||
|
|
||||||
|
/** @brief Copying is not allowed */ |
||||||
|
WindowlessIosApplication& operator=(const WindowlessIosApplication&) = delete; |
||||||
|
|
||||||
|
/** @brief Moving is not allowed */ |
||||||
|
WindowlessIosApplication& operator=(WindowlessIosApplication&&) = delete; |
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Execute application |
||||||
|
* @return Value for returning from `main()` |
||||||
|
* |
||||||
|
* See @ref MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN() for usage |
||||||
|
* information. |
||||||
|
*/ |
||||||
|
virtual int exec() = 0; |
||||||
|
|
||||||
|
protected: |
||||||
|
/* Nobody will need to have (and delete) WindowlessIosApplication*,
|
||||||
|
thus this is faster than public pure virtual destructor */ |
||||||
|
~WindowlessIosApplication(); |
||||||
|
|
||||||
|
/** @copydoc Sdl2Application::createContext() */ |
||||||
|
#ifdef DOXYGEN_GENERATING_OUTPUT |
||||||
|
void createContext(const Configuration& configuration = Configuration()); |
||||||
|
#else |
||||||
|
/* To avoid "invalid use of incomplete type" */ |
||||||
|
void createContext(const Configuration& configuration); |
||||||
|
void createContext(); |
||||||
|
#endif |
||||||
|
|
||||||
|
/** @copydoc Sdl2Application::tryCreateContext() */ |
||||||
|
bool tryCreateContext(const Configuration& configuration); |
||||||
|
|
||||||
|
private: |
||||||
|
EAGLContext* _glContext; |
||||||
|
|
||||||
|
std::unique_ptr<Platform::Context> _context; |
||||||
|
}; |
||||||
|
|
||||||
|
/**
|
||||||
|
@brief Configuration |
||||||
|
|
||||||
|
@see @ref WindowlessIosApplication(), @ref createContext(), |
||||||
|
@ref tryCreateContext() |
||||||
|
*/ |
||||||
|
class WindowlessIosApplication::Configuration { |
||||||
|
public: |
||||||
|
/**
|
||||||
|
* @brief Context flag |
||||||
|
* |
||||||
|
* @see @ref Flags, @ref setFlags(), @ref Context::Flag |
||||||
|
*/ |
||||||
|
enum class Flag: int {}; |
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Context flags |
||||||
|
* |
||||||
|
* @see @ref setFlags(), @ref Context::Flags |
||||||
|
*/ |
||||||
|
typedef Containers::EnumSet<Flag> Flags; |
||||||
|
|
||||||
|
constexpr /*implicit*/ Configuration() {} |
||||||
|
|
||||||
|
/** @brief Context flags */ |
||||||
|
Flags flags() const { return _flags; } |
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Set context flags |
||||||
|
* @return Reference to self (for method chaining) |
||||||
|
* |
||||||
|
* Default is no flag. See also @ref Context::flags(). |
||||||
|
*/ |
||||||
|
Configuration& setFlags(Flags flags) { |
||||||
|
_flags = flags; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
Flags _flags; |
||||||
|
}; |
||||||
|
|
||||||
|
/** @hideinitializer
|
||||||
|
@brief Entry point for windowless EGL application |
||||||
|
@param className Class name |
||||||
|
|
||||||
|
See @ref Magnum::Platform::WindowlessIosApplication "Platform::WindowlessIosApplication" |
||||||
|
for usage information. This macro abstracts out platform-specific entry point |
||||||
|
code, see @ref portability-applications for more information. When no other |
||||||
|
windowless application header is included this macro is also aliased to |
||||||
|
`MAGNUM_WINDOWLESSAPPLICATION_MAIN()`. |
||||||
|
*/ |
||||||
|
#define MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN(className) \ |
||||||
|
int main(int argc, char** argv) { \
|
||||||
|
className app({argc, argv}); \
|
||||||
|
return app.exec(); \
|
||||||
|
} |
||||||
|
|
||||||
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||||
|
#ifndef MAGNUM_WINDOWLESSAPPLICATION_MAIN |
||||||
|
typedef WindowlessIosApplication WindowlessApplication; |
||||||
|
#define MAGNUM_WINDOWLESSAPPLICATION_MAIN(className) MAGNUM_WINDOWLESSIOSAPPLICATION_MAIN(className) |
||||||
|
#else |
||||||
|
#undef MAGNUM_WINDOWLESSAPPLICATION_MAIN |
||||||
|
#endif |
||||||
|
#endif |
||||||
|
|
||||||
|
}} |
||||||
|
|
||||||
|
#endif |
||||||
@ -0,0 +1,89 @@ |
|||||||
|
/* |
||||||
|
This file is part of Magnum. |
||||||
|
|
||||||
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015 |
||||||
|
Vladimír Vondruš <mosra@centrum.cz> |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a |
||||||
|
copy of this software and associated documentation files (the "Software"), |
||||||
|
to deal in the Software without restriction, including without limitation |
||||||
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||||
|
and/or sell copies of the Software, and to permit persons to whom the |
||||||
|
Software is furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included |
||||||
|
in all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||||
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||||
|
DEALINGS IN THE SOFTWARE. |
||||||
|
*/ |
||||||
|
|
||||||
|
#include "WindowlessIosApplication.h" |
||||||
|
|
||||||
|
#include <Corrade/Utility/Assert.h> |
||||||
|
#include <Corrade/Utility/Debug.h> |
||||||
|
|
||||||
|
#include "Magnum/Version.h" |
||||||
|
#include "Magnum/Platform/Context.h" |
||||||
|
|
||||||
|
#import "EAGL.h" |
||||||
|
|
||||||
|
#if __has_feature(objc_arc) |
||||||
|
#error no, we want to use manual memory management |
||||||
|
#endif |
||||||
|
|
||||||
|
namespace Magnum { namespace Platform { |
||||||
|
|
||||||
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||||
|
WindowlessIosApplication::WindowlessIosApplication(const Arguments& arguments): WindowlessIosApplication{arguments, Configuration{}} {} |
||||||
|
#endif |
||||||
|
|
||||||
|
WindowlessIosApplication::WindowlessIosApplication(const Arguments& arguments, const Configuration& configuration): WindowlessIosApplication{arguments, nullptr} { |
||||||
|
createContext(configuration); |
||||||
|
} |
||||||
|
|
||||||
|
WindowlessIosApplication::WindowlessIosApplication(const Arguments& arguments, std::nullptr_t): _context{new Context{NoCreate, arguments.argc, arguments.argv}} {} |
||||||
|
|
||||||
|
void WindowlessIosApplication::createContext() { createContext({}); } |
||||||
|
|
||||||
|
void WindowlessIosApplication::createContext(const Configuration& configuration) { |
||||||
|
if(!tryCreateContext(configuration)) std::exit(1); |
||||||
|
} |
||||||
|
|
||||||
|
bool WindowlessIosApplication::tryCreateContext(const Configuration&) { |
||||||
|
CORRADE_ASSERT(_context->version() == Version::None, "Platform::WindowlessIosApplication::tryCreateContext(): context already created", false); |
||||||
|
|
||||||
|
/* Initialize */ |
||||||
|
if(!(_glContext = [[EAGLContext alloc] |
||||||
|
#ifdef MAGNUM_TARGET_GLES2 |
||||||
|
initWithAPI:kEAGLRenderingAPIOpenGLES2 |
||||||
|
#else |
||||||
|
initWithAPI:kEAGLRenderingAPIOpenGLES3 |
||||||
|
#endif |
||||||
|
])) |
||||||
|
{ |
||||||
|
Error() << "Platform::WindowlessIosApplication::tryCreateContext(): cannot create EAGL context"; |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if(![EAGLContext setCurrentContext:_glContext]) { |
||||||
|
Error() << "Platform::WindowlessIosApplication::tryCreateContext(): cannot make context current"; |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
/* Return true if the initialization succeeds */ |
||||||
|
return _context->tryCreate(); |
||||||
|
} |
||||||
|
|
||||||
|
WindowlessIosApplication::~WindowlessIosApplication() { |
||||||
|
_context.reset(); |
||||||
|
|
||||||
|
[_glContext dealloc]; |
||||||
|
} |
||||||
|
|
||||||
|
}} |
||||||
Loading…
Reference in new issue