vulkan-object 1.4.319__tar.gz

vulkan_object-1.4.319/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2015-2025 The Khronos Group Inc.
+
+Files in this repository fall under one of these licenses:
+
+- `Apache-2.0`
+- `MIT`
+
+Note: With the exception of `parse_dependency.py` the files using `MIT` license
+also fall under `Apache-2.0`. Example:
+
+```
+SPDX-License-Identifier: Apache-2.0 OR MIT
+```
+
+Full license text of these licenses is available at:
+
+  * Apache-2.0: https://opensource.org/licenses/Apache-2.0
+  * MIT: https://opensource.org/licenses/MIT

vulkan_object-1.4.319/MANIFEST.in

@@ -0,0 +1,3 @@
+# This line finds vk.xml within your package's source directory
+# and ensures it gets included in the distribution.
+include src/vulkan_object/vk.xml

vulkan_object-1.4.319/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: vulkan-object
+Version: 1.4.319
+Summary: An easy-to-use Python wrapper for the Vulkan API registry.
+Author-email: Spencer Fricke <spencer@lunarg.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Vulkan Object Python Package
+
+Parsing the [`vk.xml`](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/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](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/vulkan_object.py). It uses the [reg.py](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/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.
+
+```bash
+pip install vulkan-object
+```
+
+```python
+from vulkan_object import get_vulkan_object, VulkanObject
+
+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')
+```
+
+## 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
+
+## Testing locally
+
+To test, grab the repo and go `pip install -e .` in the root directory and will simulate grabbing it from `pip`
+
+## 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.

vulkan_object-1.4.319/README.md

@@ -0,0 +1,37 @@
+# Vulkan Object Python Package
+
+Parsing the [`vk.xml`](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/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](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/vulkan_object.py). It uses the [reg.py](https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/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.
+
+```bash
+pip install vulkan-object
+```
+
+```python
+from vulkan_object import get_vulkan_object, VulkanObject
+
+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')
+```
+
+## 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
+
+## Testing locally
+
+To test, grab the repo and go `pip install -e .` in the root directory and will simulate grabbing it from `pip`
+
+## 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.

vulkan_object-1.4.319/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vulkan-object"
+version = "1.4.319"
+authors = [
+  { name="Spencer Fricke", email="spencer@lunarg.com" },
+]
+description = "An easy-to-use Python wrapper for the Vulkan API registry."
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+# This flag is crucial! It tells setuptools to look at MANIFEST.in
+# and include non-Python files like vk.xml in the final package.
+include-package-data = true

vulkan_object-1.4.319/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vulkan_object-1.4.319/src/vulkan_object/__init__.py

@@ -0,0 +1,81 @@
+import functools
+import importlib.resources
+import tempfile
+import os
+from xml.etree import ElementTree
+from typing import Any
+
+# Use relative imports to access sibling modules
+from .reg import Registry
+from .base_generator import BaseGenerator, BaseGeneratorOptions, SetOutputDirectory, SetOutputFileName, SetTargetApiName, SetMergedApiNames
+from .vulkan_object import VulkanObject
+
+# Define the public API for your package
+__all__ = [
+    'get_vulkan_object',
+    'VulkanObject'  # Exposing the class is good for type-hinting
+]
+
+# Create the simplified, cached public function
+@functools.lru_cache(maxsize=1)
+def get_vulkan_object(alternative_xml: str = None) -> VulkanObject:
+    """
+    Parses the bundled Vulkan registry (vk.xml) and returns the populated
+    VulkanObject.
+
+    This function encapsulates all the setup logic. The result is cached,
+    so subsequent calls are instantaneous.
+
+    Args:
+        api_name: The API name to parse from the registry, defaults to 'vulkan'.
+        alternative_xml: Supply a full path to a different vk.xml (used for testing future extensions)
+
+    Returns:
+        An initialized VulkanObject instance providing access to the
+        Vulkan API registry data.
+    """
+    # This dummy generator class is required by the reg.py interface.
+    # We don't need it to do anything, as we just want the parsed data object.
+    class _InternalGenerator(BaseGenerator):
+        def __init__(self, *args, **kwargs):
+            super().__init__(*args, **kwargs)
+
+        def generate(self):
+            # This method is called by reg.apiGen() but we don't need to
+            # generate any files, so we just pass. The real goal is to
+            # populate self.vk (the VulkanObject).
+            pass
+
+    # The original script required setting an output directory, even if
+    # it's not used. We'll use a temporary one that cleans itself up.
+    with tempfile.TemporaryDirectory() as output_dir:
+        SetOutputDirectory(output_dir)
+        SetOutputFileName("unused.txt")
+        # TODO - Make a get_vulkan_sc_object() or pass this in as a parameter
+        SetTargetApiName('vulkan')
+        SetMergedApiNames(None)
+
+        # Initialize the generator and the registry machinery
+        generator = _InternalGenerator()
+        base_options = BaseGeneratorOptions()
+        reg = Registry(generator, base_options)
+
+        if alternative_xml:
+            if not os.path.isfile(alternative_xml):
+                raise FileNotFoundError(f"The provided alternative XML file does not exist or is not a file: {alternative_xml}")
+            tree = ElementTree.parse(alternative_xml)
+            reg.loadElementTree(tree)
+        else:
+            # Reliably find and parse vk.xml
+            try:
+                with importlib.resources.path('vulkan_object', 'vk.xml') as xml_path:
+                    tree = ElementTree.parse(xml_path)
+                    reg.loadElementTree(tree)
+            except FileNotFoundError:
+                raise RuntimeError("Could not find the bundled vk.xml - something has gone wrong with packaging.")
+
+        # This invokes reg.py and will populate _InternalGenerator
+        reg.apiGen()
+
+        return generator.vk
+

vulkan_object-1.4.319/src/vulkan_object/apiconventions.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3 -i
+#
+# Copyright 2021-2025 The Khronos Group Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Generic alias for working group-specific API conventions interface.
+
+# This import should be changed at the repository / working group level to
+# specify the correct API's conventions.
+
+
+import os
+
+defaultAPI = 'vulkan'
+
+VulkanAPI = os.getenv('VULKAN_API', default=defaultAPI)
+
+if VulkanAPI == 'vulkansc':
+    from .vkconventions import VulkanSCConventions as APIConventions
+else:
+    from .vkconventions import VulkanConventions as APIConventions