Skip to content

Commit 1513a15

Browse files
committed
doc: updated changelog for 2018.10.
1 parent 056642d commit 1513a15

File tree

2 files changed

+80
-44
lines changed

2 files changed

+80
-44
lines changed

doc/changelog-old.dox

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,8 @@ for a high-level overview.
641641
[mosra/magnum#16](https://github.com/mosra/magnum/issues/16),
642642
[mosra/magnum#21](https://github.com/mosra/magnum/issues/21),
643643
[mosra/magnum#22](https://github.com/mosra/magnum/issues/22),
644-
[mosra/magnum#23](https://github.com/mosra/magnum/pull/23).
644+
[mosra/magnum#23](https://github.com/mosra/magnum/pull/23),
645+
[mosra/magnum-bootstrap#2](https://github.com/mosra/magnum-bootstrap/issues/2).
645646

646647
@subsection changelog-2013-10-new New features
647648

@@ -701,6 +702,8 @@ for a high-level overview.
701702
[mosra/magnum#17](https://github.com/mosra/magnum/issues/17))
702703
- Extension support queries depend on selected GLSL version (see
703704
[mosra/magnum-examples#3](https://github.com/mosra/magnum-examples/issues/3))
705+
- Properly exporting `SceneGraph::AbstractCamera` symbols (see
706+
[mosra/magnum-bootstrap#3](https://github.com/mosra/magnum-bootstrap/issues/3))
704707

705708
@subsection changelog-2013-10-deprecated Deprecated APIs
706709

@@ -726,6 +729,11 @@ for a high-level overview.
726729
verbose @cpp AbstractShaderProgram::maxVertexAttributes() @ce,
727730
@cpp AbstractTexture::maxLayers() @ce and @cpp Sampler::maxAnisotropy() @ce
728731

732+
@subsection changelog-2013-10-documentation Documentation
733+
734+
- Fixed @ref SceneGraph bootstrap branch name (see
735+
[mosra/magnum-bootstrap#1](https://github.com/mosra/magnum-bootstrap/issues/1))
736+
729737
@subsection changelog-2013-10-compatibility Potential compatibility breakages, removed APIs
730738

731739
No deprecated API was removed in this release.

doc/changelog.dox

Lines changed: 71 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,28 @@ See also:
3636
- @subpage changelog-extras "Extras changelog"
3737
- @subpage changelog-examples "Examples changelog"
3838

39-
@section changelog-latest Changes since 2018.04
39+
@anchor changelog-latest
4040

41-
@subsection changelog-latest-new New features
41+
@section changelog-2018-10 2018.10
4242

43-
@subsubsection changelog-latest-new-animation Animation library
43+
Released 2018-10-23, tagged as
44+
[v2018.10](https://github.com/mosra/magnum/releases/tag/v2018.10).
45+
46+
@subsection changelog-2018-10-new New features
47+
48+
@subsubsection changelog-2018-10-new-animation Animation library
4449

4550
- New experimental @ref Animation library for keyframe-based animation
46-
playback
51+
playback (see [mosra/magnum#191](https://github.com/mosra/magnum/pull/191),
52+
[mosra/magnum#267](https://github.com/mosra/magnum/pull/267))
4753

48-
@subsubsection changelog-latest-new-debugtools DebugTools library
54+
@subsubsection changelog-2018-10-new-debugtools DebugTools library
4955

5056
- New @ref DebugTools::CompareImageFile, @ref DebugTools::CompareImageToFile
5157
and @ref DebugTools::CompareFileToImage comparators extending
5258
@ref DebugTools::CompareImage with convenient image file loading
5359

54-
@subsubsection changelog-latest-new-gl GL library
60+
@subsubsection changelog-2018-10-new-gl GL library
5561

5662
- Exposing @ref GL::Context::Flag::ForwardCompatible through
5763
@ref GL::Context::flags(), which was deliberately ignored before.
@@ -63,11 +69,12 @@ See also:
6369
equivalent functionality in OpenGL ES 3.2 / @gl_extension{OES,sample_shading}
6470
ES3 extension
6571

66-
@subsubsection changelog-latest-new-math Math library
72+
@subsubsection changelog-2018-10-new-math Math library
6773

6874
- New @ref Math::CubicHermite class for cubic Hermite spline interpolation,
6975
convertible to and from cubic Bézier curves using
7076
@ref Math::Bezier::fromCubicHermite() and @ref Math::CubicHermite::fromBezier()
77+
(see [mosra/magnum#267](https://github.com/mosra/magnum/pull/267))
7178
- Added @ref Math::Intersection::rangeFrustum(),
7279
@ref Math::Intersection::aabbFrustum(),
7380
@ref Math::Intersection::sphereFrustum(),
@@ -76,7 +83,8 @@ See also:
7683
@ref Math::Intersection::sphereConeView(),
7784
@ref Math::Intersection::sphereCone(),
7885
@ref Math::Intersection::aabbCone(),
79-
@ref Math::Intersection::rangeCone()
86+
@ref Math::Intersection::rangeCone() (see
87+
[mosra/magnum#226](https://github.com/mosra/magnum/pull/226))
8088
- Added @ref Math::Matrix3::rotationShear(),
8189
@ref Math::Matrix4::rotationShear(), @ref Math::Matrix3::scalingSquared(),
8290
@ref Math::Matrix4::scalingSquared(), @ref Math::Matrix3::scaling() const
@@ -136,7 +144,7 @@ See also:
136144
taking plain C arrays
137145
- Vector overloads for @ref Math::isInf() and @ref Math::isNan()
138146

139-
@subsubsection changelog-latest-new-platform Platform libraries
147+
@subsubsection changelog-2018-10-new-platform Platform libraries
140148

141149
- Initial HiDPI support for Linux and Emscripten in
142150
@ref Platform::Sdl2Application and @ref Platform::GlfwApplication
@@ -146,7 +154,8 @@ See also:
146154
@ref CORRADE_TARGET_EMSCRIPTEN "Emscripten" app canvas using
147155
@ref Platform::Sdl2Application::setContainerCssClass()
148156
- Implemented @ref Platform::GlfwApplication::MouseMoveEvent::buttons() for
149-
feature parity with @ref Platform::Sdl2Application
157+
feature parity with @ref Platform::Sdl2Application (see
158+
[mosra/magnum#256](https://github.com/mosra/magnum/issues/256))
150159
- Added @ref Platform::Sdl2Application::MouseScrollEvent::position() and
151160
@ref Platform::GlfwApplication::MouseScrollEvent::position()
152161
- Added @ref Platform::Sdl2Application::GLConfiguration::setColorBufferSize() "GLConfiguration::setColorBufferSize()",
@@ -170,7 +179,7 @@ See also:
170179
and @ref Platform::WindowlessEglApplication::Configuration::clearFlags() "Configuration::clearFlags()"
171180
for easier flag handling
172181

173-
@subsubsection changelog-latest-new-primitives Primitives library
182+
@subsubsection changelog-2018-10-new-primitives Primitives library
174183

175184
- New @ref Primitives::gradient2D(), @ref Primitives::gradient2DHorizontal(),
176185
@ref Primitives::gradient2DVertical(), @ref Primitives::gradient3D(),
@@ -181,7 +190,7 @@ See also:
181190
easier creation of arbitrary lines, as transforming the line identities is
182191
not worth the mental overhead
183192

184-
@subsubsection changelog-latest-new-scenegraph SceneGraph library
193+
@subsubsection changelog-2018-10-new-scenegraph SceneGraph library
185194

186195
- New @ref SceneGraph::TranslationRotationScalingTransformation2D and
187196
@ref SceneGraph::TranslationRotationScalingTransformation3D transformation
@@ -190,7 +199,7 @@ See also:
190199
- Ability to affect order of items drawn by @ref SceneGraph::Camera --- see
191200
@ref SceneGraph-Drawable-draw-order for more information
192201

193-
@subsubsection changelog-latest-new-shaders Shaders library
202+
@subsubsection changelog-2018-10-new-shaders Shaders library
194203

195204
- New dedicated @ref Shaders::VertexColor::Color3 and
196205
@ref Shaders::VertexColor::Color4 attribute specifiers for more convenient
@@ -203,7 +212,7 @@ See also:
203212
and @ref Shaders::Phong::Flag / @ref Shaders::Phong::Flags enums / enum
204213
sets
205214

206-
@subsubsection changelog-latest-new-trade Trade library
215+
@subsubsection changelog-2018-10-new-trade Trade library
207216

208217
- @ref Trade::AnimationData class and animation import interface in
209218
@ref Trade::AbstractImporter::animation() and related functions
@@ -230,7 +239,7 @@ See also:
230239
- @ref Trade::AnySceneImporter "AnySceneImporter" gained support for
231240
animation import
232241

233-
@subsubsection changelog-latest-new-vk Vk library
242+
@subsubsection changelog-2018-10-new-vk Vk library
234243

235244
- New @ref Vk library that'll be the home of a Vulkan graphics backend in the
236245
future
@@ -243,13 +252,14 @@ See also:
243252
@ref PixelFormat, @ref CompressedPixelFormat, @ref SamplerFilter,
244253
@ref SamplerMipmap and @ref SamplerWrapping enums to Vulkan-specific values
245254

246-
@subsection changelog-latest-changes Changes and improvements
255+
@subsection changelog-2018-10-changes Changes and improvements
247256

248-
@subsubsection changelog-latest-changes-audio Audio library
257+
@subsubsection changelog-2018-10-changes-audio Audio library
249258

250-
- Ability to specify initial source direction using @ref Audio::Playable::Playable(SceneGraph::AbstractObject<dimensions, Float>&, const VectorTypeFor<dimensions, Float>&, PlayableGroup<dimensions>*)
259+
- Ability to specify initial source direction using
260+
@ref Audio::Playable::Playable(SceneGraph::AbstractObject<dimensions, Float>&, const VectorTypeFor<dimensions, Float>&, PlayableGroup<dimensions>*)
251261

252-
@subsubsection changelog-latest-changes-gl GL library
262+
@subsubsection changelog-2018-10-changes-gl GL library
253263

254264
- To prevent nothing being rendered by accident, @ref GL::Mesh::setCount()
255265
and @ref GL::MeshView::setCount() now has always to be called, even just to
@@ -263,11 +273,8 @@ See also:
263273
possible as well
264274
- The @ref GL::BufferUsage parameter in @ref GL::Buffer::setData() is now
265275
optional, defaults to @ref GL::BufferUsage::StaticDraw
266-
- Restored backwards compatibility to the templated @ref GL::Buffer::map()
267-
overload --- it was not possible to call it with @cpp void @ce template
268-
parameter
269276

270-
@subsubsection changelog-latest-changes-math Math library
277+
@subsubsection changelog-2018-10-changes-math Math library
271278

272279
- All assertions in the @ref Math namespace now helpfully print the offending
273280
value that caused the assert for easier debugging
@@ -279,16 +286,17 @@ See also:
279286
@ref Math::Vector::projected(), @ref Math::Vector::projectedOntoNormalized()
280287
and @ref Math::Vector2::aspectRatio() are now enabled only for
281288
floating-point types to avoid errors when using these functions
282-
accidentally on integral vectors
289+
accidentally on integral vectors (see
290+
[mosra/magnum#251](https://github.com/mosra/magnum/issues/251))
283291

284-
@subsubsection changelog-latest-changes-meshtools MeshTools library
292+
@subsubsection changelog-2018-10-changes-meshtools MeshTools library
285293

286294
- @ref MeshTools::compile() API got simplified to make use of the new buffer
287295
ownership feature of @ref GL::Mesh
288296
- @ref MeshTools::compile() learned to handle vertex color attributes as well
289297
(see [mosra/magnum#284](https://github.com/mosra/magnum/pull/284))
290298

291-
@subsubsection changelog-latest-changes-platform Platform libraries
299+
@subsubsection changelog-2018-10-changes-platform Platform libraries
292300

293301
- @ref Platform::Sdl2Application::viewportEvent() "Platform::*Application::viewportEvent()"
294302
now gets all information needed for DPI-aware rendering instead of just
@@ -324,14 +332,14 @@ See also:
324332
no sense on Emscripten are not available there anymore
325333
- When using SDL 2.0.8 and newer, @ref Platform::Sdl2Application no longer
326334
attempts to disable compositing on Linux. See @ref Platform-Sdl2Application-usage-linux
327-
for more information.
335+
for more information. See also [mosra/magnum#184](https://github.com/mosra/magnum/issues/184).
328336
- New @cpp "swiftshader-no-empty-egl-context-flags" @ce and
329337
@cpp "swiftshader-egl-context-needs-pbuffer" @ce workarounds to make
330338
@ref Platform::WindowlessEglApplication working with
331339
[SwiftShader](https://github.com/google/swiftshader). See
332340
@ref opengl-workarounds for more information.
333341

334-
@subsubsection changelog-latest-changes-shaders Shaders library
342+
@subsubsection changelog-2018-10-changes-shaders Shaders library
335343

336344
- All shaders now have reasonable default values for uniforms in order to
337345
further simplify and remove friction from quick prototyping use cases
@@ -345,31 +353,39 @@ See also:
345353
@cpp 0x00000000_rgbaf @ce in order to support alpha-masked drawing out of
346354
the box
347355

348-
@subsubsection changelog-latest-changes-texturetools TextureTools library
356+
@subsubsection changelog-2018-10-changes-texturetools TextureTools library
349357

350358
- Fixed @ref TextureTools::distanceField() to not require more than 8 texture
351359
units, which is the limit on all iOS ES2 contexts, independently on the
352360
device (ES3 contexts have 16).
353361

354-
@subsubsection changelog-latest-changes-trade Trade library
362+
@subsubsection changelog-2018-10-changes-trade Trade library
355363

356364
- @ref Trade::PhongMaterialData now contains well-defined color values
357365
instead of random memory after construction
358366

359-
@subsection changelog-latest-buildsystem Build system
367+
@subsection changelog-2018-10-buildsystem Build system
360368

361369
- There's now a PPA for Ubuntu packages. See @ref building-packages-deb
362-
for more information.
370+
for more information. See also [mosra/magnum#248](https://github.com/mosra/magnum/issues/248)
371+
and [mosra/magnum#249](https://github.com/mosra/magnum/pull/249).
363372
- Fixed various issues preventing to build and use the base libraries with
364373
OpenGL support disabled (see [mosra/magnum#255](https://github.com/mosra/magnum/pull/255))
365374
- Magnum now links to GLVND on Linux instead of the old libGL ABI if using
366375
CMake 3.11 and newer
376+
- Using official Apple OpenGL include paths on iOS (see
377+
[mosra/magnum#253](https://github.com/mosra/magnum/pull/253))
367378
- @ref cmake "FindMagnum.cmake" now allows to use the @ref DebugTools library
368379
even if some of its optional dependencies are not compiled in
369380
- `FindSDL2.cmake` now properly links to `dl` and `pthread` libraries when
370381
using a static build of SDL2 on Linux
371382
- `FindSDL2.cmake` is now able to properly find a debug build of SDL, which
372383
enables Vcpkg to properly copy all dependency DLLs on Windows
384+
(see [mosra/magnum-examples#42](https://github.com/mosra/magnum-examples/issues/42),
385+
[mosra/magnum-examples#45](https://github.com/mosra/magnum-examples/pull/45))
386+
- `FindGLFW.cmake` is now preferring GLFW CMake config file to pick up the
387+
imported target, if available (see
388+
[mosra/magnum#194](https://github.com/mosra/magnum/pull/194))
373389
- `FindMagnum.cmake` now provides full paths to application JS/CSS files on
374390
@ref platforms-html5 "Emscripten" builds through new `MAGNUM_EMSCRIPTENAPPLICATION_JS`,
375391
`MAGNUM_WINDOWLESSEMSCRIPTENAPPLICATION_JS` and `MAGNUM_WEBAPPLICATION_CSS`
@@ -385,8 +401,10 @@ See also:
385401
@ref Trade::AnySceneImporter "AnySceneImporter" plugins were not correctly
386402
updated for subproject support after moving them out of the `magnum-plugins`
387403
repository
404+
- Improved out-of-the-box behavior with Emscripten toolchains (see
405+
[mosra/magnum#283](https://github.com/mosra/magnum/issues/283))
388406

389-
@subsection changelog-latest-bugfixes Bug fixes
407+
@subsection changelog-2018-10-bugfixes Bug fixes
390408

391409
- MSVC 15.8 (released on Aug 14, 2018) has a regression causing the compiler
392410
to crash with an ICE (C1001) on @ref Math::Color4 constructors that have a
@@ -399,16 +417,22 @@ See also:
399417
- An assert was firing during @ref Platform::GlfwApplication initialization
400418
due to a pointer not being properly initialized after the
401419
@ref Platform::GlfwApplication::GLConfiguration "GLConfiguration" rework in
402-
2018.04 (see [mosra/magnum#246](https://github.com/mosra/magnum/pull/246))
420+
2018.04 (see [mosra/magnum#246](https://github.com/mosra/magnum/pull/246),
421+
[mosra/magnum#247](https://github.com/mosra/magnum/issue/247))
403422
- Vertex attribute divisor in @ref GL::Mesh::addVertexBufferInstanced() was
404423
not properly cleaned up after when @gl_extension{ARB,vertex_array_object}
405424
was disabled, causing subsequent draws to misbehave
406425
- Fixed @ref Shaders::DistanceFieldVector and @ref Shaders::Vector to be
407426
properly movable
427+
- Restored backwards compatibility to the templated @ref GL::Buffer::map()
428+
overload --- it was not possible to call it with @cpp void @ce template
429+
parameter
408430
- @gl_extension{ARB,direct_state_access} versions of
409431
@ref GL::Framebuffer::clearColor(), @ref GL::Framebuffer::clearDepth(),
410432
@ref GL::Framebuffer::clearStencil() and @ref GL::Framebuffer::clearDepthStencil()
411433
were binding the framebuffer for drawing, which was completely unnecessary
434+
- Deprecation status of GL-specific values of the generic @ref MeshPrimitive
435+
enum was not properly reflected in the documentation
412436
- @ref Platform::GlfwApplication::InputEvent::Modifier::Super is properly
413437
reported for both left and right modifier (Windows/⌘) key instead of just
414438
the right one
@@ -426,10 +450,11 @@ See also:
426450
@ref SceneGraph::Object::addChild() were not properly forwarding reference
427451
arguments
428452

429-
@subsection changelog-latest-docs Documentation
453+
@subsection changelog-2018-10-docs Documentation
430454

431455
- New @ref custom-buildsystems page listing the most important things to keep
432-
in mind when using Magnum with custom buildsystems.
456+
in mind when using Magnum with custom buildsystems. See also
457+
[mosra/magnum#268](https://github.com/mosra/magnum/pull/268).
433458
- Compiled code snippets for @ref Audio and @ref SceneGraph libraries, fixing
434459
cases where outdated or plain wrong API constructs were mentioned
435460
- Extended documentation for @ref Math::Matrix3::rotation(),
@@ -453,10 +478,10 @@ See also:
453478
[mosra/magnum#261](https://github.com/mosra/magnum/issues/261))
454479
- Documentation of @ref Primitives and @ref Shaders namespaces now has proper
455480
sRGB and HiDPi renderings of all primitives and shaders
456-
- Deprecation status of GL-specific values of the generic @ref MeshPrimitive
457-
enum was not properly reflected in the documentation
481+
- Various other fixes and updates (see
482+
[mosra/magnum#281](https://github.com/mosra/magnum/pull/281))
458483

459-
@subsection changelog-latest-deprecated Deprecated APIs
484+
@subsection changelog-2018-10-deprecated Deprecated APIs
460485

461486
- The @ref Magnum::Shapes library is a failed design experiment and is
462487
scheduled for removal in a future release, together with
@@ -514,7 +539,7 @@ See also:
514539
@ref Platform::Sdl2Application::GLConfiguration::isSrgbCapable() "Platform::*Application::GLConfiguration::isSrgbCapable()" instead as it
515540
has consistent naming with @ref Math::Color3 "Math::Color" APIs
516541

517-
@subsection changelog-latest-compatibility Potential compatibility breakages, removed APIs
542+
@subsection changelog-2018-10-compatibility Potential compatibility breakages, removed APIs
518543

519544
- The @ref Magnum::Shapes library is not built by default anymore due to its
520545
deprecated status
@@ -1057,7 +1082,8 @@ a high-level overview.
10571082
- ANGLE ES2/ES3 support, ability to create desktop GLES contexts on Windows
10581083
- Windows Phone/Store support via ANGLE
10591084
- iOS support (see [mosra/magnum#82](https://github.com/mosra/magnum/issues/82))
1060-
- WebAssembly support when building for Emscripten
1085+
- WebAssembly support when building for Emscripten (see also
1086+
[mosra/magnum-bootstrap#11](https://github.com/mosra/magnum-bootstrap/issues/11))
10611087
- WebGL 2.0 support
10621088
- New OpenGL extension support:
10631089
- @gl_extension{EXT,draw_buffers} ES2 extension
@@ -1260,7 +1286,8 @@ a high-level overview.
12601286

12611287
- New @ref Platform::GlfwApplication class (see
12621288
[mosra/magnum#141](https://github.com/mosra/magnum/pull/141),
1263-
[mosra/magnum#160](https://github.com/mosra/magnum/pull/160))
1289+
[mosra/magnum#160](https://github.com/mosra/magnum/pull/160),
1290+
[mosra/magnum-bootstrap#6](https://github.com/mosra/magnum-bootstrap/pull/6))
12641291
- Text input support in @ref Platform::Sdl2Application and
12651292
@ref Platform::GlfwApplication (see [mosra/magnum#129](https://github.com/mosra/magnum/issues/129))
12661293
- Added @ref Platform::WindowlessWindowsEglApplication and
@@ -1717,7 +1744,8 @@ a high-level overview.
17171744
[mosra/magnum#94](https://github.com/mosra/magnum/pull/94),
17181745
[mosra/magnum#135](https://github.com/mosra/magnum/pull/135),
17191746
[mosra/magnum#170](https://github.com/mosra/magnum/issues/170),
1720-
[mosra/magnum-plugins#17](https://github.com/mosra/magnum-plugins/issues/17))
1747+
[mosra/magnum-plugins#17](https://github.com/mosra/magnum-plugins/issues/17),
1748+
[mosra/magnum-bootstrap#8](https://github.com/mosra/magnum-bootstrap/issues/8))
17211749

17221750
Changelogs for previous versions are available in @ref changelog-old.
17231751

0 commit comments

Comments
 (0)