From 00fc7714f0482d5bd1c556fb098c11fafe33fe48 Mon Sep 17 00:00:00 2001 From: mocabe Date: Tue, 30 Jun 2020 01:45:59 +0900 Subject: [PATCH] [doc] Add short doc for VULKAN_HPP_ASSERT_ON_RESULT --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 645cea2..3b5ef2c 100644 --- a/README.md +++ b/README.md @@ -377,7 +377,9 @@ std::vector properties = physicalDev ### Custom assertions -All over vulkan.hpp, there are a couple of calls to an assert function. By defining VULKAN_HPP_ASSERT, you can specifiy your own custom assert function to be called instead. +All over vulkan.hpp, there are a couple of calls to an assert function. By defining `VULKAN_HPP_ASSERT`, you can specifiy your own custom assert function to be called instead. + +By default, `VULKAN_HPP_ASSERT_ON_RESULT` will be used for checking results when `VULKAN_HPP_NO_EXCEPTIONS` is defined. If you want to handle errors by yourself, you can disable/customize it just like `VULKAN_HPP_ASSERT`. ### Extensions / Per Device function pointers