From a8d7c14888da1d4b8117820840cbcbcb5c736bed Mon Sep 17 00:00:00 2001 From: Ioannis Tsakpinis Date: Fri, 20 Nov 2015 20:47:08 +0200 Subject: [PATCH] Add release notes --- doc/notes/3.0.0a.md | 7 +++++++ doc/notes/3.0.0b.md | 29 +++++++++++++++++++++++++++++ doc/notes/README.md | 8 ++++++++ doc/notes/full.md | 37 +++++++++++++++++++++++++++++++++++++ doc/notes/latest.md | 29 +++++++++++++++++++++++++++++ 5 files changed, 110 insertions(+) create mode 100644 doc/notes/3.0.0a.md create mode 100644 doc/notes/3.0.0b.md create mode 100644 doc/notes/README.md create mode 100644 doc/notes/full.md create mode 100644 doc/notes/latest.md diff --git a/doc/notes/3.0.0a.md b/doc/notes/3.0.0a.md new file mode 100644 index 0000000000..5074560f2b --- /dev/null +++ b/doc/notes/3.0.0a.md @@ -0,0 +1,7 @@ +### 3.0.0 Alpha + +[DOWNLOAD](http://build.lwjgl.org/release/3.0.0a/lwjgl.zip) (not recommended) + +_Released 2015 Jul 13_ + +The first official release. This build suffers from several bugs and the API is very different from subsequent releases. diff --git a/doc/notes/3.0.0b.md b/doc/notes/3.0.0b.md new file mode 100644 index 0000000000..516b57449d --- /dev/null +++ b/doc/notes/3.0.0b.md @@ -0,0 +1,29 @@ +### 3.0.0 Beta + +[DOWNLOAD](http://build.lwjgl.org/release/3.0.0b/lwjgl.zip) + +_Released 2015 Nov 20_ + +This build includes the following changes: + +* The API is now considered **stable**. There were several API changes, especially to struct and callback classes. +* Moved advanced functionality from the base package to the [system](https://github.com/LWJGL/lwjgl3/tree/master/modules/core/src/main/java/org/lwjgl/system) package. Public API in the system package may change between releases. +* Critical methods have been optimized for better performance and garbage elimination. +* JNI methods are now [deduplicated](https://github.com/LWJGL/lwjgl3-generated/blob/master/java/org/lwjgl/system/JNI.java) and struct layout is calculated in Java. This means much smaller shared libraries. +* Introduced the [Configuration](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/Configuration.java) class that can be used to programmatically configure LWJGL. +* Introduced explicit memory management API, which is also used internally by LWJGL. +* Introduced a debug allocator that can be enabled for the explicit memory management API. It reports memory leaks with full stack-traces to the leaked allocations. +* All struct classes now have a corresponding [StructBuffer](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/StructBuffer.java) implementation. Bindings now use Struct and StructBuffer parameters and return values, instead of ByteBuffer, which improves type safety. +* Struct fields and accessors are now documented. +* Many other fixes and minor features. + +Changes to bindings: + +* Removed obsolete OS-specific bindings. +* Added bindings to many OpenGL extensions that were missing in 3.0.0a. +* Added bindings to [jemalloc](http://www.canonware.com/jemalloc/). +* Added bindings to [EGL](https://www.khronos.org/egl). +* Added bindings to [OpenGL ES](https://www.khronos.org/opengles/). +* Added bindings to [xxHash](https://github.com/Cyan4973/xxHash). +* The bindings to [LibOVR](https://developer.oculus.com/) were updated to 0.8.0.0 and are now included in the official build. +* Several other fixes and updates to existing bindings. diff --git a/doc/notes/README.md b/doc/notes/README.md new file mode 100644 index 0000000000..bcad3641a9 --- /dev/null +++ b/doc/notes/README.md @@ -0,0 +1,8 @@ +### [Release notes for latest version](latest.md) + +### [Release notes for all versions](full.md) + +### Version History + +* 2015-11-20 [3.0.0 Beta](3.0.0b.md) (latest) +* 2015-07-13 [3.0.0 Alpha](3.0.0a.md) diff --git a/doc/notes/full.md b/doc/notes/full.md new file mode 100644 index 0000000000..b6bfc48dbe --- /dev/null +++ b/doc/notes/full.md @@ -0,0 +1,37 @@ +### 3.0.0 Beta + +[DOWNLOAD](http://build.lwjgl.org/release/3.0.0b/lwjgl.zip) + +_Released 2015 Nov 20_ + +This build includes the following changes: + +* The API is now considered **stable**. There were several API changes, especially to struct and callback classes. +* Moved advanced functionality from the base package to the [system](https://github.com/LWJGL/lwjgl3/tree/master/modules/core/src/main/java/org/lwjgl/system) package. Public API in the system package may change between releases. +* Critical methods have been optimized for better performance and garbage elimination. +* JNI methods are now [deduplicated](https://github.com/LWJGL/lwjgl3-generated/blob/master/java/org/lwjgl/system/JNI.java) and struct layout is calculated in Java. This means much smaller shared libraries. +* Introduced the [Configuration](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/Configuration.java) class that can be used to programmatically configure LWJGL. +* Introduced explicit memory management API, which is also used internally by LWJGL. +* Introduced a debug allocator that can be enabled for the explicit memory management API. It reports memory leaks with full stack-traces to the leaked allocations. +* All struct classes now have a corresponding [StructBuffer](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/StructBuffer.java) implementation. Bindings now use Struct and StructBuffer parameters and return values, instead of ByteBuffer, which improves type safety. +* Struct fields and accessors are now documented. +* Many other fixes and minor features. + +Changes to bindings: + +* Removed obsolete OS-specific bindings. +* Added bindings to many OpenGL extensions that were missing in 3.0.0a. +* Added bindings to [jemalloc](http://www.canonware.com/jemalloc/). +* Added bindings to [EGL](https://www.khronos.org/egl). +* Added bindings to [OpenGL ES](https://www.khronos.org/opengles/). +* Added bindings to [xxHash](https://github.com/Cyan4973/xxHash). +* The bindings to [LibOVR](https://developer.oculus.com/) were updated to 0.8.0.0 and are now included in the official build. +* Several other fixes and updates to existing bindings. + +### 3.0.0 Alpha + +[DOWNLOAD](http://build.lwjgl.org/release/3.0.0a/lwjgl.zip) (not recommended) + +_Released 2015 Jul 13_ + +The first official release. This build suffers from several bugs and the API is very different from subsequent releases. diff --git a/doc/notes/latest.md b/doc/notes/latest.md new file mode 100644 index 0000000000..516b57449d --- /dev/null +++ b/doc/notes/latest.md @@ -0,0 +1,29 @@ +### 3.0.0 Beta + +[DOWNLOAD](http://build.lwjgl.org/release/3.0.0b/lwjgl.zip) + +_Released 2015 Nov 20_ + +This build includes the following changes: + +* The API is now considered **stable**. There were several API changes, especially to struct and callback classes. +* Moved advanced functionality from the base package to the [system](https://github.com/LWJGL/lwjgl3/tree/master/modules/core/src/main/java/org/lwjgl/system) package. Public API in the system package may change between releases. +* Critical methods have been optimized for better performance and garbage elimination. +* JNI methods are now [deduplicated](https://github.com/LWJGL/lwjgl3-generated/blob/master/java/org/lwjgl/system/JNI.java) and struct layout is calculated in Java. This means much smaller shared libraries. +* Introduced the [Configuration](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/Configuration.java) class that can be used to programmatically configure LWJGL. +* Introduced explicit memory management API, which is also used internally by LWJGL. +* Introduced a debug allocator that can be enabled for the explicit memory management API. It reports memory leaks with full stack-traces to the leaked allocations. +* All struct classes now have a corresponding [StructBuffer](https://github.com/LWJGL/lwjgl3/blob/master/modules/core/src/main/java/org/lwjgl/system/StructBuffer.java) implementation. Bindings now use Struct and StructBuffer parameters and return values, instead of ByteBuffer, which improves type safety. +* Struct fields and accessors are now documented. +* Many other fixes and minor features. + +Changes to bindings: + +* Removed obsolete OS-specific bindings. +* Added bindings to many OpenGL extensions that were missing in 3.0.0a. +* Added bindings to [jemalloc](http://www.canonware.com/jemalloc/). +* Added bindings to [EGL](https://www.khronos.org/egl). +* Added bindings to [OpenGL ES](https://www.khronos.org/opengles/). +* Added bindings to [xxHash](https://github.com/Cyan4973/xxHash). +* The bindings to [LibOVR](https://developer.oculus.com/) were updated to 0.8.0.0 and are now included in the official build. +* Several other fixes and updates to existing bindings.