Merge pull request #800 from krOoze/fix788_debug_bit_vs_bitmask

Fix #788: make clear messageTypes is a bitmask + name fix
This commit is contained in:
Jon Leech 2018-10-12 23:40:14 -07:00 committed by GitHub
commit ed15235082
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions

View File

@ -393,7 +393,7 @@ include::../api/structs/VkDebugUtilsMessengerCreateInfoEXT.txt[]
* pname:messageSeverity is a bitmask of * pname:messageSeverity is a bitmask of
elink:VkDebugUtilsMessageSeverityFlagBitsEXT specifying which severity elink:VkDebugUtilsMessageSeverityFlagBitsEXT specifying which severity
of event(s) will cause this callback to be called. of event(s) will cause this callback to be called.
* pname:messageTypes is a bitmask of * pname:messageType is a bitmask of
elink:VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of elink:VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of
event(s) will cause this callback to be called. event(s) will cause this callback to be called.
* pname:pfnUserCallback is the application callback function to call. * pname:pfnUserCallback is the application callback function to call.
@ -401,7 +401,7 @@ include::../api/structs/VkDebugUtilsMessengerCreateInfoEXT.txt[]
For each sname:VkDebugUtilsMessengerEXT that is created the For each sname:VkDebugUtilsMessengerEXT that is created the
sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageSeverity and sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageSeverity and
sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageTypes determine when sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageType determine when
that sname:VkDebugUtilsMessengerCreateInfoEXT::pname:pfnUserCallback is that sname:VkDebugUtilsMessengerCreateInfoEXT::pname:pfnUserCallback is
called. called.
The process to determine if the user's pfnUserCallback is triggered when an The process to determine if the user's pfnUserCallback is triggered when an
@ -496,7 +496,7 @@ addition of new severities in between the existing values.
-- --
Bits which can: be set in Bits which can: be set in
slink:VkDebugUtilsMessengerCreateInfoEXT::pname:messageTypes, specifying slink:VkDebugUtilsMessengerCreateInfoEXT::pname:messageType, specifying
event types which cause a debug messenger to call the callback, are: event types which cause a debug messenger to call the callback, are:
include::../api/enums/VkDebugUtilsMessageTypeFlagBitsEXT.txt[] include::../api/enums/VkDebugUtilsMessageTypeFlagBitsEXT.txt[]
@ -527,8 +527,9 @@ include::../api/funcpointers/PFN_vkDebugUtilsMessengerCallbackEXT.txt[]
* pname:messageSeverity specifies the * pname:messageSeverity specifies the
elink:VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this elink:VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this
callback. callback.
* pname:messageTypes specifies the * pname:messageTypes is a bitmask of
elink:VkDebugUtilsMessageTypeFlagBitsEXT that triggered this callback. elink:VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of
event(s) triggered this callback.
* pname:pCallbackData contains all the callback related data in the * pname:pCallbackData contains all the callback related data in the
slink:VkDebugUtilsMessengerCallbackDataEXT structure. slink:VkDebugUtilsMessengerCallbackDataEXT structure.
* pname:pUserData is the user data provided when the * pname:pUserData is the user data provided when the

View File

@ -574,7 +574,7 @@ server.
<comment>The PFN_vkDebugUtilsMessengerCallbackEXT type are used by the VK_EXT_debug_utils extension</comment> <comment>The PFN_vkDebugUtilsMessengerCallbackEXT type are used by the VK_EXT_debug_utils extension</comment>
<type category="funcpointer" requires="VkDebugUtilsMessengerCallbackDataEXT">typedef VkBool32 (VKAPI_PTR *<name>PFN_vkDebugUtilsMessengerCallbackEXT</name>)( <type category="funcpointer" requires="VkDebugUtilsMessengerCallbackDataEXT">typedef VkBool32 (VKAPI_PTR *<name>PFN_vkDebugUtilsMessengerCallbackEXT</name>)(
<type>VkDebugUtilsMessageSeverityFlagBitsEXT</type> messageSeverity, <type>VkDebugUtilsMessageSeverityFlagBitsEXT</type> messageSeverity,
<type>VkDebugUtilsMessageTypeFlagsEXT</type> messageType, <type>VkDebugUtilsMessageTypeFlagsEXT</type> messageTypes,
const <type>VkDebugUtilsMessengerCallbackDataEXT</type>* pCallbackData, const <type>VkDebugUtilsMessengerCallbackDataEXT</type>* pCallbackData,
<type>void</type>* pUserData);</type> <type>void</type>* pUserData);</type>