src/ngfx/porting/vulkan/VKDebugUtil.h

Namespaces

Name
ngfx

Classes

Name
class ngfx::VKDebugMessenger

Attributes

Name
const int VK_ENABLE_TRACE

Defines

Name
VK_TRACE(func)
V(func)

Attributes Documentation

variable VK_ENABLE_TRACE

const int VK_ENABLE_TRACE = 0;

VK_TRACE all Vulkan calls to log output

Macro Documentation

define VK_TRACE

#define VK_TRACE(
    func
)
  {                                                                            \
    if (VK_ENABLE_TRACE)                                                       \
      NGFX_LOG("%s", #func);                                                   \
    func;                                                                      \
  }

define V

#define V(
    func
)
  {                                                                            \
    if (VK_ENABLE_TRACE)                                                       \
      NGFX_LOG("%s", #func);                                                   \
    vkResult = func;                                                           \
    if (vkResult != VK_SUCCESS) {                                              \
      NGFX_ERR("%s failed: %s", #func,                                         \
               VKDebugMessenger::inst.VkResultToString(vkResult));             \
    }                                                                          \
  }

Source code

/*
 * Copyright 2020 GoPro Inc.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
#pragma once
#include "ngfx/core/DebugUtil.h"
#include <cassert>
#include <cstdarg>
#include <vulkan/vulkan.h>
const int VK_ENABLE_TRACE = 0;

namespace ngfx {
class VKDebugMessenger {
public:
  void create(VkInstance instance,
              VkDebugReportFlagsEXT flags = VK_DEBUG_REPORT_ERROR_BIT_EXT |
                                            VK_DEBUG_REPORT_WARNING_BIT_EXT);
  void destroy();
  const char *VkResultToString(VkResult errorCode);
  static VKDebugMessenger inst;

private:
  VkInstance instance;
  VkDebugUtilsMessengerEXT v;
};
}; // namespace ngfx
#define VK_TRACE(func)                                                         \
  {                                                                            \
    if (VK_ENABLE_TRACE)                                                       \
      NGFX_LOG("%s", #func);                                                   \
    func;                                                                      \
  }

#define V(func)                                                                \
  {                                                                            \
    if (VK_ENABLE_TRACE)                                                       \
      NGFX_LOG("%s", #func);                                                   \
    vkResult = func;                                                           \
    if (vkResult != VK_SUCCESS) {                                              \
      NGFX_ERR("%s failed: %s", #func,                                         \
               VKDebugMessenger::inst.VkResultToString(vkResult));             \
    }                                                                          \
  }

Updated on 3 April 2021 at 20:21:51 PDT