vks/
ext_debug_marker.rs

1// Copyright (c) 2017, Dennis Hamester <dennis.hamester@startmail.com>
2//
3// Permission to use, copy, modify, and/or distribute this software for any
4// purpose with or without fee is hereby granted, provided that the above
5// copyright notice and this permission notice appear in all copies.
6//
7// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
8// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
9// FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
11// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
12// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
13// PERFORMANCE OF THIS SOFTWARE.
14
15//! [`VK_EXT_debug_marker`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#VK_EXT_debug_marker)
16
17use core::ptr;
18use ext_debug_report;
19use libc::{c_char, c_void};
20use vk;
21
22pub const VK_EXT_DEBUG_MARKER_SPEC_VERSION: u32 = 4;
23pub const VK_EXT_DEBUG_MARKER_EXTENSION_NAME: &'static [u8; 20] = b"VK_EXT_debug_marker\x00";
24pub const VK_EXT_DEBUG_MARKER_EXTENSION_NAME_STR: &'static str = "VK_EXT_debug_marker";
25
26/// See [`VkDebugMarkerObjectNameInfoEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#VkDebugMarkerObjectNameInfoEXT)
27#[repr(C)]
28#[derive(Debug, Copy, Clone)]
29pub struct VkDebugMarkerObjectNameInfoEXT {
30    pub sType: vk::VkStructureType,
31    pub pNext: *const c_void,
32    pub objectType: ext_debug_report::VkDebugReportObjectTypeEXT,
33    pub object: u64,
34    pub pObjectName: *const c_char,
35}
36
37impl Default for VkDebugMarkerObjectNameInfoEXT {
38    fn default() -> Self {
39        VkDebugMarkerObjectNameInfoEXT {
40            sType: vk::VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT,
41            pNext: ptr::null(),
42            objectType: Default::default(),
43            object: Default::default(),
44            pObjectName: ptr::null(),
45        }
46    }
47}
48
49/// See [`VkDebugMarkerObjectTagInfoEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#VkDebugMarkerObjectTagInfoEXT)
50#[repr(C)]
51#[derive(Debug, Copy, Clone)]
52pub struct VkDebugMarkerObjectTagInfoEXT {
53    pub sType: vk::VkStructureType,
54    pub pNext: *const c_void,
55    pub objectType: ext_debug_report::VkDebugReportObjectTypeEXT,
56    pub object: u64,
57    pub tagName: u64,
58    pub tagSize: usize,
59    pub pTag: *const c_void,
60}
61
62impl Default for VkDebugMarkerObjectTagInfoEXT {
63    fn default() -> Self {
64        VkDebugMarkerObjectTagInfoEXT {
65            sType: vk::VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT,
66            pNext: ptr::null(),
67            objectType: Default::default(),
68            object: Default::default(),
69            tagName: Default::default(),
70            tagSize: Default::default(),
71            pTag: ptr::null(),
72        }
73    }
74}
75
76/// See [`VkDebugMarkerMarkerInfoEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#VkDebugMarkerMarkerInfoEXT)
77#[repr(C)]
78#[derive(Debug, Copy, Clone)]
79pub struct VkDebugMarkerMarkerInfoEXT {
80    pub sType: vk::VkStructureType,
81    pub pNext: *const c_void,
82    pub pMarkerName: *const c_char,
83    pub color: [f32; 4],
84}
85
86impl Default for VkDebugMarkerMarkerInfoEXT {
87    fn default() -> Self {
88        VkDebugMarkerMarkerInfoEXT {
89            sType: vk::VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT,
90            pNext: ptr::null(),
91            pMarkerName: ptr::null(),
92            color: Default::default(),
93        }
94    }
95}
96
97/// See [`vkDebugMarkerSetObjectTagEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkDebugMarkerSetObjectTagEXT)
98pub type PFN_vkDebugMarkerSetObjectTagEXT = Option<unsafe extern "system" fn(device: vk::VkDevice, pTagInfo: *const VkDebugMarkerObjectTagInfoEXT) -> vk::VkResult>;
99
100/// See [`vkDebugMarkerSetObjectNameEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkDebugMarkerSetObjectNameEXT)
101pub type PFN_vkDebugMarkerSetObjectNameEXT = Option<unsafe extern "system" fn(device: vk::VkDevice, pNameInfo: *const VkDebugMarkerObjectNameInfoEXT) -> vk::VkResult>;
102
103/// See [`vkCmdDebugMarkerBeginEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerBeginEXT)
104pub type PFN_vkCmdDebugMarkerBeginEXT = Option<unsafe extern "system" fn(commandBuffer: vk::VkCommandBuffer, pMarkerInfo: *const VkDebugMarkerMarkerInfoEXT)>;
105
106/// See [`vkCmdDebugMarkerEndEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerEndEXT)
107pub type PFN_vkCmdDebugMarkerEndEXT = Option<unsafe extern "system" fn(commandBuffer: vk::VkCommandBuffer)>;
108
109/// See [`vkCmdDebugMarkerInsertEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerInsertEXT)
110pub type PFN_vkCmdDebugMarkerInsertEXT = Option<unsafe extern "system" fn(commandBuffer: vk::VkCommandBuffer, pMarkerInfo: *const VkDebugMarkerMarkerInfoEXT)>;
111
112#[cfg(feature = "function_prototypes")]
113extern "system" {
114    /// See [`vkDebugMarkerSetObjectTagEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkDebugMarkerSetObjectTagEXT)
115    pub fn vkDebugMarkerSetObjectTagEXT(device: vk::VkDevice, pTagInfo: *const VkDebugMarkerObjectTagInfoEXT) -> vk::VkResult;
116
117    /// See [`vkDebugMarkerSetObjectNameEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkDebugMarkerSetObjectNameEXT)
118    pub fn vkDebugMarkerSetObjectNameEXT(device: vk::VkDevice, pNameInfo: *const VkDebugMarkerObjectNameInfoEXT) -> vk::VkResult;
119
120    /// See [`vkCmdDebugMarkerBeginEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerBeginEXT)
121    pub fn vkCmdDebugMarkerBeginEXT(commandBuffer: vk::VkCommandBuffer, pMarkerInfo: *const VkDebugMarkerMarkerInfoEXT);
122
123    /// See [`vkCmdDebugMarkerEndEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerEndEXT)
124    pub fn vkCmdDebugMarkerEndEXT(commandBuffer: vk::VkCommandBuffer);
125
126    /// See [`vkCmdDebugMarkerInsertEXT`](https://www.khronos.org/registry/vulkan/specs/1.0-extensions/html/vkspec.html#vkCmdDebugMarkerInsertEXT)
127    pub fn vkCmdDebugMarkerInsertEXT(commandBuffer: vk::VkCommandBuffer, pMarkerInfo: *const VkDebugMarkerMarkerInfoEXT);
128}