aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJon Leech <[email protected]>2020-04-06 09:41:13 -0700
committerGitHub <[email protected]>2020-04-06 09:41:13 -0700
commitb4b0f994204e4fd1223260856a9fb4b738ed6b4e (patch)
tree43b2569338498d4939e23ced3bf5fff0b39faf77
parent0e78ffd1dcfc3e9f14a966b9660dbc59bd967c5c (diff)
downloadVulkan-Headers-b4b0f994204e4fd1223260856a9fb4b738ed6b4e.tar.gz
Vulkan-Headers-b4b0f994204e4fd1223260856a9fb4b738ed6b4e.zip
Update README.md with warning of pending header changes
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4687289..b29f4b4 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,20 @@
Vulkan header files and API registry
+## Advance Notice of Pending Header Change (posted 2020-04-06)
+
+Shortly after 2020-04-24, we will be removing the automatically generated
+`VK_*_BEGIN_RANGE`, `VK_*_END_RANGE`, and `VK_*_RANGE_SIZE` tokens
+from the Vulkan headers.
+These tokens are currently defined for some enumerated types, but are
+explicitly not part of the Vulkan API.
+They existed only to support some Vulkan implementation internals, which no
+longer require them.
+We will be accepting comments on this topic in
+https://github.com/KhronosGroup/Vulkan-Docs/issues/1230, but we strongly
+suggest any external projects using these tokens immediately migrate away
+from them.
+
## Repository Content
The contents of this repository are largely obtained from other repositories and are