Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/KhronosGroup/Vulkan-Headers
/ functions
Functions
2,547 in github.com/KhronosGroup/Vulkan-Headers
⨍
Functions
2,547
◇
Types & classes
5,577
↓ 101 callers
Method
logMsg
Write a message of different categories to different destinations. - `level` - 'diag' (diagnostic, voluminous) -
registry/generator.py:408
↓ 49 callers
Function
write
(*args, **kwargs)
registry/generator.py:25
↓ 32 callers
Function
test
(dependency, expected)
registry/parse_dependency.py:405
↓ 19 callers
Function
splitIfGet
(elem, name)
registry/base_generator.py:39
↓ 17 callers
Method
lookupElementInfo
Find a {Type|Enum|Cmd}Info object by name. Intended for internal use only. If an object qualified by API name exists, use that.
registry/reg.py:655
↓ 15 callers
Function
noneStr
Return string argument, or "" if argument is None. Used in converting etree Elements into text. s - string to convert
registry/generator.py:32
↓ 14 callers
Method
addElementInfo
Add information about an element to the corresponding dictionary. Intended for internal use only. - elem - `<type>`/`<enums>`/`<enum
registry/reg.py:633
↓ 13 callers
Method
dealias
(self, name: str, aliasMap: dict)
registry/base_generator.py:216
↓ 11 callers
Method
buildDefiningRequirements
(self, itemName: str, extNames: list[str])
registry/base_generator.py:448
↓ 9 callers
Method
__init__
(self, elem)
registry/reg.py:415
↓ 9 callers
Function
makeApiVersion
include/vulkan/vulkan.hpp:9301
↓ 9 callers
Method
newline
Print a newline to the output file (utility function)
registry/generator.py:1473
↓ 7 callers
Method
appendSection
Append a definition to the specified section
registry/cgenerator.py:317
↓ 7 callers
Method
compareKeys
Return True if self.elem and info.elem have the same attribute value for key. If 'required' is not True, also returns True if ne
registry/reg.py:331
↓ 7 callers
Method
emptyRegex
Substitute a regular expression which matches no version or extension names for None or the empty string.
registry/generator.py:336
↓ 7 callers
Method
enumToValue
Parse and convert an `<enum>` tag into a value. - elem - <enum> Element - needsNum - generate a numeric representation of the element
registry/generator.py:434
↓ 6 callers
Function
boolGet
(elem, name)
registry/base_generator.py:48
↓ 6 callers
Method
deprecationComment
If an API element is marked deprecated, return a brief comment describing why. Otherwise, return an empty string. - e
registry/generator.py:598
↓ 6 callers
Function
matchAPIProfile
Return whether an API and profile being generated matches an element's profile - api - string naming the API to match - profile - string
registry/reg.py:35
↓ 5 callers
Function
apiNameMatch
Return whether a required api name matches a pattern specified for an XML <feature> 'api' attribute or <extension> 'supported' attribute. - s
registry/reg.py:20
↓ 5 callers
Method
misracppstyle
(self)
registry/generator.py:595
↓ 5 callers
Method
resetState
(self)
registry/reg.py:424
↓ 5 callers
Method
validateFeature
Validate we are generating something only inside a `<feature>` tag
registry/generator.py:1033
↓ 4 callers
Method
_endProtectComment
(self, protect_str, protect_directive='#ifdef')
registry/cgenerator.py:238
↓ 4 callers
Method
makeCParamDecl
Return a string which is an indented, formatted declaration for a `<param>` or `<member>` block (e.g. function parameter or structure/
registry/generator.py:1152
↓ 4 callers
Function
textIfFind
(elem, name)
registry/base_generator.py:42
↓ 3 callers
Method
__init__
Constructor - errFile, warnFile, diagFile - file handles to write errors, warnings, diagnostics to. May be None to not write.
registry/generator.py:374
↓ 3 callers
Method
addEnumValue
Track aliasing and map back from enum values to their type
registry/reg.py:679
↓ 3 callers
Method
checkForCorrectionAliases
Check for an alias in the same require block. - alias - String name of the alias - require - `<require>` block from the registry
registry/reg.py:1304
↓ 3 callers
Function
dependencyBNF
boolop :: '+' | ',' extname :: Char(alphas) atom :: extname | '(' expr ')' expr :: atom [ boolop atom ]*
registry/parse_dependency.py:133
↓ 3 callers
Function
dependencyLanguage
Return an API dependency expression translated to a form suitable for asciidoctor conditionals or header file comments. - dependency - th
registry/parse_dependency.py:262
↓ 3 callers
Function
evaluateDependency
Evaluate a dependency expression, returning a boolean result. - dependency - the expression - isSupported - function taking a version or ex
registry/parse_dependency.py:219
↓ 3 callers
Function
findFirstWithPredicate
Return the first element that satisfies the predicate, or None if none exist. NOTE: Some places where this is used might be better served by chan
registry/spec_tools/util.py:26
↓ 3 callers
Function
genProtectDirective
Generate protection preprocessor directive. Protection strings are the strings defining the OS/Platform/Graphics requirements for a given API
registry/generator.py:53
↓ 3 callers
Method
generateFeature
Generate a single type / enum group / enum / command, and all its dependencies as needed. - fname - name of feature (`<type>`/`<enum>
registry/reg.py:1570
↓ 3 callers
Method
getAlias
Check for an alias in the same require block. - elem - Element to check for an alias
registry/reg.py:1288
↓ 3 callers
Method
makeCDecls
Return C prototype and function pointer typedef for a `<command>` or `type category="funcpointer"` Element, as a two-element list of s
registry/generator.py:1376
↓ 3 callers
Method
stripUnsupportedAPIs
Strip unsupported APIs from attributes of APIs. dictionary - *Info dictionary of APIs to be updated attribute - attribute name t
registry/reg.py:1801
↓ 3 callers
Method
swap
include/vulkan/vulkan_shared.hpp:229
↓ 3 callers
Function
throwResultException
include/vulkan/vulkan.hpp:8900
↓ 3 callers
Method
write
(self, data)
registry/base_generator.py:221
↓ 2 callers
Method
__init__
(self)
registry/base_generator.py:172
↓ 2 callers
Method
addConstants
(self, constantNames: list[str])
registry/base_generator.py:577
↓ 2 callers
Method
beginFile
(self, genOpts)
registry/base_generator.py:226
↓ 2 callers
Method
category_requires_validation
Return True if the given type 'category' always requires validation. Overridden because Vulkan does not require "valid" text for basetype
registry/vkconventions.py:251
↓ 2 callers
Method
checkDuplicateEnums
Check enumerated values for duplicates. - enums - list of `<enum>` Elements returns the list with duplicates stripped
registry/generator.py:533
↓ 2 callers
Method
endFile
(self)
registry/base_generator.py:660
↓ 2 callers
Function
evalDependencyLanguage
Evaluate an expression stack, returning an English equivalent - stack - the stack - leafMarkup, opMarkup, parenthesize - same as dependency
registry/parse_dependency.py:232
↓ 2 callers
Function
externSyncGet
(elem)
registry/base_generator.py:51
↓ 2 callers
Method
formatVersionOrExtension
Mark up an API version or extension name as a link in the spec.
registry/spec_tools/conventions.py:82
↓ 2 callers
Method
genRequirements
Generate text showing what core versions and extensions introduce an API. This exists in the base Generator class because it is used by
registry/generator.py:1019
↓ 2 callers
Method
generate
(self)
registry/base_generator.py:248
↓ 2 callers
Method
generateSpirv
(self, spirv, dictionary)
registry/reg.py:1788
↓ 2 callers
Function
getElemName
Get the name associated with an element, either a name child or name attribute.
registry/spec_tools/util.py:8
↓ 2 callers
Function
getElemType
Get the type associated with an element, either a type child or type attribute.
registry/spec_tools/util.py:17
↓ 2 callers
Method
getHandleParent
Get the parent of a handle object.
registry/generator.py:1242
↓ 2 callers
Method
getMembers
Get a collection of all member elements for this type, if any.
registry/reg.py:382
↓ 2 callers
Method
getTypeCategory
Get the category of a type.
registry/generator.py:1268
↓ 2 callers
Function
intIfGet
(elem, name)
registry/base_generator.py:45
↓ 2 callers
Method
isEnumRequired
Return True if this `<enum>` element is required, False otherwise - elem - `<enum>` element to test
registry/generator.py:1346
↓ 2 callers
Method
is_voidpointer_alias
Return True if the declaration components (tag,text,tail) of an element represents a void * type. Defaults to a reasonable implementa
registry/spec_tools/conventions.py:400
↓ 2 callers
Method
make_voidpointer_alias
Reformat a void * declaration to include the API alias macro. Defaults to a no-op. Must override if you actually want to use this fe
registry/spec_tools/conventions.py:409
↓ 2 callers
Method
markEnumRequired
Mark an enum as required or not. - enumname - name of enum - required - boolean (to tag features as required or not)
registry/reg.py:1141
↓ 2 callers
Method
markRequired
Require or remove features specified in the Element. - featurename - name of the feature - feature - Element for `<require>` or `<rem
registry/reg.py:1248
↓ 2 callers
Method
markTypeRequired
Require (along with its dependencies) or remove (but not its dependencies) a type. - typename - name of type - required - boolean (to
registry/reg.py:1085
↓ 2 callers
Method
parseTree
Parse the registry Element, once created
registry/reg.py:695
↓ 2 callers
Method
requireDependsSatisfied
Return True if the require element has no depends attribute, or if the depends boolean expression evaluates to true. Used to exclude r
registry/reg.py:1321
↓ 2 callers
Function
stripNonmatchingAPIs
Remove tree Elements with 'api' attributes matching apiName. tree - Element at the root of the hierarchy to strip. Only its child
registry/reg.py:274
↓ 2 callers
Method
type_always_valid
Return True if the given type name is always valid (never requires validation). This is for things like integers. Defaults to a reas
registry/spec_tools/conventions.py:425
↓ 1 callers
Method
Optional
include/vulkan/vulkan.hpp:560
↓ 1 callers
Method
__init__
(self, *args, **kwargs)
registry/cgenerator.py:180
↓ 1 callers
Method
_implMakeProseList
Internal-use implementation to make a (comma-separated) list for use in prose. Adds a connective (by default, 'and') before the last
registry/spec_tools/conventions.py:205
↓ 1 callers
Method
addVideoCodecs
(self)
registry/base_generator.py:597
↓ 1 callers
Method
apiGen
Generate interface for specified versions using the current generator and generator options
registry/reg.py:1894
↓ 1 callers
Method
applyExtensionDependency
(self)
registry/base_generator.py:260
↓ 1 callers
Method
assignAdditionalValidity
(self, interface, api, profile)
registry/reg.py:1550
↓ 1 callers
Method
beginFeature
(self, interface, emit)
registry/base_generator.py:733
↓ 1 callers
Method
beginFeature
Write interface for a feature and tag generated features as having been done. - interface - element for the `<version>` / `<extension>` to ge
registry/generator.py:1002
↓ 1 callers
Method
beginFile
Start a new interface file - genOpts - GeneratorOptions controlling what is generated and how
registry/generator.py:943
↓ 1 callers
Method
buildConstantCDecl
Generate the C declaration for a constant (a single <enum> value). <enum> tags may specify their values in several ways, but are
registry/generator.py:890
↓ 1 callers
Method
buildEnumCDecl
Generate the C declaration for an enum
registry/generator.py:633
↓ 1 callers
Method
buildEnumCDecl_BitmaskOrDefine
Generate the C declaration for an "enum" that is actually a set of flag bits
registry/generator.py:684
↓ 1 callers
Method
buildEnumCDecl_Enum
Generate the C declaration for an enumerated type
registry/generator.py:770
↓ 1 callers
Method
buildFullExtensionRequirements
(self)
registry/base_generator.py:465
↓ 1 callers
Function
categoryKey
Helper function, too long to put in a sort key lambda - feature - FeatureInfo containing the XML element to sort Sorts by:
registry/generator.py:111
↓ 1 callers
Method
compareElem
Return True if self.elem and info.elem have the same definition. info - the other object infoName - 'type' / 'group' / 'enum' / 'comma
registry/reg.py:341
↓ 1 callers
Function
compressionScheme
A textual description of the compression scheme, or an empty string if it is not compressed
include/vulkan/vulkan_format_traits.hpp:7886
↓ 1 callers
Method
createApiVersion
(targetApiName: str, name: str, featureRequirement)
registry/base_generator.py:109
↓ 1 callers
Method
createHeaderVersion
(targetApiName: str, vk: VulkanObject)
registry/base_generator.py:128
↓ 1 callers
Function
dependencyLanguageC
Return dependency expression translated to a form suitable for use in C expressions
registry/parse_dependency.py:293
↓ 1 callers
Function
dependencyLanguageComment
Return dependency expression translated to a form suitable for comments in headers of emitted C code, as used by the docgenerator.
registry/parse_dependency.py:280
↓ 1 callers
Function
dependencyLanguageSpecMacros
Return dependency expression translated to a form suitable for comments in headers of emitted C code, as used by the interfacegenerator.
registry/parse_dependency.py:287
↓ 1 callers
Function
dependencyMarkup
Return asciidoctor markup for a human-readable equivalent of an API dependency expression, suitable for use in extension appendix metada
registry/parse_dependency.py:382
↓ 1 callers
Function
dependencyNames
Return a set of the extension and version names in an API dependency expression. Used when determining transitive dependencies for spec
registry/parse_dependency.py:338
↓ 1 callers
Method
deprecateFeatures
Process `<require>` tags for a `<version>` or `<extension>`. - interface - Element for `<version>` or `<extension>`, containing `<r
registry/reg.py:1453
↓ 1 callers
Method
endFeature
(self)
registry/base_generator.py:824
↓ 1 callers
Method
endFeature
Finish an interface file, closing it when done. Derived classes responsible for emitting feature
registry/generator.py:1012
↓ 1 callers
Method
endFile
(self)
registry/generator.py:976
↓ 1 callers
Function
evalDependencyNames
Evaluate an expression stack, returning the set of extension and feature names used in the expression. - stack - the stack
registry/parse_dependency.py:321
↓ 1 callers
Function
evaluateStack
Evaluate an expression stack, returning a boolean result. - stack - the stack - isSupported - function taking a version or extension name s
registry/parse_dependency.py:198
next →
1–100 of 2,547, ranked by callers