2020.06 release

[mosra]

Should have been 2019.12, but hey -- I took a (semi-)break and survived until 2020!

There's a ton of little things, so better list them so I don't forget:

• Update copyright years everywhere (once pending PRs are merged) -- mosra/corrade@66c91d1, 19e0e96...
  • Also on the website
• Archive old changelogs so the page isn't longer than Big Tech EULAs
• version.h / versionPlugins.h / versionExtras.h ... everywhere -- mosra/corrade@7e0c03d, 293f092
• update singles with latest stuff, redo header line count calcs with GCC / Clang 10
• enable basis and meshoptimizer in homebrew packages -- mosra/homebrew-magnum@22217f9
  • do the same for imgui (needs also some automagic for detecting IMGUI_DIR that's bundled in the magnum-integration install location) -- mosra/magnum-integration@03f3257, mosra/homebrew-magnum@7fd472b
  • do the same for arch packages also -- mosra/magnum-plugins@1ac7a53, mosra/magnum-integration@af5e7ed, mosra/magnum-examples@5e49e4f
  • do it for vcpkg too so [basisu] Remove basis universal port microsoft/vcpkg#10761 can be merged -- [corrade,magnum,*-plugins,*-extras,*-integration] Update to v2020.06 microsoft/vcpkg#12211
• make ImGuiIntegration work with cmake-enabled add_subdirectory'd imgui? rAum/magnum-integration@d5e3dad postponed
• fix Sdl2Application and Basis patches in vcpkg -- [magnum/magnum-plugins] Fix patches for --head builds microsoft/vcpkg#10158
  • needs the rewritten OpenAL find module Rewrite FindOpenAL so it works with add_subdirectory'd OpenAL Soft sources #402 :(
• look at imgui in dynamic build (ImGui Integration with vcpkg magnum-integration#67) postponed
• Install 3rd party cmake find modules along with Magnum, to magnum's own dir so they don't conflict (and then add this dir to module path so these are found) postponed,
• Math::angle() returns NaN for similar vectors, fix similarly to

  magnum/src/Magnum/Math/Quaternion.h

  Lines 178 to 202 in a78cdc2

  	/* Avoid division by zero if the quats are very close and instead fall back
  	to a linear interpolation. This is intentionally not doing any
  	normalization as that's not needed. For a maximum angle α satisfying the
  	condition below, the two quaternions form two sides of an isosceles
  	triangle and its altitude x is length of the "shortest" possible
  	interpolated quaternion:
  	+
  	/|\ cos(α) > 1 - ε/2
  	/α|α\ α < arccos(1 - ε/2)
  	/-_|_-\
  	1 / | \ 1 x/1 < cos(α)
  	/ |x \ x/1 < cos(arccos(1 - ε/2))
  	/ | \ x < 1 - ε/2
  	+------+------+
  	Magnum's isNormalized() check treats all lengths in (1 - ε, 1 + ε) as
  	normalized, thus for an safety headroom this stops only at 1 - ε/2.
  	Additionally this needs to account for the case of the quaternions being
  	mutual negatives, in which case a simple lerp() would return a zero
  	quaternion for t = 0.5. */
  	if(std::abs(cosHalfAngle) > T(1) - T(0.5)*TypeTraits<T>::epsilon()) {
  	const Quaternion<T> shortestNormalizedA = cosHalfAngle < 0 ? -normalizedA : normalizedA;
  	return (T(1) - t)*shortestNormalizedA + t*normalizedB;
  	}

  -- 498f4c5
• ImageData::pixels() etc. rely on strided array view included before the header -- forward-declare arrayCast to avoid that -- cd7d080
• Fix std::strings being accidentally printed to debug as ResourceKey -- 2ba54b5
• Fix BufferTexture crashes on macOS -- e97b04f, 24cc971
  • There's yet another corner case when mixing textures and buffers because my state tracker doesn't have 100*18 fields for all texture types times all texture binding points FFS GL FFS -- 36f51e3
• This ResourceManager check should probably be <=

  magnum/src/Magnum/Resource.h

  Line 288 in a211873

  if(_manager->lastChange() < _lastCheck) return;

  -- 47e1106
• Look into plugin directory issues when building against brew-installed magnum/plugins (make default PLUGIN_DIRECTORY setting empty and pick it up first) -- mosra/corrade@a119b35, 4090a88
• Make libPNG / libJPEG version mismatch checks in plugin code non-fatal (check with homebrew libjpeg and libjpeg-turbo to be sure) nope, keeping them fatal -- in case of libJPEG this is a decoding error which we can't skip, in case of libPNG we'd need to fake the version string, which would work against the API that's there in the first place
• Update all apps to use RGBA framebuffer by default to avoid accidentally picking a RGB565 one (on Mac, Android) -- imgui-integration: ColorPicker gradient appears jagged on macOS using glfw magnum-integration#59, e6dc5be
• Move key/button/... enums to the base Application class to things like keyState(Key) are possible postponed as i don't have a good idea about the naming
• Better CMake subproject usage docs
• "Fix" Mac builds of homebrew-magnum because Homebrew is stupid -- mosra/homebrew-magnum@4a79ad4
  • It tries to do Py2->3 migration and fails, returning a non-zero code. "Solution" is to disable upgrading (uhhh). brew unlink python@2 (uhhh)
• Integrate changes from https://build.opensuse.org/project/show/home:synnick and https://github.com/alkavan/magnum-rpm-specs-f28, mention in Community Features
• Mention sequentity and https://github.com/fgoujeon/ternarii in Community Features a new Community Showcase Powered By Magnum page, along with other projects
• integrate the raytracing example -- Add RayTracing example magnum-examples#76
• integrate IcoImporter -- New plugin: IcoImporter magnum-plugins#79
• webgl releases of the two new physics examples + arcball
  • fix them on weird HiDPI platforms -- Fix HDPI problem for WebGL examples magnum-examples#74
• Finish growable arrays (arbitrary insertion / deletion) postponed, Compilation time, CI time and executable size improvements #293
• WM_DPICHANGED event on GLFW 3.3 & Windows (Correct out-of-the-box HiDPI support in SDL, GLFW and Android apps #243), check also Mac with multiple differently dense monitors postponed to DPI change events in Sdl2App and GlfwApp #423
• Use glfwGetWindowContentScale() for getting virtual DPI scaling on windows when we have GLFW 3.3+ at least (and make the original just physical (and also complain that glfw is too old when trying to use virtual on 3.2 and below)), but keep the original handling for Linux as it's also used in Sdl2App and many Linux distros still have just 3.2 -- 444b925
• GlfwApplication seems to be firing viewportEvent() / WM_SIZE event on Windows long before the event loop gets entered (repro case -- move Configuration into the constructor), possible workaround would be to suppress the events before mainLoopIteration gets called partially worked around by ignoring the first-ever viewport event (c17f5a0)
  • needs a better fix (setting up the callback only after constructor ends), otherwise assert(false) in the constructor does the same -- 8af1f6a
• Look into Android NDK r18+ on CMake 3.16 (Android dumpster fire, again #310)
  • Also Update adb to android sdk relative path toolchains#10 (the rest of the patch is postponed)
  • And Unable to import APK through Android Studio toolchains#11 postponed
• Finish MeshData rework (Mesh Data rework #371)
  • Custom attribute import in TinyGltfImporter -- mosra/magnum-plugins@79910b4
  • Custom attribute import in StanfordImporter -- mosra/magnum-plugins@dc41fe8
  • KHR_mesh_quantization support in TinyGltfImporter (so we support all data types) -- mosra/magnum-plugins@80028f6
    • KHR_texture_transform in TinyGltfImporter -- mosra/magnum-plugins@7345d78
  • Add support for tangents & binormals -- f4bca9b
    • Add Tangent attribute to spheroid and plane-like primitives -- 2a88a88, b168616, 1b776e1, a099a57
    • use in MeshTools::compile() -- 80c6fef
    • Support in TinyGltfImporter -- mosra/magnum-plugins@1cc6b4e
    • Tangents and binormals in AssimpImporter -- mosra/magnum-plugins@1ed63e0
    • Tangent/bitangent generation using http://www.mikktspace.com/ postponed
  • Add support for object ID attribs -- 8a2a7e4
    • use in MeshTools::compile() -- ea3bcb6
    • Gather info about what attribute names are used in PLY (object_id) / glTF (_OBJECT_ID)
    • Implement in StanfordImporter -- mosra/magnum-plugins@68e4fa5
    • Implement in TinyGltfImporter -- mosra/magnum-plugins@b451b60
• MeshTools::owned(), MeshTools::reference() because concatenate() is not good for that, update all code that used it like that before -- fdb754b
• properly handle positions with stride % 4 != 0 in MeshOptimizer -- mosra/magnum-plugins@12c2132
• fixed border classification in meshoptimizer master could improve simplification artifacts? not really
• Texture coordinate support in the cube primitive (one with a single texture for all faces, one with a center strip and two "ears" up and down, one packing six faces) potponed
• Finish & merge mip level selection (Trade: support mip levels in image import #369)
  • Adapt Assimp, Ogex, TinyGltf importers (I hope I have a branch with these)
• Extend format support in DDS (Support all formats, cubemaps and arrays in DdsImporter, make it more robust magnum-plugins#67) postponed as it needs the CompressedImage APIs to be aware of data sizes
  • Make a BC6H converter plugin using something from Data import/export plugin improvements #146 not really a priority anymore, postponed
  • Make a DDS converter that can contain the BC6H data postponed, rather invest time into KTX2
• Zero-copy import for gltf so we can operate on the data in-place (Zero-copy importer plugin APIs #240) -- just a MVP, glb only, as I need it for the dataset fixups postponed
  • Needs CgltfImporter because tinygltf can't be helped :/ postponed
• A non-crappy TextureTools::atlas() (I have some links somewhere, don't remember where) --
  with binary search that aims to fit into the smallest rectangle, plus trying a few sorting strategies, picking the one that fits best (don't need an incremental version yet, it's again just for the dataset fixups) postponed, links saved to Text rendering improvements #143
• mesh.draw(shader) -> shader.draw(mesh), also the xfb and MeshView version, deprecate the original -- 32d49db
• exit(0); in Application constructor should exit immediately after constructor ends, not process events or other stuff (mainLoopIteration() returning false directly, basically), document that it's a clean way to exit (compared to std::exit()) and suggest return exit(0) -- exit from constructor #429, 2149e78
• Make "globals shared across SOs" work for flextGL-generated function pointers in progress b580458, postponed, apparently works only with pointers and i'm not sure of the cost of the additional indirection
• Make the cone primitive properly smooth (how?!) postponed
• expose the new features (normals, primitive / object ID visualization, ...) in magnum-player -- mosra/magnum-extras@07055d5, mosra/magnum-extras@e50f8b8, mosra/magnum-extras@e979de2
• fix Math::cross() catastrophic cancellation according to https://pharr.org/matt/blog/2019/11/03/difference-of-floats.html postponed, Mitigate catastrophic cancellation in cross products and other code #435
• update basis plugins for UASTC support -- Update Basis Universal plugin for UASTC magnum-plugins#86 postponed, the new version crashes even on the most trivial tests
• wrap up and integrate scene conversion plugins , meshlets and serialization from Scene data serialization #427 -- https://blog.magnum.graphics/announcements/new-geometry-pipeline/

Stretch goals:

• CUDA device selection in WindowlessEglApp so Habitat can throw away their implementation -- CUDA device selection support #449
• Minimal instancing in Phong/Flat -- a1f1f66, 55685ea
  • per-vertex object IDs
  • Port physics examples to use instancing -- mosra/magnum-examples@6b55f43
• 2D MeshVisualizer shader
  • which can also take texture coordinates of a 3D mesh and visualize the UV layout postponed
• TBN and primitive visualization in MeshVisualizer
• Outlier removal in DebugTools::CompareImage (also visualize those somehow .. with a box?) postponed
• Aligned allocation (Utility/Memory.h, which could be used for stuff like magic ring buffers or non-reallocating arrays in the future also) postponed
• printing just file info in magnum-imageconverter without doing anything else -- 92655c7
  • and add a minimal sceneconverter with the same -- 1c51b98

[ytain]

Regarding TextureTools::atlas() there are two suggestions:
https://github.com/juj/RectangleBinPack
https://github.com/TeamHypersomnia/rectpack2D

And I wanted to bring you attention to additional stuff that might give you ideas later on the road:
https://github.com/azhirnov/FrameGraph
https://github.com/acdemiralp/fg
Those two will assist more the Vulkan and OpenGL AZDO paths.

//Edit
Forgot to mention also a serialization suggestion, header only
https://github.com/USCiLab/cereal (of course you could ignore the xml and json part of the serialization, and I'm not sure if it's zero-copy).
//Edit

Best regards

[mosra]

@ytain thank you! Yes, that thing from TeamHypersomnia is what I wanted to implement, as it's pretty small at its core.

Serialization (or its beginnings at least) will be done as part of #371. I really wanted to try something totally different here (with deserialization taking exactly 0 instructions), will see how it goes.

[aristotaloss]

This might be or not be a stretch, but it could be interesting: through MoltenVK you might be able to add Metal as a render target, making the iOS/Mac support better since Apple is now so heavily pushing Metal (even deprecating OpenGL). Just an idea - it would be really interesting since mobiles are our primary target and Magnum seems really great :)

[mosra]

@Velocity- That's the plan, in fact :) Though probably won't fit into this release, the list above is quite long already.

[alanjfs]

Powered By Magnum

You should have a logo printed up of that, happy to put that in the README of the project. ^__^

[ytain]

With regard to framegraph stuff that I mentioned in an earlier post of mine in this thread, you can see the benefits of using a framegraph approach to make a performant 3d engine.

Case in point, there's a graph showing which GPU states are expensive when changing:

https://computergraphics.stackexchange.com/questions/37/what-is-the-cost-of-changing-state/46#46

Best regards

[mosra]

🎉 All done, finally. Release notes here: https://blog.magnum.graphics/announcements/2020.06/