Developer Documentation

These handle types are consumed by whatever command uses them. From the specification: "The following object types are consumed when they are passed into a Vulkan command and not further accessed by the objects they are used to create.".

Some specifications are disabled in the Vulkan headers (see https://github.com/KhronosGroup/Vulkan-Docs/issues/1225).

All specification aliases.

All specifications except aliases.

All enumerations, regardless of them being bitmasks or regular enum values.

Specification bitmask enumerations.

Specification constants, usually defined in C with #define.

Specification enumerations, excluding bitmasks.

Flag types.

Specification functions.

Specification handle types.

Specification structures.

Specification for union types.

Function func that creates a handle from a create info structure create_info_struct passed as the value of the parameter create_info_param.

If batch is true, then func expects a list of multiple create info structures and will create multiple handles at once.

struct CreateFunc <: Spec

• func::SpecFunc

• handle::SpecHandle

• create_info_struct::Union{Nothing, SpecStruct}

• create_info_param::Union{Nothing, SpecFuncParam}

• batch::Bool

Function func that destroys a handle passed as the value of the parameter destroyed_param.

If batch is true, then func expects a list of multiple handles and will destroy all of them at once.

struct DestroyFunc <: Spec

• func::SpecFunc

• handle::SpecHandle

• destroyed_param::SpecFuncParam

• batch::Bool

Function type classification.

Types:

• CREATE: constructor (functions that begin with vkCreate).
• DESTROY: destructor (functions that begin with vkDestroy).
• ALLOCATE: allocator (functions that begin with vkAllocate).
• FREE: deallocator (functions that begin with vkFree).
• COMMAND: Vulkan command (functions that begin with vkCmd).
• QUERY: used to query parameters, returned directly or indirectly through pointer mutation (typically, functions that begin with vkEnumerate and vkGet, but not all of them and possibly others).
• OTHER: no identified type.

primitive type FUNC_TYPE <: Enum{Int32} 32

Iterate through function or struct specification fields from a list of fields. list is a sequence of fields to get through from root.

struct FieldIterator

• root::Any

• list::Any

Parameter requirement. Applies both to struct members and function parameters.

Requirement types:

• OPTIONAL: may have its default zero (or nullptr) value, acting as a sentinel value (similar to Nothing in Julia).
• REQUIRED: must be provided, no sentinel value is allowed.
• POINTER_OPTIONAL: is a pointer which may be null, but must have valid elements if provided.
• POINTER_REQUIRED: must be a valid pointer, but its elements are optional (e.g. are allowed to be sentinel values).

primitive type PARAM_REQUIREMENT <: Enum{Int32} 32

Queue type on which a computation can be carried.

abstract type QueueType

The command can be executed inside a render pass.

struct RenderPassInside <: RenderPassRequirement

The command can be executed outside a render pass.

struct RenderPassOutside <: RenderPassRequirement

Render pass execution specification for commands.

abstract type RenderPassRequirement

Structure type classification.

Types:

• CREATE_INFO: holds constructor parameters (structures that end with CreateInfo).
• ALLOCATE_INFO: holds allocator parameters (structures that end with AllocateInfo).
• GENERIC_INFO: holds parameters for another function or structure (structures that end with Info, excluding those falling into the previous types).
• DATA: usually represents user or Vulkan data.
• PROPERTY: is a property returned by Vulkan in a returnedonly structure, usually done through QUERY type functions.

primitive type STRUCT_TYPE <: Enum{Int32} 32

Everything that a Vulkan specification can apply to: data structures, functions, parameters...

abstract type Spec

Specification for an alias of the form const <name> = <alias>.

Specification for a bit used in a bitmask.

struct SpecBit <: Spec

• name::Symbol

  Name of the bit.

• position::Int64

  Position of the bit.

Specification for a bitmask type that must be formed through a combination of bits.

Is usually an alias for a UInt32 type which carries meaning through its bits.

struct SpecBitmask <: Spec

• name::Symbol

  Name of the bitmask type.

• bits::StructArrays.StructVector{SpecBit, C, I} where {C<:Union{Tuple, NamedTuple}, I}

  Valid bits that can be combined to form the final bitmask value.

• width::Integer

Specification for a constant.

struct SpecConstant <: Spec

• name::Symbol

  Name of the constant.

• value::Any

  Value of the constant.

Specification for an enumeration type.

struct SpecEnum <: Spec

• name::Symbol

  Name of the enumeration type.

• enums::StructArrays.StructVector{SpecConstant, C, I} where {C<:Union{Tuple, NamedTuple}, I}

  Vector of possible enumeration values.

Specification for a flag type name that is a type alias of typealias. Can be associated with a bitmask structure, in which case the bitmask number is set to the corresponding SpecBitmask.

struct SpecFlag <: Spec

• name::Symbol

  Name of the flag type.

• typealias::Symbol

  The type it aliases.

• bitmask::Union{Nothing, SpecBitmask}

  Bitmask, if applicable.

Specification for a function.

struct SpecFunc <: Spec

• name::Symbol

  Name of the function.

• type::FUNC_TYPE

  FUNC_TYPE classification.

• return_type::Union{Nothing, Expr, Symbol}

  Return type (void if Nothing).

• render_pass_compatibility::Vector{RenderPassRequirement}

  Whether the function can be executed inside a render pass, outside, or both. Empty if not specified, in which case it is equivalent to both inside and outside.

• queue_compatibility::Vector{QueueType}

  Type of queues on which the function can be executed. Empty if not specified, in which case it is equivalent to being executable on all queues.

• params::StructArrays.StructVector{SpecFuncParam, C, I} where {C<:Union{Tuple, NamedTuple}, I}

  Function parameters.

• success_codes::Vector{Symbol}

• error_codes::Vector{Symbol}

Specification for a function parameter.

struct SpecFuncParam <: Spec

• func::Symbol

  Name of the parent function.

• name::Symbol

  Identifier.

• type::Union{Expr, Symbol}

  Expression of its Julian type.

• is_constant::Bool

  If constant, cannot be mutated by Vulkan functions.

• is_externsync::Bool

  Whether it must be externally synchronized before calling the function.

• requirement::PARAM_REQUIREMENT

  PARAM_REQUIREMENT classification.

• len::Union{Nothing, Symbol}

  Name of the parameter (of the same function) which represents its length. Nothing for non-vector types.

• arglen::Vector{Symbol}

  Name of the parameters (of the same function) it is a length of.

• autovalidity::Bool

  Whether automatic validity documentation is enabled. If false, this means that the parameter may be an exception to at least one Vulkan convention.

Specification for handle types.

A handle may possess a parent. In this case, the handle can only be valid if its parent is valid.

Some handles are dispatchable, which means that they are represented as opaque pointers. Non-dispatchable handles are 64-bit integer types, and may encode information directly into their value.

struct SpecHandle <: Spec

• name::Symbol

  Name of the handle type.

• parent::Union{Nothing, Symbol}

  Name of the parent handle, if any.

• is_dispatchable::Bool

  Whether the handle is dispatchable or not.

Specification for a structure.

struct SpecStruct <: Spec

• name::Symbol

  Name of the structure.

• type::STRUCT_TYPE

  STRUCT_TYPE classification.

• is_returnedonly::Bool

  Whether the structure is only returned by Vulkan functions (and never requested as input).

• extends::Vector{Symbol}

  Name of the structures it extends, usually done through the original structures' pNext argument.

• members::StructArrays.StructVector{SpecStructMember, C, I} where {C<:Union{Tuple, NamedTuple}, I}

  Structure members.

Specification for a structure parameter.

struct SpecStructMember <: Spec

• parent::Symbol

  Name of the parent structure.

• name::Symbol

  Identifier.

• type::Union{Expr, Symbol}

  Expression of its Julian type.

• is_constant::Bool

  If constant, cannot be mutated by Vulkan functions.

• is_externsync::Bool

  Whether it must be externally synchronized before calling any function which uses the parent structure.

• requirement::PARAM_REQUIREMENT

  PARAM_REQUIREMENT classification.

• len::Union{Nothing, Expr, Symbol}

  Name of the member (of the same structure) which represents its length. Nothing for non-vector types.

• arglen::Vector{Union{Expr, Symbol}}

  Name of the members (of the same structure) it is a length of.

• autovalidity::Bool

  Whether automatic validity documentation is enabled. If false, this means that the member may be an exception to at least one Vulkan convention.

Specification for a union type.

struct SpecUnion <: Spec

• name::Symbol

  Name of the union type.

• types::Vector{Union{Expr, Symbol}}

  Possible types for the union.

• selectors::Vector{Symbol}

  Selector values, if any, to determine the type of the union in a given context (function call for example).

• is_returnedonly::Bool

  Whether the type is only returned by Vulkan functions (and never requested as input).

Write the wrapper to destfile.

write(vw::VulkanWrapper, destfile::Any, docfile::Any)

Build a return expression from an implicit return parameter. Implicit return parameters are pointers that are mutated by the API, rather than returned directly. API functions with implicit return parameters return either nothing or a return code, which is automatically checked and not returned by the wrapper. Such implicit return parameters are Refs or Vectors holding either a base type or an API struct Vk*. They need to be converted by the wrapper to their wrapping type.

_wrap_implicit_return(return_param::SpecFuncParam; with_func_ptr) -> Union{Expr, Symbol}

Extend functions that create (or allocate) one or several handles, by exposing the parameters of the associated CreateInfo structures. spec must have one or several CreateInfo arguments.

extend_handle_constructor(spec::VulkanGen.CreateFunc; with_func_ptr) -> Dict{_A, _B} where {_A, _B}

Function pointer arguments for a function. Takes the function pointers arguments of the underlying handle if it is a Vulkan constructor, or a unique fun_ptr if that's just a normal Vulkan function.

func_ptr_args(spec::SpecFunc) -> Vector{Expr}

Function pointer arguments for a handle. Includes one fun_ptr_create for the constructor (if applicable), and one fun_ptr_destroy for the destructor (if applicable).

func_ptr_args(spec::SpecHandle) -> Vector{Expr}

Corresponding pointer argument for a Vulkan function.

func_ptrs(spec::Spec) -> AbstractVector{var"#s828"} where var"#s828"

Whether an alias was built from this name.

hasalias(name::Any) -> Union{Missing, Bool}

Represent an integer that gives the start of a C pointer.

is_pointer_start(spec::Spec) -> Union{Missing, Bool}

Whether this type is an alias for another name.

isalias(name::Any) -> Bool

Return a new type easier to deal with.

nice_julian_type(spec::Spec) -> Any

Semantically translate C types to their Julia counterpart. Note that since it is a semantic translation, translated types do not necessarily have the same layout, e.g. VkBool32 => Bool (8 bits).

translate_c_type(ctype::Any) -> Any

Generate an identifier from a Vulkan identifier, in lower snake case and without pointer prefixes (such as in pNext).

wrap_identifier(identifier::Any) -> Any