1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
#!/usr/bin/python3 -i
#
# Copyright (c) 2015-2025 The Khronos Group Inc.
# Copyright (c) 2015-2025 Valve Corporation
# Copyright (c) 2015-2025 LunarG, Inc.
# Copyright (c) 2015-2025 Google Inc.
# Copyright (c) 2023-2025 RasterGrid Kft.
#
# Licensed 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.
import os
from base_generator import BaseGenerator
from generators.generator_utils import PlatformGuardHelper
# This class is a container for any source code, data, or other behavior that is necessary to
# customize the generator script for a specific target API variant (e.g. Vulkan SC). As such,
# all of these API-specific interfaces and their use in the generator script are part of the
# contract between this repository and its downstream users. Changing or removing any of these
# interfaces or their use in the generator script will have downstream effects and thus
# should be avoided unless absolutely necessary.
class APISpecific:
# Generates manual constants
@staticmethod
def genManualConstants(targetApiName: str) -> list[str]:
match targetApiName:
# Vulkan specific manual constant generation
case 'vulkan':
return []
class EnumFlagBitsOutputGenerator(BaseGenerator):
def __init__(self):
BaseGenerator.__init__(self)
def generate(self):
bitmasks = [] # List[Bitmask]
# Build up a list of which flagBits are actually called
# Some flagBits are only for return values, so the user will never call a function
# using them, and can reduce which ones we generate
for struct in [x for x in self.vk.structs.values() if not x.returnedOnly]:
for member in struct.members:
flagName = member.type.replace('Flags', 'FlagBits')
if member.type in self.vk.bitmasks and self.vk.bitmasks[member.type] not in bitmasks:
bitmasks.append(self.vk.bitmasks[member.type])
elif flagName in self.vk.bitmasks and self.vk.bitmasks[flagName] not in bitmasks:
bitmasks.append(self.vk.bitmasks[flagName])
for command in self.vk.commands.values():
for param in command.params:
flagName = param.type.replace('Flags', 'FlagBits')
if param.type in self.vk.bitmasks and self.vk.bitmasks[param.type] not in bitmasks:
bitmasks.append(self.vk.bitmasks[param.type])
elif flagName in self.vk.bitmasks and self.vk.bitmasks[flagName] not in bitmasks:
bitmasks.append(self.vk.bitmasks[flagName])
out = []
out.append(f'''// *** THIS FILE IS GENERATED - DO NOT EDIT ***
// See {os.path.basename(__file__)} for modifications
/***************************************************************************
*
* Copyright (c) 2015-2025 The Khronos Group Inc.
* Copyright (c) 2015-2025 Valve Corporation
* Copyright (c) 2015-2025 LunarG, Inc.
*
* Licensed 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.
****************************************************************************/\n''')
out.append('// NOLINTBEGIN') # Wrap for clang-tidy to ignore
out.append('''
#pragma once
#include <array>
#include "vulkan/vulkan.h"\n''')
out.append('// clang-format off\n')
out.append(f'const uint32_t GeneratedVulkanHeaderVersion = {self.vk.headerVersion};\n')
guard_helper = PlatformGuardHelper()
for bitmask in bitmasks:
if bitmask.flagName == 'VkGeometryInstanceFlagsKHR':
continue # only called in VkAccelerationStructureInstanceKHR which is never called anywhere explicitly
if bitmask.flagName == 'VkShaderStageFlags':
continue # Special case handled below
elif len(bitmask.flags) == 0:
continue # some bitmask are empty and used for reserve in the future
out.extend(guard_helper.add_guard(bitmask.protect))
out.append(f'const {bitmask.flagName} All{bitmask.name} = {"|".join([flag.name for flag in bitmask.flags])}')
out.append(';\n')
out.extend(guard_helper.add_guard(None))
out.extend(APISpecific.genManualConstants(self.targetApiName))
out.append('\n')
out.append('// mask of all the VK_PIPELINE_STAGE_*_SHADER_BIT stages\n')
out.append(f'const VkPipelineStageFlagBits2 AllVkPipelineShaderStageBits2 = {"|".join([flag.name for flag in self.vk.bitmasks["VkPipelineStageFlagBits2"].flags if "_SHADER_BIT" in flag.name])};\n')
out.append('\n')
# Special edge cases
out.append('// VK_SHADER_STAGE_ALL is special bit that is the collection of all bits.\n')
out.append('const VkShaderStageFlags AllVkShaderStageFlagBits = VK_SHADER_STAGE_ALL;\n')
out.append(f'const VkShaderStageFlags AllVkShaderStageFlagBitsExcludingStageAll = {"|".join([flag.name for flag in self.vk.bitmasks["VkShaderStageFlagBits"].flags if flag.name != "VK_SHADER_STAGE_ALL"])};\n')
out.append('\n')
flagBitsAsArray = ['VkQueueFlagBits', 'VkShaderStageFlagBits']
for bitmask in [self.vk.bitmasks[x] for x in flagBitsAsArray]:
out.append(f'[[maybe_unused]] constexpr std::array All{bitmask.flagName} = {{{",".join([flag.name for flag in bitmask.flags])}}};\n')
out.append('// clang-format on\n')
out.append('// NOLINTEND') # Wrap for clang-tidy to ignore
self.write("".join(out))
|
