Deprecate vk_sdk_platform.h

closes #316
KhronosGroup · Jan 5, 2023 · 18963a6 · 18963a6
1 parent 24115c7
commit 18963a6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/include/vulkan/vk_sdk_platform.h b/include/vulkan/vk_sdk_platform.h
@@ -20,6 +20,20 @@
  */
 #pragma once
 
+// Allow users to suppress warnings generated by this header file by defining VK_SDK_PLATFORM_SUPRRESS_DEPRECATION_WARNING
+#ifndef VK_SDK_PLATFORM_SUPRRESS_DEPRECATION_WARNING
+
+#if defined(__GNUC__) && __GNUC__ >= 4
+#warning "vk_sdk_platform.h is deprecated and will be removed in future release! Use VK_SDK_PLATFORM_SUPRRESS_DEPRECATION_WARNING to suppress warning!"
+#endif
+
+// MSVC doesn't support warning directive
+#if defined(_MSC_VER)
+#pragma message("vk_sdk_platform.h is deprecated and will be removed in future release! Use VK_SDK_PLATFORM_SUPRRESS_DEPRECATION_WARNING to suppress warning!")
+#endif
+
+#endif
+
 #if defined(_WIN32)
 #ifndef NOMINMAX
 #define NOMINMAX

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -42,3 +42,4 @@ target_link_libraries(vk_layer PRIVATE Vulkan::Headers)
 # vk_sdk_platform.h
 add_executable(vk_sdk_platform vk_sdk_platform.c)
 target_link_libraries(vk_sdk_platform PRIVATE Vulkan::Headers)
+target_compile_definitions(vk_sdk_platform PRIVATE VK_SDK_PLATFORM_SUPRRESS_DEPRECATION_WARNING)