Vulkan Object Python Package

Parsing the vk.xml in Vulkan is easy, processing it is hard!

It is very easy for people to mess up trying to process the vk.xml file, so we created VulkanObject

VulkanObject is just a python dataclass that is defined in Vulkan-Headers/registry/vulkan_object.py. It uses the reg.py framework that the Vulkan Spec is generated with in order to populate the VulkanObject data structure.

This python package makes it super easy to get going.

pip install vulkan-object

and then it is as simple as

#!/usr/bin/env python3
from vulkan_object import get_vulkan_object

# This builds the VulkanObject that is populated and ready to be used
vk = get_vulkan_object()

print(f'There are now {len([x for x in vk.extensions.values()])} extensions in Vulkan')

print(f'Built with the {vk.headerVersion} headers')

longest_count = 0
for struct in vk.structs.values():
    if len(struct.name) > longest_count:
        longest_count = len(struct.name)
        longest_struct = struct
print(f'Longest Struct name is {longest_struct.name} at {longest_count} characters')

Quick query from the terminal

Just run the following and you can quickly use vk in your terminal for some quick query

python -i -c "from vulkan_object import get_vulkan_object;vk = get_vulkan_object()"

Vulkan Video

Added in 1.4.342 release

By default, the video.xml file is not parsed, but can be turned on. (example: video_example.py)

vk = get_vulkan_object(video=True)

More example

example.py has more in depth ways to use this

What is this package/repo actually?

The Vulkan-Headers contain a bunch of scripts in the Vulkan-Headers/registry/ directory that repos can use to help generate code.

The main issue is the delivery mechanism for python projects. This package/repo just grabs the Vulkan-Headers scripts (not the C header files themselves!) and make it easier to integrate with projects.

Updating this repo

run python update.py /path/to/Vulkan-Headers and it will do everything to sync this package up with the new headers

Release files for vulkan-object 1.4.364

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vulkan-object 1.4.364
File	Size	Uploaded
vulkan_object-1.4.364.tar.gz	418.8 kB	Sep 26, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for vulkan-object 1.4.364
File	Interpreter	ABI	Platform	Reset
vulkan_object-1.4.364-py3-none-any.whl 428.4 kB Sep 26, 2026	Python 3	none	any	Details

Total release size: 847.3 kB

Release files / vulkan_object-1.4.364.tar.gz

Download URL	vulkan_object-1.4.364.tar.gz
Size	418.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`0d0a883efdf9144184430f964bd035889eeeefb75da45ba8019218950acd18cd`
BLAKE2b-256 checksum How to use checksums	`62ee3370c985cea4bcd076faea50ebbcdbc0d033bb4581e10fb7209b69c0cb4e`
Upload date	Sep 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/KhronosGroup/vulkan-object
Publishing commit: github.com/KhronosGroup/vulkan-object/tree/1d1fc59fae6c822093463f848c1434ce67456ed3

Workflow

Publishing configuration: github.com/KhronosGroup/vulkan-object/blob/1d1fc59fae6c822093463f848c1434ce67456ed3/.github/workflows/publish.yml
Publishing logs: github.com/KhronosGroup/vulkan-object/actions/runs/36204559691/attempts/1

Artifact

Subject: vulkan_object-1.4.364.tar.gz
SHA-256 checksum: 0d0a883efdf9144184430f964bd035889eeeefb75da45ba8019218950acd18cd Verifying attestations

Release files / vulkan_object-1.4.364-py3-none-any.whl

Download URL	vulkan_object-1.4.364-py3-none-any.whl
Size	428.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1a0c9466b21dda1cb074d337e4e4b139e17263ffc47f49dc86a29425107a7b7a`
BLAKE2b-256 checksum How to use checksums	`442c87602b66041f435497d1523038a7c75e3929ebe9777dca1c5722e71f4099`
Upload date	Sep 26, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/KhronosGroup/vulkan-object
Publishing commit: github.com/KhronosGroup/vulkan-object/tree/1d1fc59fae6c822093463f848c1434ce67456ed3

Workflow

Publishing configuration: github.com/KhronosGroup/vulkan-object/blob/1d1fc59fae6c822093463f848c1434ce67456ed3/.github/workflows/publish.yml
Publishing logs: github.com/KhronosGroup/vulkan-object/actions/runs/36204559691/attempts/1

Artifact

Subject: vulkan_object-1.4.364-py3-none-any.whl
SHA-256 checksum: 1a0c9466b21dda1cb074d337e4e4b139e17263ffc47f49dc86a29425107a7b7a Verifying attestations