1 /* Copyright (c) 2015-2016 The Khronos Group Inc.
2 * Copyright (c) 2015-2016 Valve Corporation
3 * Copyright (c) 2015-2016 LunarG, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author: Mark Lobodzinski <mark@lunarg.com>
18 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
19 */
20
21 #pragma once
22 #include <stdbool.h>
23 #include <vector>
24 #include "vk_layer_logging.h"
25
26 #ifndef WIN32
27 #include <strings.h> /* for ffs() */
28 #else
29 #include <intrin.h> /* for __lzcnt() */
30 #endif
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #define VK_LAYER_API_VERSION VK_MAKE_VERSION(1, 0, VK_HEADER_VERSION)
37 typedef enum VkFormatCompatibilityClass {
38 VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT = 0,
39 VK_FORMAT_COMPATIBILITY_CLASS_8_BIT = 1,
40 VK_FORMAT_COMPATIBILITY_CLASS_16_BIT = 2,
41 VK_FORMAT_COMPATIBILITY_CLASS_24_BIT = 3,
42 VK_FORMAT_COMPATIBILITY_CLASS_32_BIT = 4,
43 VK_FORMAT_COMPATIBILITY_CLASS_48_BIT = 5,
44 VK_FORMAT_COMPATIBILITY_CLASS_64_BIT = 6,
45 VK_FORMAT_COMPATIBILITY_CLASS_96_BIT = 7,
46 VK_FORMAT_COMPATIBILITY_CLASS_128_BIT = 8,
47 VK_FORMAT_COMPATIBILITY_CLASS_192_BIT = 9,
48 VK_FORMAT_COMPATIBILITY_CLASS_256_BIT = 10,
49 VK_FORMAT_COMPATIBILITY_CLASS_BC1_RGB_BIT = 11,
50 VK_FORMAT_COMPATIBILITY_CLASS_BC1_RGBA_BIT = 12,
51 VK_FORMAT_COMPATIBILITY_CLASS_BC2_BIT = 13,
52 VK_FORMAT_COMPATIBILITY_CLASS_BC3_BIT = 14,
53 VK_FORMAT_COMPATIBILITY_CLASS_BC4_BIT = 15,
54 VK_FORMAT_COMPATIBILITY_CLASS_BC5_BIT = 16,
55 VK_FORMAT_COMPATIBILITY_CLASS_BC6H_BIT = 17,
56 VK_FORMAT_COMPATIBILITY_CLASS_BC7_BIT = 18,
57 VK_FORMAT_COMPATIBILITY_CLASS_ETC2_RGB_BIT = 19,
58 VK_FORMAT_COMPATIBILITY_CLASS_ETC2_RGBA_BIT = 20,
59 VK_FORMAT_COMPATIBILITY_CLASS_ETC2_EAC_RGBA_BIT = 21,
60 VK_FORMAT_COMPATIBILITY_CLASS_EAC_R_BIT = 22,
61 VK_FORMAT_COMPATIBILITY_CLASS_EAC_RG_BIT = 23,
62 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_4X4_BIT = 24,
63 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_5X4_BIT = 25,
64 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_5X5_BIT = 26,
65 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_6X5_BIT = 27,
66 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_6X6_BIT = 28,
67 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_8X5_BIT = 29,
68 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_8X6_BIT = 20,
69 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_8X8_BIT = 31,
70 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_10X5_BIT = 32,
71 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_10X6_BIT = 33,
72 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_10X8_BIT = 34,
73 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_10X10_BIT = 35,
74 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_12X10_BIT = 36,
75 VK_FORMAT_COMPATIBILITY_CLASS_ASTC_12X12_BIT = 37,
76 VK_FORMAT_COMPATIBILITY_CLASS_D16_BIT = 38,
77 VK_FORMAT_COMPATIBILITY_CLASS_D24_BIT = 39,
78 VK_FORMAT_COMPATIBILITY_CLASS_D32_BIT = 30,
79 VK_FORMAT_COMPATIBILITY_CLASS_S8_BIT = 41,
80 VK_FORMAT_COMPATIBILITY_CLASS_D16S8_BIT = 42,
81 VK_FORMAT_COMPATIBILITY_CLASS_D24S8_BIT = 43,
82 VK_FORMAT_COMPATIBILITY_CLASS_D32S8_BIT = 44,
83 VK_FORMAT_COMPATIBILITY_CLASS_MAX_ENUM = 45
84 } VkFormatCompatibilityClass;
85
86 typedef enum VkStringErrorFlagBits {
87 VK_STRING_ERROR_NONE = 0x00000000,
88 VK_STRING_ERROR_LENGTH = 0x00000001,
89 VK_STRING_ERROR_BAD_DATA = 0x00000002,
90 } VkStringErrorFlagBits;
91 typedef VkFlags VkStringErrorFlags;
92
93 VK_LAYER_EXPORT void layer_debug_actions(debug_report_data *report_data, std::vector<VkDebugReportCallbackEXT> &logging_callback,
94 const VkAllocationCallbacks *pAllocator, const char *layer_identifier);
95
vk_format_is_undef(VkFormat format)96 static inline bool vk_format_is_undef(VkFormat format) { return (format == VK_FORMAT_UNDEFINED); }
97
98 bool vk_format_is_depth_or_stencil(VkFormat format);
99 bool vk_format_is_depth_and_stencil(VkFormat format);
100 bool vk_format_is_depth_only(VkFormat format);
101 bool vk_format_is_stencil_only(VkFormat format);
102
vk_format_is_color(VkFormat format)103 static inline bool vk_format_is_color(VkFormat format) {
104 return !(vk_format_is_undef(format) || vk_format_is_depth_or_stencil(format));
105 }
106
107 VK_LAYER_EXPORT bool vk_format_is_norm(VkFormat format);
108 VK_LAYER_EXPORT bool vk_format_is_int(VkFormat format);
109 VK_LAYER_EXPORT bool vk_format_is_sint(VkFormat format);
110 VK_LAYER_EXPORT bool vk_format_is_uint(VkFormat format);
111 VK_LAYER_EXPORT bool vk_format_is_float(VkFormat format);
112 VK_LAYER_EXPORT bool vk_format_is_srgb(VkFormat format);
113 VK_LAYER_EXPORT bool vk_format_is_compressed(VkFormat format);
114 VK_LAYER_EXPORT VkExtent2D vk_format_compressed_block_size(VkFormat format);
115 VK_LAYER_EXPORT size_t vk_format_get_size(VkFormat format);
116 VK_LAYER_EXPORT unsigned int vk_format_get_channel_count(VkFormat format);
117 VK_LAYER_EXPORT VkFormatCompatibilityClass vk_format_get_compatibility_class(VkFormat format);
118 VK_LAYER_EXPORT VkDeviceSize vk_safe_modulo(VkDeviceSize dividend, VkDeviceSize divisor);
119 VK_LAYER_EXPORT VkStringErrorFlags vk_string_validate(const int max_length, const char *char_array);
120 VK_LAYER_EXPORT bool white_list(const char *item, const char *whitelist);
121
u_ffs(int val)122 static inline int u_ffs(int val) {
123 #ifdef WIN32
124 unsigned long bit_pos = 0;
125 if (_BitScanForward(&bit_pos, val) != 0) {
126 bit_pos += 1;
127 }
128 return bit_pos;
129 #else
130 return ffs(val);
131 #endif
132 }
133
134 #ifdef __cplusplus
135 }
136 #endif
137