.. _stdlib_vulkan_runtime:

=================================================================
Runtime — result checking, array interop, ownership, versioning
=================================================================

.. das:module:: vulkan_runtime

Low-level runtime helpers shared by the rest of the boost layer: ``vk_check``
turns a ``VkResult`` into a panic (or forwards it to a caller-supplied
``var result``), ``array_addr`` bridges a daslang ``array<T>`` to the raw
pointer Vulkan expects, ``weak_copy`` produces a non-owning duplicate of a
handle wrapper, and ``make_api_version`` packs a version triple.



+++++++++++++++
Result checking
+++++++++++++++

  *  :ref:`vk_check (r: VkResult; var out: VkResult?) <function-vulkan_runtime_vk_check_VkResult_VkResult_q_>`

.. _function-vulkan_runtime_vk_check_VkResult_VkResult_q_:

.. das:function:: vk_check(r: VkResult; out: VkResult?)

def vk_check (r: VkResult; var out: VkResult?)

:Arguments: * **r** :  :ref:`VkResult <enum-vulkan-VkResult>`

            * **out** :  :ref:`VkResult <enum-vulkan-VkResult>`?


+++++++++++++
Array interop
+++++++++++++

  *  :ref:`array_addr (var a: array\<auto(TT)\>) : TT? <function-vulkan_runtime_array_addr_array_ls_autoTT_gr_>`

.. _function-vulkan_runtime_array_addr_array_ls_autoTT_gr_:

.. das:function:: array_addr(a: array<auto(TT)>) : TT?

def array_addr (var a: array<auto(TT)>) : TT?

:Arguments: * **a** : array<auto(TT)>


+++++++++
Ownership
+++++++++

  *  :ref:`weak_copy (b: auto(TT)) : TT <function-vulkan_runtime_weak_copy_autoTT_0x26>`

.. _function-vulkan_runtime_weak_copy_autoTT_0x26:

.. das:function:: weak_copy(b: auto(TT)) : TT

def weak_copy (b: auto(TT)) : TT

:Arguments: * **b** : auto(TT)


++++++++++
Versioning
++++++++++

  *  :ref:`make_api_version (major: uint; minor: uint; patch: uint) : uint <function-vulkan_runtime_make_api_version_uint_uint_uint>`

.. _function-vulkan_runtime_make_api_version_uint_uint_uint:

.. das:function:: make_api_version(major: uint; minor: uint; patch: uint) : uint

def make_api_version (major: uint; minor: uint; patch: uint) : uint

:Arguments: * **major** : uint

            * **minor** : uint

            * **patch** : uint