aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndre Weissflog <floooh@gmail.com>2020-12-20 20:09:24 +0100
committerAndre Weissflog <floooh@gmail.com>2020-12-20 20:09:24 +0100
commit22b827997d4a8dc3f0ab6ebe0f44726acf152539 (patch)
tree13d76b693a7dd4bf5d494ec2f29a0e29aa31a015 /README.md
parentf48e55c585e27b2d0ed7498659ea30506405cc71 (diff)
update changes in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2bb635e3..d1ee3e23 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Simple
[STB-style](https://github.com/nothings/stb/blob/master/docs/stb_howto.txt)
cross-platform libraries for C and C++, written in C.
-[**See what's new**](#updates) (**02-Dec-2020** sokol_gfx.h: new sg_uninit_xxx() and sg_dealloc_xxx() functions)
+[**See what's new**](#updates) (**20-Dec-2020** sokol_gfx.h/sokol_app.h: minor but breaking API changes)
## Examples and Related Projects
@@ -441,6 +441,21 @@ Emulators](https://floooh.github.io/tiny8bit/) for more interesting usage exampl
# Updates
+- **20-Dec-2020**: A couple of minor breaking changes in the sokol_gfx.h and
+sokol_app.h APIs as preparation for the upcoming automatic language binding
+generation:
+ - in **sokol_gfx.h** nested unions have been removed:
+ - **sg_image_desc.depth/.layers** has been renamed to **.num_slices**
+ - **sg_attachment_desc.face/.layer/.slice** has been unified to **.slice**
+ - in **sokol_app.h** the return value of **sapp_run()** has been changed from
+ **int** to **void** (the function always returned zero anyway)
+
+ Non-breaking (or at most potentially breaking) changes:
+ - expressions in enums have been replaced with integer literals (e.g. (1<<2) becomes 4)
+ - the value of **SAPP_MOUSEBUTTON_INVALID** has been changed from -1 to 0x100
+
+ For more information about the upcoming automatic language-bindings generation [see this bog post](https://floooh.github.io/2020/08/23/sokol-bindgen.html)
+
- **02-Dec-2020**: sokol_gfx.h has a couple new public API functions for
destroying resources in two steps:
- sg_uninit_buffer + sg_dealloc_buffer