Return the language to be used in docgenerator [source] blocks.

Return block options to be used in docgenerator [source] blocks, which are appended to the 'source' block type. Can be empty.

Dump all the dictionaries constructed from the Registry object. Diagnostic to dump the dictionaries to specified file handle (default stdout)

Should aliased structs have the original struct definition listed in the generated docs snippet?

Actually write the interface to the output file.

Return string argument with surrounding quotes, for serialization into Python code.

Return file path to an extension appendix relative to a directory containing all such appendices. - name - extension name

Return format string for include:: line for an extension appendix file. - name - extension name

Return a list of extension prefixes used to group extension refpages.

Return extension name prefix. Typically two uppercase letters followed by an underscore. Assumed to be the same as api_prefix, but s

Return a short description of an extension for use in refpages. elem is an ElementTree for the <extension> tag in the XML. The defaul

Get the appropriate format macro for an external type like uint32_t. May override.

Return any extra text (following the title) for generated reference pages.

Return any extra text (following the title) for generated reference pages.

Return any extra text to add to refpage headers.

Return any extra headers (preceding the title) for generated reference pages.

Return suffix of generated Asciidoctor files

Return suffix of generated Asciidoctor files

Traverse a collection of elements with 'name' nodes or attributes, looking for and returning one with the right name. NOTE: Many places where thi

Traverse a collection of elements with 'name' attributes, looking for and returning one with the right name. NOTE: Many places where this is used

Traverse a collection of elements with 'type' nodes or attributes, looking for and returning one with the right typename. NOTE: Many places where

Mark up an extension name as a link in the spec.

Mark up a SPIR-V extension name as an external link in the spec. Since these are external links, the formatting probably will be

Mark up an API version name as a link in the spec.

Command generation

Generate interface for a command. - cmdinfo - CmdInfo for a command Extend to generate as desired in your derived class.

Generate the C declaration for a constant (a single <enum> value). <enum> tags may specify their values in several ways, but are usually

Generate interface for an enum (constant). - enuminfo - EnumInfo for an enum - name - enum name Extend to generate as desire

Generate interface for a format element. - formatinfo - FormatInfo Extend to generate as desired in your derived class.

Generate groups (e.g. C "enum" type). These are concatenated together with other types. If alias is not None, it is the name of anot

Generate interface for a group of enums (C "enum") - groupinfo - GroupInfo for a group. Extend to generate as desired in your derive

Generate interface for a spirv element. - spirvinfo - SpirvInfo for a command Extend to generate as desired in your derived class.

Generate interface for a C "struct" type. - typeinfo - TypeInfo for a type interpreted as a struct Extend to generate as desired in

Generate interface for a sync stage element. - accessinfo - AccessInfo Extend to generate as desired in your derived class.

Generate interface for a sync stage element. - pipelineinfo - SyncPipelineInfo Extend to generate as desired in your derived class.

Generate interface for a sync stage element. - stageinfo - SyncStageInfo Extend to generate as desired in your derived class.

Generate type.

Generate interface for a type - typeinfo - TypeInfo for a type Extend to generate as desired in your derived class.

Return True if asciidoctor tables describing enumerants in a group should be generated as part of group generation.

Return True if asiidoctor index terms should be generated as part of an API interface from the docgenerator.

Return True if MAX_ENUM tokens should be generated in documentation includes.

Generate a structure type name, like VK_STRUCTURE_TYPE_CREATE_INSTANCE_INFO

Generate a structure type name, like XR_TYPE_CREATE_INSTANCE_INFO. Must implement.

Return path relative to the generated reference pages, to the generated API include files.

Get the ancestors of a handle object.

Get a collection of all param elements for this command, if any.

True, if this format has a depth component

True, if this format has a stencil component

Return True if generating extension refpages by embedding extension appendix content (default), False otherwise (OpenXR).

True, if this format is a color.

True, if this format is a compressed one.

Try to do check if a structure is always considered valid (i.e. there is no rules to its acceptance).

Returns True if name is in the reserved API namespace. For Vulkan, these are names with a case-insensitive 'vk' prefix, or a 'PFN_vk'

Returns True if the protoname element is an API command requiring external synchronization

Determine if member type and name match the next pointer chain member.

Determine if member type and name match the structure type member.

Markup a leaf name as a C expression, using conventions of the Vulkan Validation Layers - name - version or extension name

Markup a leaf name as a C preprocessor defined() expression for use in protect attributes. Supports '!' prefix for negation. - name - p

Load an API registry XML file into a Registry object and parse it

Create a directory, if not already done. Generally called from derived generators creating hierarchies.

Prepend the appropriate format macro for an external type like uint32_t to a type name. Uses external_macro, so just override that if you wan

Make a (comma-separated) list for use in prose. Adds a connective (by default, 'and') before the last element if there are more than

Prepend the appropriate format macro for a structure to a structure type name. Uses struct_macro, so just override that if you want to change