2019.01

[mosra]

I took a much-needed week-long break, which means 2018.12 is not humanly possible anymore and so the release will overflow to 2019. Happy new year, btw.

(Boring) things to do, in order:

• Make "shader compatibility" APIs and sources semi-public so these can be used from dependent libs and projects (TextureTools, imgui, Ui, redacted and probably more) postponed
• ImGui
  • Merge imgui integration (Move Imgui integration magnum-integration#33)
  • Port to WebGL 1 / ES2, enable that on CIs (depends on the public shader compat APIs) postponed
  • Merge imgui example (ImGuiIntegration example magnum-examples#51)
  • Make a WebGL demo for the website: https://magnum.graphics/showcase/imgui/
  • Remove the links from community features, add all the people to website credits
  • Update link to magnum integration in imgui's README, share the DPI-awareness workflow
  • Update to ImGui 1.67, enable mingw build mosra/magnum-integration@01dc2b3, mingw already enabled
• Everything else that's in the 2019.01 milestone and wasn't postponed (is anything else there?)
  • Not anything significant from Compilation time, CI time and executable size improvements #293, as I want to have all these together to be able to measure the total improvement
• Fix the Doxygen dumpster fire (the stable release is again anything but stable)
  • Show #include for all classes, functions etc. ([WIP] Infomation about which header to include for using class m.css#71)
• Make the Object Picking example work on Firefox (the glReadPixels() format fiasco again, https://github.com/mosra/magnum-website/issues/8) impossible, hitting several bugs, postponed
• Update toolchains submodule with Android / Emscripten on Windows fixes
• Document the "lack of model/view terminology" and explanation of inverse lookAt() in the transform docs, update the docs for Matrix multiply bug #287 as well -- dba0928 and 8240b8a
• Format support tables (list of all formats with plugins that provide support) i wanted them to look nice, but doxygen had a different opinion. Postponed.
• Update bootstrap repos with dropped CMake 2.8 and GCC 4.7 support and updated toolchains submodule
• Update copyright years (after all PRs are merged)
• archlinux package update
• homebrew package update -- mosra/homebrew-magnum@ded8123
• vcpkg package update, dependent packages should depend only on magnum[core], not the full thing (e.g. magnum-integration) (@Squareys, thanks! 🙏 ) -- [corrade,magnum,-integration,-extras,-plugins] Update Magnum to v2019.01 microsoft/vcpkg#5312
• Hunter Corrade package update (Add corrade v2019.01 ruslo/hunter#1730)
• Hunter Magnum package once everything is tagged (Add package magnum ruslo/hunter#1731)
• Rename ScopedExit to ScopeGuard mosra/corrade@f80dbfd

Nice to have:

• Crosscompilation support in Corrade Hunter package (details in Magnum hunter #298) postponed
• Conan packages (Conan package #304) -- done for Corrade, Magnum package postponed
• MSYS packages (Add PKGBUILDs for MSYS2/MinGW-w64 corrade#56, package/msys: Add PKGBUILDs. #307, package/msys: Add PKGBUILDs. magnum-plugins#50)
• SwiftShader-powered test on Travis (put a Linux *.so from Chrome binary on ci.magnum.graphics, use that), would bump test coverage from 52% to over 80% postponed
• Make GL::defaultFramebuffer constexpr to avoid static constructors and linker issues impossible, we need it mutable
• Fix Quaternion (s)lerp to not use atan (details in the reddit comment for the quaternion post) i have the fix implemented already, but it needs more testing (especially for the error behavior), so postponing
• Initial work for the magnum-singles repository
  • Publish the single-header-generator tool (docs)
  • Write the README, reference it from Magnum readme
  • Add ArrayView library there postponed
  • Add ScopeGuard there
• Make ArrayView slicing APIs constexpr (use the new assert) mosra/corrade@1158b09
• STL compat for ArrayView (construct from vectors/arrays) postponed, this needs quite a lot of work and testing to get right
• Make Animation::TrackView constexpr (needs constexpr type-erasing for StridedArrayView) not possible due to function pointer casts, postponed
• File callbacks for AbstractFont postponed

Fun (but not extremely important) things to do:

• Draft the ShaderTools library, add AbstractShaderConverter plugin iface postponed
• Conversions for basic Vulkan vector/rectangle/... types (Vulkan marketing!) -- 3281a27
• anyEvent() in Sdl2App for easier handling of additional events -- 20a55b1
• inotify implementation for Utility::FileWatcher (and a blocking API for it) postponed
• Windows implementation for Utility::FileWatcher postponed
• Dynamic plugin support for Android 23+ postponed
• wrap up FFmpegAudioImporter, add image version of it (needs mainly documenting all the supported formats) postponed
• Tweakable support for Android and Emscripten (need some way to supply changed files and notify the app ... (web)sockets?) postponed
• Hot-reload support for Android (need some way to call system() on the host... sockets?) postponed
• Finally integrate the Push The Box example postponed

Use the opportunity to Break Stuff™ so I can more easily integrate stuff later (also fun):

• API-agnostic base for Text::GlyphCache (Text rendering improvements #143) postponed
• Design Containers::UniquePtr with opt-in (currently implicit) STL compatibility and convert all Trade::AbstractImporter APIs to it (could also help with Compilation time, CI time and executable size improvements #293 later)
  • Move all APIs to use it
• Redesign Trade::AbstractImageConverter to make it possible to convert compressed images to compressed images and all other combinations postponed
• Redesign Trade::MeshData to get rid of vectors, make it possible to support interleaved data similarly to AnimationData and make it more extensible for additional attributes in progress, but a MeshTools rework needs to happen in parallel and that's quite a bit of work

[mosra]

@Squareys added a task for you: https://github.com/Microsoft/vcpkg/blob/master/ports/magnum-integration/CONTROL (and probably all others) should say just Build-Depends: magnum[core] instead of Build-Depends: magnum

(Thanks in advance! 🙏 )

Cc: @roig

[pthom]

@mosra : I will have some time to help you for the hunter package next week, if you need it. (I was on holiday until then :-)

[mosra]

@pthom oh, thank you! I'm afraid the release tagging will happen more near to the end of the month, since there's still a lot of stuff I have to do until then.

The other Hunter-related task was crosscompilation support for Corrade (based on the hints @ruslo mentioned in #298), and that would be best to have done before the tagging happen so the released version can make use of it. But unless you explicitly need that yourself I don't want to force you into that task.

[pthom]

@mosra : ok. I do not need it at the moment. Ping me if you need help :-)

[mosra]

Progress so far:

• ImGui integration and the example is merged, web version available at https://magnum.graphics/showcase/imgui/. I'll postpone WebGL 1 / ES2 port for later, as it's not extremely critical.
• Copyright years updated 🎆
• Doxygen post-release fixes submitted, issues opened (still have to use a fork, tho), the docs now tell what #include statements to use for all free symbols
• Sdl2Application::anyEvent() together with SDL_Event access done in 20a55b1
• Containers::Pointer and Reference implementations done (article on the blog), now moving all APIs to them
• Initial work for the magnum-singles repository done, generator tool published (docs)

[mosra]

More progress:

• ImGui update to 1.67 done in mosra/magnum-integration@01dc2b3, one minor breaking change in a test
• ScopedExit -> ScopeGuard done in mosra/corrade@f80dbfd
• MSYS package PRs merged
• Constexpr ArrayView slicing done in mosra/corrade@1158b09
• All APIs, examples etc. are moved to use the new Pointer and Reference APIs (CIs still running tho), except a few cases where it needs more work and thus was postponed
• magnum-singles README etc. finished, ScopeGuard added there

Some larger work that needs some time to get right is postponed after the release.

[mosra]

Final update (running late, argh):

• bootstrap repos updated to latest CMake modules + toolchains
• Conan package for Corrade integrated ( Packages: Add Conan support corrade#57)
• Math conventions docs improved in dba0928 and 8240b8a
• Everything else postponed
• Vulkan conversion done in 3281a27

Tagging right after the CIs are green.

[mosra]

@pthom The v2019.01 tag is pushed now, so I guess ready for Hunter packaging. Sorry for this taking so long and thanks in advance! 👍

[pthom]

@mosra: here is the PR for corrade v2019.01 : ruslo/hunter#1730

[mosra]

Wow, you're quick :)

[pthom]

@mosra :

• PR for adding a new hunter package to the CI on ingenue : Pr.pkg.magnum ingenue/hunter#333
• PR for the new package itself on hunter: Add package magnum ruslo/hunter#1731

[mosra]

@pthom thanks for all the work on the Hunter package :) It's now in the docs as well.

[mosra]

Arch packages (or at least the two main ones) are updated now as well, so I think I can finally close this.

For the record, the release announcement is here: https://blog.magnum.graphics/announcements/2019.01/