Introduce raii-compliant handle wrapper classes.

RAII_Samples/CreateDebugUtilsMessenger/CMakeLists.txt

@@ -0,0 +1,35 @@
+# Copyright(c) 2019, NVIDIA CORPORATION. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+cmake_minimum_required(VERSION 3.2)
+
+project(RAII_CreateDebugUtilsMessenger)
+  
+set(HEADERS
+)
+  
+set(SOURCES
+  CreateDebugUtilsMessenger.cpp
+)
+  
+source_group(headers FILES ${HEADERS})
+source_group(sources FILES ${SOURCES})
+  
+add_executable(RAII_CreateDebugUtilsMessenger
+  ${HEADERS}
+  ${SOURCES}
+)
+  
+set_target_properties(RAII_CreateDebugUtilsMessenger PROPERTIES FOLDER "RAII_Samples")
+target_link_libraries(RAII_CreateDebugUtilsMessenger PRIVATE utils)

RAII_Samples/CreateDebugUtilsMessenger/CreateDebugUtilsMessenger.cpp

@@ -0,0 +1,144 @@
+// Copyright(c) 2019, NVIDIA CORPORATION. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// VulkanHpp Samples : CreateDebugReportMessenger
+//                     Draw a cube
+
+#include "../utils/utils.hpp"
+
+#include <iostream>
+#include <sstream>
+
+static char const * AppName    = "CreateDebugReportMessenger";
+static char const * EngineName = "Vulkan.hpp";
+
+VKAPI_ATTR VkBool32 VKAPI_CALL debugMessageFunc( VkDebugUtilsMessageSeverityFlagBitsEXT       messageSeverity,
+                                                 VkDebugUtilsMessageTypeFlagsEXT              messageTypes,
+                                                 VkDebugUtilsMessengerCallbackDataEXT const * pCallbackData,
+                                                 void * /*pUserData*/ )
+{
+  std::ostringstream message;
+
+  message << vk::to_string( static_cast<vk::DebugUtilsMessageSeverityFlagBitsEXT>( messageSeverity ) ) << ": "
+          << vk::to_string( static_cast<vk::DebugUtilsMessageTypeFlagsEXT>( messageTypes ) ) << ":\n";
+  message << "\t"
+          << "messageIDName   = <" << pCallbackData->pMessageIdName << ">\n";
+  message << "\t"
+          << "messageIdNumber = " << pCallbackData->messageIdNumber << "\n";
+  message << "\t"
+          << "message         = <" << pCallbackData->pMessage << ">\n";
+  if ( 0 < pCallbackData->queueLabelCount )
+  {
+    message << "\t"
+            << "Queue Labels:\n";
+    for ( uint8_t i = 0; i < pCallbackData->queueLabelCount; i++ )
+    {
+      message << "\t\t"
+              << "labelName = <" << pCallbackData->pQueueLabels[i].pLabelName << ">\n";
+    }
+  }
+  if ( 0 < pCallbackData->cmdBufLabelCount )
+  {
+    message << "\t"
+            << "CommandBuffer Labels:\n";
+    for ( uint8_t i = 0; i < pCallbackData->cmdBufLabelCount; i++ )
+    {
+      message << "\t\t"
+              << "labelName = <" << pCallbackData->pCmdBufLabels[i].pLabelName << ">\n";
+    }
+  }
+  if ( 0 < pCallbackData->objectCount )
+  {
+    message << "\t"
+            << "Objects:\n";
+    for ( uint8_t i = 0; i < pCallbackData->objectCount; i++ )
+    {
+      message << "\t\t"
+              << "Object " << i << "\n";
+      message << "\t\t\t"
+              << "objectType   = "
+              << vk::to_string( static_cast<vk::ObjectType>( pCallbackData->pObjects[i].objectType ) ) << "\n";
+      message << "\t\t\t"
+              << "objectHandle = " << pCallbackData->pObjects[i].objectHandle << "\n";
+      if ( pCallbackData->pObjects[i].pObjectName )
+      {
+        message << "\t\t\t"
+                << "objectName   = <" << pCallbackData->pObjects[i].pObjectName << ">\n";
+      }
+    }
+  }
+
+#ifdef _WIN32
+  MessageBox( NULL, message.str().c_str(), "Alert", MB_OK );
+#else
+  std::cout << message.str() << std::endl;
+#endif
+
+  return false;
+}
+
+int main( int /*argc*/, char ** /*argv*/ )
+{
+  try
+  {
+    std::unique_ptr<vk::raii::Context> context = vk::raii::su::make_unique<vk::raii::Context>();
+
+    /* VULKAN_KEY_START */
+
+    std::vector<vk::ExtensionProperties> props = context->enumerateInstanceExtensionProperties();
+
+    auto propsIterator = std::find_if( props.begin(), props.end(), []( vk::ExtensionProperties const & ep ) {
+      return strcmp( ep.extensionName, VK_EXT_DEBUG_UTILS_EXTENSION_NAME ) == 0;
+    } );
+    if ( propsIterator == props.end() )
+    {
+      std::cout << "Something went very wrong, cannot find " << VK_EXT_DEBUG_UTILS_EXTENSION_NAME << " extension"
+                << std::endl;
+      exit( 1 );
+    }
+
+    vk::ApplicationInfo                 applicationInfo( AppName, 1, EngineName, 1, VK_API_VERSION_1_1 );
+    const char *                        extensionName = VK_EXT_DEBUG_UTILS_EXTENSION_NAME;
+    vk::InstanceCreateInfo              instanceCreateInfo( {}, &applicationInfo, {}, extensionName );
+    std::unique_ptr<vk::raii::Instance> instance = vk::raii::su::make_unique<vk::raii::Instance>( *context, instanceCreateInfo );
+
+    vk::DebugUtilsMessageSeverityFlagsEXT severityFlags( vk::DebugUtilsMessageSeverityFlagBitsEXT::eWarning |
+                                                         vk::DebugUtilsMessageSeverityFlagBitsEXT::eError );
+    vk::DebugUtilsMessageTypeFlagsEXT     messageTypeFlags( vk::DebugUtilsMessageTypeFlagBitsEXT::eGeneral |
+                                                        vk::DebugUtilsMessageTypeFlagBitsEXT::ePerformance |
+                                                        vk::DebugUtilsMessageTypeFlagBitsEXT::eValidation );
+    vk::DebugUtilsMessengerCreateInfoEXT  debugUtilsMessengerCreateInfoEXT(
+      {}, severityFlags, messageTypeFlags, &debugMessageFunc );
+    std::unique_ptr<vk::raii::DebugUtilsMessengerEXT> debugUtilsMessenger =
+      vk::raii::su::make_unique<vk::raii::DebugUtilsMessengerEXT>( *instance, debugUtilsMessengerCreateInfoEXT );
+
+    /* VULKAN_KEY_END */
+  }
+  catch ( vk::SystemError & err )
+  {
+    std::cout << "vk::SystemError: " << err.what() << std::endl;
+    exit( -1 );
+  }
+  catch ( std::exception & err )
+  {
+    std::cout << "std::exception: " << err.what() << std::endl;
+    exit( -1 );
+  }
+  catch ( ... )
+  {
+    std::cout << "unknown error\n";
+    exit( -1 );
+  }
+  return 0;
+}