ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: moved iOS/WinRT-specific docs from Sdl2App to dedicated pages.

pull/272/head
Vladimír Vondruš 8 years ago
parent
1260d51dc1
commit
6a71bf2302
6 changed files with 114 additions and 85 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      doc/building.dox
  2. 1
      doc/platforms-gl.dox
  3. 57
      doc/platforms-ios.dox
  4. 3
      doc/platforms-macos.dox
  5. 51
      doc/platforms-windows.dox
  6. 86
      src/Magnum/Platform/Sdl2Application.h

1
doc/building.dox
Unescape View File

@ -29,6 +29,7 @@ namespace Magnum {
@brief Guide how to download and build Magnum on different platforms. @brief Guide how to download and build Magnum on different platforms.
@m_keywords{Building} @m_keywords{Building}
@m_keyword{ANGLE OpenGL compatibility layer,,}
@tableofcontents @tableofcontents
@m_footernavigation @m_footernavigation

1
doc/platforms-gl.dox
Unescape View File

@ -29,6 +29,7 @@ namespace Magnum {
@brief Information common for all platforms that support OpenGL and OpenGL ES @brief Information common for all platforms that support OpenGL and OpenGL ES
@tableofcontents @tableofcontents
@m_keyword{ANGLE OpenGL compatibility layer,,}
@m_footernavigation @m_footernavigation
@todoc desktop gles @todoc desktop gles

57
doc/platforms-ios.dox
Unescape View File

@ -32,11 +32,64 @@ namespace Magnum {
@m_footernavigation @m_footernavigation
With Apple decision to focus on Metal, iOS OpenGL ES support is stuck on With Apple decision to focus on Metal, iOS OpenGL ES support is stuck on
version 3.0 (i.e., a version before compute shaders are available). version 3.0 (i.e., a version before compute shaders are available). Moreover,
OpenGL ES is deprecated since iOS 12.
See also @ref Platform::Sdl2Application for more information. Some of the See also @ref Platform::Sdl2Application for more information, majority of the
@ref platforms-macos "macOS platform-specific info" applies here as well. @ref platforms-macos "macOS platform-specific info" applies here as well.
@section platforms-ios-bundle Bundle creation
Unlike on macOS, where applications can also run directly from a compiled
executable, on iOS you are required to create a bundle. The bundle setup is
similar to macOS, see the @ref platforms-macos-bundle "macOS platform guide"
for details. Compared to macOS, the `*.plist` file controls many more options
(such as HiDPI/Retina support, supported display orientation, icons, splash
screen...). CMake uses its own template that can be configured using various
`MACOSX_BUNDLE_*` variables, but the builtin file is tailored for macOS and you
are much better off rolling your own template and passing **abosolute** path to
it to CMake using the `MACOSX_BUNDLE_INFO_PLIST` property:
@code{.cmake}
if(CORRADE_TARGET_IOS)
set_target_properties(my-application PROPERTIES
MACOSX_BUNDLE ON
MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_SOURCE_DIR}/MacOSXBundleInfo.plist.in)
endif()
@endcode
Below are contents of the `*.plist` file as is used in the
@ref Platform-Sdl2Application-bootstrap-ios "SDL2 bootstrap application",
requesting OpenGL ES 2.0 and advertising Retina support:
@code{.xml}
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en-US</string>
<key>CFBundleExecutable</key>
<string>${MACOSX_BUNDLE_EXECUTABLE_NAME}</string>
<key>CFBundleIdentifier</key>
<string>cz.mosra.magnum.MyApplication</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>My Application</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>UIRequiredDeviceCapabilities</key>
<array>
<string>opengles-2</string>
</array>
<key>NSHighResolutionCapable</key>
<true/>
</dict>
</plist>
@endcode
@section platforms-ios-xcode Xcode @section platforms-ios-xcode Xcode
@subsection platforms-ios-xcode-cmake CMake can't find a compiler @subsection platforms-ios-xcode-cmake CMake can't find a compiler

3
doc/platforms-macos.dox
Unescape View File

@ -34,7 +34,8 @@ namespace Magnum {
@todoc code coverage @todoc code coverage
With Apple decision to focus on Metal, macOS OpenGL support is stuck on version With Apple decision to focus on Metal, macOS OpenGL support is stuck on version
4.2 (i.e., a version before compute shaders are available). 4.2 (i.e., a version before compute shaders are available). Moreover, OpenGL is
deprecated since macOS 10.14.
@section platforms-macos-bundle Bundle creation @section platforms-macos-bundle Bundle creation

51
doc/platforms-windows.dox
Unescape View File

@ -29,9 +29,58 @@ namespace Magnum {
@brief Tips and tricks for Windows platforms @brief Tips and tricks for Windows platforms
@tableofcontents @tableofcontents
@m_keyword{ANGLE OpenGL compatibility layer,,}
@m_footernavigation @m_footernavigation
See @ref Platform::Sdl2Application for more information about WinRT. @section platforms-windows-rt Windows RT
Windows RT is a restricted subset of Windows API, used for UWP / "Metro" /
Windows Store apps. The major difference is lack of access to APIs that are
common in Win32 world, such as memory-mapped files, DLLs or environment
variables.
In particular, Windows RT doesn't provide a direct access to OpenGL, the only
possibility to use it is through ANGLE. See @ref building-windows-angle and
@ref platforms-gl-es-angle for more information.
For Windows RT you need to provide logo images and splash screen, all
referenced from the `*.appxmanifest` file. The file is slightly different for
different targets, template for Windows Store and MSVC 2013 is below, others
are in the @ref Platform-Sdl2Application-bootstrap-winrt "SDL2 bootstrap application".
@code{.xml}
<?xml version="1.0" encoding="utf-8"?>
<Package xmlns="http://schemas.microsoft.com/appx/2010/manifest" xmlns:m2="http://schemas.microsoft.com/appx/2013/manifest">
<Identity Name="MyApplication" Publisher="CN=A Publisher" Version="1.1.0.0" />
<Properties>
<DisplayName>My Application</DisplayName>
<PublisherDisplayName>A Publisher</PublisherDisplayName>
<Logo>assets/logo-store.png</Logo>
</Properties>
<Resources>
<Resource Language="x-generate" />
</Resources>
<Applications>
<Application Id="App" Executable="$targetnametoken$.exe" EntryPoint="MyApplication.App">
<m2:VisualElements
DisplayName="Magnum Windows Store Application"
Description="My Application"
BackgroundColor="#202020"
ForegroundText="light"
Square150x150Logo="assets/logo.png"
Square30x30Logo="assets/logo-small.png">
<m2:SplashScreen Image="assets/splash.png" />
</m2:VisualElements>
</Application>
</Applications>
</Package>
@endcode
The assets are referenced also from the main `CMakeLists.txt` file. You have to
mark all non-source files (except for the `*.pfx` key) with `VS_DEPLOYMENT_CONTENT`
property and optionally set their location with `VS_DEPLOYMENT_LOCATION`. If
you are using `*.resw` files, these need to have the `VS_TOOL_OVERRIDE`
property set to `PRIResource`.
@todoc DLL paths @todoc DLL paths
@todoc vcpkg @todoc vcpkg

86
src/Magnum/Platform/Sdl2Application.h
Unescape View File

@ -224,94 +224,18 @@ If no other application header is included, this class is also aliased to
@cpp Platform::Application @ce and the macro is aliased to @cpp MAGNUM_APPLICATION_MAIN() @ce @cpp Platform::Application @ce and the macro is aliased to @cpp MAGNUM_APPLICATION_MAIN() @ce
to simplify porting. to simplify porting.
@section Platform-Sdl2Application-usage-ios Usage with iOS @subsection Platform-Sdl2Application-usage-ios iOS specifics
A lot of options for iOS build (such as HiDPI/Retina support, supported display
orientation, icons, splash screen...) is specified through the `*.plist` file.
CMake uses its own template that can be configured using various `MACOSX_BUNDLE_*`
variables, but many options are missing from there and you are much better off
rolling your own template and passing **abosolute** path to it to CMake using
the `MACOSX_BUNDLE_INFO_PLIST` property. Below are contents of the `*.plist`
file used in the bootstrap application, requesting OpenGL ES 2.0 and
advertising Retina support:
@code{.xml}
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en-US</string>
<key>CFBundleExecutable</key>
<string>${MACOSX_BUNDLE_EXECUTABLE_NAME}</string>
<key>CFBundleIdentifier</key>
<string>cz.mosra.magnum.MyApplication</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>My Application</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>UIRequiredDeviceCapabilities</key>
<array>
<string>opengles-2</string>
</array>
<key>NSHighResolutionCapable</key>
<true/>
</dict>
</plist>
@endcode
Some other options can be configured from runtime when creating the SDL2 As noted in the @ref platforms-ios-bundle "iOS platform guide", a lot of
application window, see documentation of particular value for details: options needs to be set via a `*.plist` file. Some options can be configured
from runtime when creating the SDL2 application window, see documentation of
a particular value for details:
- @ref Configuration::WindowFlag::AllowHighDpi allows creating HiDPI/Retina - @ref Configuration::WindowFlag::AllowHighDpi allows creating HiDPI/Retina
drawable drawable
- @ref Configuration::WindowFlag::Borderless hides the menu bar - @ref Configuration::WindowFlag::Borderless hides the menu bar
- @ref Configuration::WindowFlag::Resizable makes the application respond to - @ref Configuration::WindowFlag::Resizable makes the application respond to
device orientation changes device orientation changes
@section Platform-Sdl2Application-usage-winrt Usage with Windows RT
For Windows RT you need to provide logo images and splash screen, all
referenced from the `*.appxmanifest` file. The file is slightly different for
different targets, template for Windows Store and MSVC 2013 is below, others
are in the bootstrap application.
@code{.xml}
<?xml version="1.0" encoding="utf-8"?>
<Package xmlns="http://schemas.microsoft.com/appx/2010/manifest" xmlns:m2="http://schemas.microsoft.com/appx/2013/manifest">
<Identity Name="MyApplication" Publisher="CN=A Publisher" Version="1.1.0.0" />
<Properties>
<DisplayName>My Application</DisplayName>
<PublisherDisplayName>A Publisher</PublisherDisplayName>
<Logo>assets/logo-store.png</Logo>
</Properties>
<Resources>
<Resource Language="x-generate" />
</Resources>
<Applications>
<Application Id="App" Executable="$targetnametoken$.exe" EntryPoint="MyApplication.App">
<m2:VisualElements
DisplayName="Magnum Windows Store Application"
Description="My Application"
BackgroundColor="#202020"
ForegroundText="light"
Square150x150Logo="assets/logo.png"
Square30x30Logo="assets/logo-small.png">
<m2:SplashScreen Image="assets/splash.png" />
</m2:VisualElements>
</Application>
</Applications>
</Package>
@endcode
The assets are referenced also from the main `CMakeLists.txt` file. You have to
mark all non-source files (except for the `*.pfx` key) with `VS_DEPLOYMENT_CONTENT`
property and optionally set their location with `VS_DEPLOYMENT_LOCATION`. If
you are using `*.resw` files, these need to have the `VS_TOOL_OVERRIDE`
property set to `PRIResource`.
*/ */
class Sdl2Application { class Sdl2Application {
public: public:

Write Preview
Loading…
Cancel
Save