mirror of https://github.com/mosra/magnum.git
Travis Watkins
12 years ago
5 changed files with 350 additions and 0 deletions
@ -0,0 +1,129 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014 |
||||
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 "WindowlessCglApplication.h" |
||||
|
||||
#include <Corrade/Utility/Assert.h> |
||||
#include <Corrade/Utility/Debug.h> |
||||
|
||||
#include "Magnum/Context.h" |
||||
|
||||
namespace Magnum { namespace Platform { |
||||
|
||||
/** @todo Delegating constructor when support for GCC 4.6 is dropped */ |
||||
|
||||
WindowlessCglApplication::WindowlessCglApplication(const Arguments&, const Configuration& configuration): c(nullptr) { |
||||
createContext(configuration); |
||||
} |
||||
|
||||
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||
WindowlessCglApplication::WindowlessCglApplication(const Arguments&): c(nullptr) { |
||||
createContext(); |
||||
} |
||||
#endif |
||||
|
||||
WindowlessCglApplication::WindowlessCglApplication(const Arguments&, std::nullptr_t): c(nullptr) {} |
||||
|
||||
void WindowlessCglApplication::createContext() { createContext({}); } |
||||
|
||||
void WindowlessCglApplication::createContext(const Configuration& configuration) { |
||||
if(!tryCreateContext(configuration)) std::exit(1); |
||||
} |
||||
|
||||
bool WindowlessCglApplication::tryCreateContext(const Configuration&) { |
||||
CORRADE_ASSERT(!c, "Platform::WindowlessCglApplication::tryCreateContext(): context already created", false); |
||||
|
||||
/* Check version */ |
||||
int nPix = 0; |
||||
GLint major, minor; |
||||
CGLGetVersion(&major, &minor); |
||||
CGLError cglError; |
||||
|
||||
if(major == 2 && minor < 1) { |
||||
Error() << "Platform::WindowlessCglApplication::tryCreateContext(): OpenGL version 2.1 or greater is required"; |
||||
return false; |
||||
} |
||||
|
||||
|
||||
CGLPixelFormatAttribute pfAttributesGL_3_2[4] = { |
||||
kCGLPFAAccelerated, |
||||
kCGLPFAOpenGLProfile, |
||||
(CGLPixelFormatAttribute) kCGLOGLPVersion_3_2_Core, |
||||
(CGLPixelFormatAttribute) 0 |
||||
}; |
||||
|
||||
cglError = CGLChoosePixelFormat(pfAttributesGL_3_2,&pixelFormat,&nPix); |
||||
|
||||
if(cglError == kCGLBadPixelFormat) { |
||||
Error() << "Platform::WindowlessCglApplication::tryCreateContext(): OpenGL version 3.2 has failed trying GL version 3.0"; |
||||
|
||||
CGLPixelFormatAttribute pfAttributesGL3[4] = { |
||||
kCGLPFAAccelerated, |
||||
kCGLPFAOpenGLProfile, |
||||
(CGLPixelFormatAttribute) kCGLOGLPVersion_GL3_Core, |
||||
(CGLPixelFormatAttribute) 0 |
||||
}; |
||||
|
||||
cglError = CGLChoosePixelFormat(pfAttributesGL3,&pixelFormat,&nPix); |
||||
|
||||
if(cglError == kCGLBadPixelFormat) { |
||||
Error() << "Platform::WindowlessCglApplication::tryCreateContext(): OpenGL version 3.0 has failed trying GL version Legacy"; |
||||
|
||||
CGLPixelFormatAttribute pfAttributesLegacy[4] = { |
||||
kCGLPFAAccelerated, |
||||
kCGLPFAOpenGLProfile, |
||||
(CGLPixelFormatAttribute) kCGLOGLPVersion_Legacy, |
||||
(CGLPixelFormatAttribute) 0 |
||||
}; |
||||
|
||||
cglError = CGLChoosePixelFormat(pfAttributesLegacy,&pixelFormat,&nPix); |
||||
|
||||
if(cglError == kCGLBadPixelFormat) |
||||
{ |
||||
Error() << "Platform::WindowlessCglApplication::tryCreateContext(): Context could not be created"; |
||||
return false; |
||||
} |
||||
} |
||||
} |
||||
|
||||
cglError = CGLCreateContext(pixelFormat, NULL, &context); |
||||
if(cglError == kCGLBadContext) { |
||||
Error() << "Platform::WindowlessCglApplication::tryCreateContext(): cannot create context"; |
||||
return false; |
||||
} |
||||
|
||||
cglError = CGLSetCurrentContext(context); |
||||
c = new Context; |
||||
return true; |
||||
} |
||||
|
||||
WindowlessCglApplication::~WindowlessCglApplication() { |
||||
delete c; |
||||
|
||||
CGLDestroyContext(context); |
||||
CGLDestroyPixelFormat(pixelFormat); |
||||
} |
||||
|
||||
}} |
||||
@ -0,0 +1,200 @@
|
||||
#ifndef Magnum_Platform_WindowlessCglApplication_h |
||||
#define Magnum_Platform_WindowlessCglApplication_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014 |
||||
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::WindowlessCglApplication, macro @ref MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN() |
||||
*/ |
||||
|
||||
#include "Magnum/OpenGL.h" |
||||
#include <OpenGL/OpenGL.h> |
||||
#include <OpenGL/CGLTypes.h> |
||||
#include <OpenGL/CGLCurrent.h> |
||||
|
||||
#include "Magnum/Magnum.h" |
||||
|
||||
namespace Magnum { namespace Platform { |
||||
|
||||
/**
|
||||
@brief Windowless CGL application |
||||
|
||||
Application for offscreen rendering using pure CGL. |
||||
|
||||
This application library is available on desktop OpenGL on OS X. It |
||||
is built if `WITH_WINDOWLESSCGLAPPLICATION` is enabled in CMake. |
||||
|
||||
## Bootstrap application |
||||
|
||||
Fully contained windowless application using @ref WindowlessCglApplication |
||||
along with CMake setup is available in `base-windowless` branch of |
||||
[Magnum Bootstrap](https://github.com/mosra/magnum-bootstrap)
|
||||
repository, download it as [tar.gz](https://github.com/mosra/magnum-bootstrap/archive/base-windowless.tar.gz)
|
||||
or [zip](https://github.com/mosra/magnum-bootstrap/archive/base-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 |
||||
|
||||
## General usage |
||||
|
||||
In CMake you need to request `%WindowlessCglApplication` component, add |
||||
`${MAGNUM_WINDOWLESSCGLAPPLICATION_INCLUDE_DIRS}` to include path and link to |
||||
`${MAGNUM_WINDOWLESSCGLAPPLICATION_LIBRARIES}`. If no other windowless |
||||
application is requested, you can also use generic |
||||
`${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and |
||||
`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. See |
||||
@ref building and @ref cmake for more information. |
||||
|
||||
Place your code into @ref exec(). The subclass can be then used directly in |
||||
`main()` -- see convenience macro @ref MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN(). |
||||
See @ref platform for more information. |
||||
@code |
||||
class MyApplication: public Platform::WindowlessCglApplication { |
||||
// implement required methods...
|
||||
}; |
||||
MAGNUM_WINDOWLESSCGLAPPLICATION_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 WindowlessCglApplication { |
||||
public: |
||||
/** @brief Application arguments */ |
||||
struct Arguments { |
||||
int& argc; /**< @brief Argument count */ |
||||
char** argv; /**< @brief Argument values */ |
||||
}; |
||||
|
||||
class Configuration; |
||||
|
||||
/** @copydoc Sdl2Application::Sdl2Application(const Arguments&, const Configuration&) */ |
||||
#ifdef DOXYGEN_GENERATING_OUTPUT |
||||
explicit WindowlessCglApplication(const Arguments& arguments, const Configuration& configuration = Configuration()); |
||||
#else |
||||
/* To avoid "invalid use of incomplete type" */ |
||||
explicit WindowlessCglApplication(const Arguments& arguments, const Configuration& configuration); |
||||
explicit WindowlessCglApplication(const Arguments& arguments); |
||||
#endif |
||||
|
||||
/** @copydoc Sdl2Application::Sdl2Application(const Arguments&, std::nullptr_t) */ |
||||
explicit WindowlessCglApplication(const Arguments& arguments, std::nullptr_t); |
||||
|
||||
/** @brief Copying is not allowed */ |
||||
WindowlessCglApplication(const WindowlessCglApplication&) = delete; |
||||
|
||||
/** @brief Moving is not allowed */ |
||||
WindowlessCglApplication(WindowlessCglApplication&&) = delete; |
||||
|
||||
/** @brief Copying is not allowed */ |
||||
WindowlessCglApplication& operator=(const WindowlessCglApplication&) = delete; |
||||
|
||||
/** @brief Moving is not allowed */ |
||||
WindowlessCglApplication& operator=(WindowlessCglApplication&&) = delete; |
||||
|
||||
/**
|
||||
* @brief Execute application |
||||
* @return Value for returning from `main()` |
||||
* |
||||
* See @ref MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN() for usage |
||||
* information. |
||||
*/ |
||||
virtual int exec() = 0; |
||||
|
||||
protected: |
||||
/* Nobody will need to have (and delete) WindowlessCglApplication*,
|
||||
thus this is faster than public pure virtual destructor */ |
||||
~WindowlessCglApplication(); |
||||
|
||||
/** @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: |
||||
CGLContextObj context; |
||||
CGLPixelFormatObj pixelFormat; |
||||
|
||||
Context* c; |
||||
}; |
||||
|
||||
/**
|
||||
@brief %Configuration |
||||
|
||||
@see @ref WindowlessCglApplication(), @ref createContext(), |
||||
@ref tryCreateContext() |
||||
*/ |
||||
class WindowlessCglApplication::Configuration { |
||||
public: |
||||
constexpr /*implicit*/ Configuration() {} |
||||
}; |
||||
|
||||
/** @hideinitializer
|
||||
@brief Entry point for windowless CGL application |
||||
@param className Class name |
||||
|
||||
See @ref Magnum::Platform::WindowlessCglApplication "Platform::WindowlessCglApplication" |
||||
for usage information. This macro abstracts out platform-specific entry point |
||||
code and is equivalent to the following, see @ref portability-applications for |
||||
more information. |
||||
@code |
||||
int main(int argc, char** argv) { |
||||
className app({argc, argv}); |
||||
return app.exec(); |
||||
} |
||||
@endcode |
||||
When no other windowless application header is included this macro is also |
||||
aliased to `MAGNUM_WINDOWLESSAPPLICATION_MAIN()`. |
||||
*/ |
||||
#define MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN(className) \ |
||||
int main(int argc, char** argv) { \
|
||||
className app({argc, argv}); \
|
||||
return app.exec(); \
|
||||
} |
||||
|
||||
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||
#ifndef MAGNUM_WINDOWLESSAPPLICATION_MAIN |
||||
typedef WindowlessCglApplication WindowlessApplication; |
||||
#define MAGNUM_WINDOWLESSAPPLICATION_MAIN(className) MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN(className) |
||||
#else |
||||
#undef MAGNUM_WINDOWLESSAPPLICATION_MAIN |
||||
#endif |
||||
#endif |
||||
|
||||
}} |
||||
|
||||
#endif |
||||
Loading…
Reference in new issue