Skip to content

Commit

Permalink
docs: update release notes for 3.1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Spasi committed Nov 19, 2017
1 parent e4fdebd commit 72fab73
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 74 deletions.
2 changes: 1 addition & 1 deletion doc/notes/3.1.4.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### 3.1.4

_Not Released Yet_
_Released 2017 Nov 19_

This build includes the following changes:

Expand Down
3 changes: 2 additions & 1 deletion doc/notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

### Version History

* 2017-09-22 [3.1.3](3.1.3.md) (latest)
* 2017-11-19 [3.1.4](3.1.4.md) (latest)
* 2017-09-22 [3.1.3](3.1.3.md)
* 2017-05-15 [3.1.2](3.1.2.md)
* 2016-12-27 [3.1.1](3.1.1.md)
* 2016-10-30 [3.1.0](3.1.0.md)
Expand Down
44 changes: 44 additions & 0 deletions doc/notes/full.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,47 @@
### 3.1.4

_Released 2017 Nov 19_

This build includes the following changes:

#### Bindings

- Added [LZ4](http://lz4.github.io/lz4/) bindings.
- Added [NanoSVG](https://github.com/memononen/nanosvg) to the existing `NanoVG` bindings.
- Added [ODBC](https://docs.microsoft.com/en-us/sql/odbc/microsoft-open-database-connectivity-odbc) bindings.
- Added [Remotery](https://github.com/Celtoys/Remotery) bindings.
- Added [Zstandard](http://facebook.github.io/zstd/) bindings.
- bgfx: Updated to API version 55 (up from 48)
- glfw: Updated to pre-release 3.3.0 version (up from 3.3.0 pre-release):
* Support for transparent window framebuffers (`GLFW_TRANSPARENT_FRAMEBUFFER` window hint)
* Support for whole window opacity (`glfwGetWindowOpacity` and `glfwSetWindowOpacity`)
* Support for content scale queries (`glfwGetMonitorContentScale` and `glfwGetWindowContentScale`)
* Linux: Added support for the experimental Wayland backend. Enable with `-Dorg.lwjgl.glfw.libname=glfw_wayland`.
- LibOVR: Updated to 1.20.0 (up from 1.18.0)
- Nuklear: Updated to 2.00.4 (up from 2.00.2)
- tinyfiledialogs: Updated to 3.2.4 (up from 3.0.5)
- Vulkan: Updated to 1.0.65 (up from 1.0.61)
- Yoga: Updated to 1.7.0 (up from 1.6.0)

#### Improvements

- Replaced `Automatic-Module-Name` with explicit JPMS modules.
* Enables applications using LWJGL to be bundled in custom run-time images with the `jlink` tool.
- lmdb: Significantly improved incremental growth performance on Windows.
* Granularity of mapped memory commits increased from `4KB` (page size) to `2MB`.
* This is an unofficial patch of `ITS#8324`.

#### Fixes

- EGL: Fixed nullability of `eglMakeCurrent` arguments.
- OpenVR: Fixed mapping of Vulkan forward declarations.
- Fixed native library resource discovery when running LWJGL as JPMS modules.
- Fixed invalid size calculation in `<StructType>.malloc(capacity)` methods.
- Fixed `MemoryStack` debugging when a try-with-resources block does not inline the call to `AutoCloseable::close`.
* Supports Java 9 try-with-resources, which generates a synthetic `$closeResource` method.
* Supports Kotlin's `T.use`, which uses the `kotlin.AutoCloseable::closeFinally` extension function.
- Fixed build number lookup from the jar manifest.

### 3.1.3

_Released 2017 Sep 22_
Expand Down
102 changes: 30 additions & 72 deletions doc/notes/latest.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,43 @@
### 3.1.3
### 3.1.4

_Released 2017 Sep 22_
_Released 2017 Nov 19_

This build includes the following changes:

#### Bindings

- Added [rpmalloc](https://github.com/rampantpixels/rpmalloc) bindings.
* Use `-Dorg.lwjgl.system.allocator=rpmalloc` to make it the default memory allocator.
- Added new extensions to OpenCL, EGL, OpenGL and OpenGL ES.
- Assimp: Updated to 4.0.1 (up from 3.3.1)
- bgfx: Updated to API version 48 (up from 41)
- EGL: Added support for latest extensions
- Added [LZ4](http://lz4.github.io/lz4/) bindings.
- Added [NanoSVG](https://github.com/memononen/nanosvg) to the existing `NanoVG` bindings.
- Added [ODBC](https://docs.microsoft.com/en-us/sql/odbc/microsoft-open-database-connectivity-odbc) bindings.
- Added [Remotery](https://github.com/Celtoys/Remotery) bindings.
- Added [Zstandard](http://facebook.github.io/zstd/) bindings.
- bgfx: Updated to API version 55 (up from 48)
- glfw: Updated to pre-release 3.3.0 version (up from 3.3.0 pre-release):
* Improvements to error code query (`glfwGetError`)
* More library initialization hints (`glfwInitHintString`)
* SDL_GameControllerDB support
* Import gamepad mappings (`glfwUpdateGamepadMappings`)
* Query to determine whether a joystick has a gamepad mapping (`glfwJoystickIsGamepad`)
* Query the name of a controller provided by its gamepad mapping (`glfwGetGamepadName`)
* Retrieve gamepad input state (`glfwGetGamepadState`, `GLFW_GAMEPAD_*`, `GLFWgamepadstate`)
* Query the SDL compatible GUID of a joystick (`glfwGetJoystickGUID`)
* Linux: Moved to [evdev](https://www.freedesktop.org/software/libevdev/doc/latest/) for joystick input
* EGL: Fixed support for `EGL_KHR_create_context_no_error`
* GLX: Added support for `GLX_ARB_create_context_no_error`
* WGL: Added support for `WGL_ARB_create_context_no_error` and `WGL_EXT_colorspace`
- jemalloc: Updated to 5.0.1 (up from 4.5.0)
- LibOVR: Updated to 1.18.0 (up from 1.14.0)
- lmdb: Updated to 0.9.21 (up from withdrawn 0.9.20)
- NanoVG: Updated to latest version (performance updates and new `nvgShapeAntiAlias` function).
- Nuklear: Updated to 2.00.2 (up from 1.37.0)
- OpenAL: Added `ALC_SOFT_output_limiter` extension.
- OpenAL Soft: Updated to 1.18.2 (up from 1.17.2)
- OpenCL: Added support for OpenCL 2.2
- OpenGL: Added support for OpenGL 4.6 and latest extensions
- OpenGL ES: Added support for latest extensions
- OpenVR: Update to 1.0.10 (up from 1.0.7)
- stb
* Updated `stb_dxt` to 1.07 (up from 1.06)
* Updated `stb_image` to 2.16 (up from 2.15)
* Updated `stb_image_resize` to 0.95 (up from 0.94)
* Updated `stb_image_write` to 1.07 (up from 1.05)
* Updated `stb_truetype` to 1.17 (up from 1.15)
* Updated `stb_vorbis` to 1.11 (up from 1.10)
- tinyfiledialogs: Updated to 3.0.5 (up from 2.8.3)
- Vulkan: Updated to 1.0.61 (up from 1.0.49)
- xxhash: Updated to 0.6.3 (up from 0.6.2)
- Yoga: Updated to 1.6.0 (up from 1.5.0)
* Support for transparent window framebuffers (`GLFW_TRANSPARENT_FRAMEBUFFER` window hint)
* Support for whole window opacity (`glfwGetWindowOpacity` and `glfwSetWindowOpacity`)
* Support for content scale queries (`glfwGetMonitorContentScale` and `glfwGetWindowContentScale`)
* Linux: Added support for the experimental Wayland backend. Enable with `-Dorg.lwjgl.glfw.libname=glfw_wayland`.
- LibOVR: Updated to 1.20.0 (up from 1.18.0)
- Nuklear: Updated to 2.00.4 (up from 2.00.2)
- tinyfiledialogs: Updated to 3.2.4 (up from 3.0.5)
- Vulkan: Updated to 1.0.65 (up from 1.0.61)
- Yoga: Updated to 1.7.0 (up from 1.6.0)

#### Improvements

- Generator: Added `@NativeType` annotations to generated bindings. Documents the native type of:
* Callback and struct classes.
* Struct members.
* Function parameters and return values.
- The default memory allocator on Windows is now the system allocator instead of jemalloc.
* jemalloc is not properly optimized for Windows and its performance is not competitive.
* jemalloc is still a major performance win on Linux and macOS.
* rpmalloc is faster on all platforms but requires per-thread setup, so must be enabled manually.
- Buffers created via `MemoryUtil` may now have up to `Integer.MAX_VALUE` elements, regardless of element size.
* For example this allows a `LongBuffer` allocation of up to 16GB.
- Added typed overloads to `MemoryUtil::memSet` and `MemoryUtil::memCopy`.
- `StructBuffer` subclasses are now `Iterable` and have `stream()` and `parallelStream()` methods.
- OpenGL: Added `LongBuffer` overloads to buffer object functions.
- Replaced `Automatic-Module-Name` with explicit JPMS modules.
* Enables applications using LWJGL to be bundled in custom run-time images with the `jlink` tool.
- lmdb: Significantly improved incremental growth performance on Windows.
* Granularity of mapped memory commits increased from `4KB` (page size) to `2MB`.
* This is an unofficial patch of `ITS#8324`.

#### Fixes

- bgfx: Fixed signature of `bgfx_create_frame_buffer_from_attachment`.
- OpenGL: Fixed signature of `glPixelStoref`.
- OpenGL: `ARB_direct_state_access` interactions are now respected when checking if the extension is available.
- stb_image: added `ShortBuffer` overload to `stbi_image_free`.
- stb_truetype: Fixed signature of `stbtt_PackFontRangesGatherRects` and `stbtt_PackFontRangesRenderIntoRects`.

#### Breaking Changes

- glfw: Signature of `glfwGetError` has changed.
- jemalloc: Removed `JEmacros` and moved its functionality to `JEmalloc`.
- jemalloc: `ChunkHooks` has been replaced by `ExtentHooks`.
- OpenCL: Removed two confusing `clCompileProgram` overloads.

#### Known Issues

- The `<StructType>.malloc(capacity)` methods allocate memory with invalid size.
* Workaround: `<StructType>.calloc(capacity)` or `<StructType>.create(nmemAlloc(capacity * <StructType>.SIZEOF))`
- EGL: Fixed nullability of `eglMakeCurrent` arguments.
- OpenVR: Fixed mapping of Vulkan forward declarations.
- Fixed native library resource discovery when running LWJGL as JPMS modules.
- Fixed invalid size calculation in `<StructType>.malloc(capacity)` methods.
- Fixed `MemoryStack` debugging when a try-with-resources block does not inline the call to `AutoCloseable::close`.
* Supports Java 9 try-with-resources, which generates a synthetic `$closeResource` method.
* Supports Kotlin's `T.use`, which uses the `kotlin.AutoCloseable::closeFinally` extension function.
- Fixed build number lookup from the jar manifest.

0 comments on commit 72fab73

Please sign in to comment.