Package com.io7m.jcoronado.api
@Export
@Version("1.0.0")
package com.io7m.jcoronado.api
Type-safe Vulkan frontend (API)
-
ClassDescriptionBitmask specifying memory access types that will participate in a memory dependency.An exception raised by a memory allocation failure.An annotation that indicates that a device feature is required to use a particular method.A set of
VulkanAPIDeviceFeatureRequiredTypevalues.An annotation that indicates the original C API enum to which the annotated class is analogous.An annotation that indicates the original C API function pointer type to which the annotated class is analogous.A set ofVulkanAPIFunctionTypevalues.An annotation that indicates the original C API function to which the annotated method is analogous.The minimum Vulkan version required to support a feature.An annotation that indicates the original C API struct to which the annotated class is analogous.A description of the application that is using Vulkan.Builds instances of typeVulkanApplicationInfo.A description of the application that is using Vulkan.Structure specifying an attachment descriptionBuilds instances of typeVulkanAttachmentDescription.Structure specifying an attachment descriptionStructure specifying an attachment reference.Builds instances of typeVulkanAttachmentReference.Structure specifying an attachment reference.The R, G, B, and A components of the blend constant that are used in blending.Builds instances of typeVulkanBlendConstants.The R, G, B, and A components of the blend constant that are used in blending.Structure specifying a buffer copy operation.Builds instances of typeVulkanBufferCopy.Structure specifying a buffer copy operation.Information required to create a buffer.Builds instances of typeVulkanBufferCreateInfo.Information required to create a buffer.Structure specifying a buffer ↔ image copy operation.Builds instances of typeVulkanBufferImageCopy.Structure specifying a buffer ↔ image copy operation.Structure specifying the parameters of a buffer memory barrier.Builds instances of typeVulkanBufferMemoryBarrier.Structure specifying the parameters of a buffer memory barrier.Information required to create a buffer.Builds instances of typeVulkanBufferViewCreateInfo.Information required to create a buffer.An exception raised by a failing Vulkan call.Functions to check the return values of Vulkan calls.Structure specifying a clear attachment.Builds instances of typeVulkanClearAttachment.Structure specifying a clear attachment.Structure specifying a clear rectangle.Builds instances of typeVulkanClearRectangle.Structure specifying a clear rectangle.A color consisting of floating-point components.Builds instances of typeVulkanClearValueColorFloatingPoint.A color consisting of signed integer components.Builds instances of typeVulkanClearValueColorIntegerSigned.A color consisting of unsigned integer components.Builds instances of typeVulkanClearValueColorIntegerUnsigned.A depth/stencil value.Builds instances of typeVulkanClearValueDepthStencil.Union specifying a clear value.The actual type of clea value.A color consisting of floating-point components.A color consisting of signed integer components.A color consisting of unsigned integer components.A depth/stencil value.The actual type of clea value.A depth/stencil value.Structure specifying parameters of a command.Builds instances of typeVulkanCommandBufferBeginInfo.Structure specifying parameters of a command.Structure specifying parameters of a newly created command buffer.Builds instances of typeVulkanCommandBufferCreateInfo.Structure specifying parameters of a newly created command buffer.Bitmask specifying usage behavior for command buffer resets.Bitmask specifying usage behavior for command buffer.Bitmask controlling how a command pool is created.Structure specifying parameters of a newly created command pool.Builds instances of typeVulkanCommandPoolCreateInfo.Structure specifying parameters of a newly created command pool.Bitmask controlling how a command pool is trimmed.A structure specifying a color component mapping.Builds instances of typeVulkanComponentMapping.A structure specifying a color component mapping.Specify how a component is swizzled.Structure specifying parameters of a newly created compute pipeline.Builds instances of typeVulkanComputePipelineCreateInfo.Structure specifying parameters of a newly created compute pipeline.the maximum number of local workgroups that can be dispatched by a single dispatch command.Builds instances of typeVulkanComputeWorkGroupCount.the maximum number of local workgroups that can be dispatched by a single dispatch command.the maximum size of a local compute workgroup, per dimension.Builds instances of typeVulkanComputeWorkGroupSize.the maximum size of a local compute workgroup, per dimension.Structure containing the conformance test suite version the implementation is compliant with.Builds instances of typeVulkanCopyDescriptorSet.Debugging operations that can use the functions exposed by extensions such asVK_EXT_debug_utilsinternally.A label color.A debugging region in a command buffer.Bitmask specifying how execution and memory dependencies are formed.Builds instances of typeVulkanDescriptorBufferInfo.Builds instances of typeVulkanDescriptorImageInfo.Flags specifying certain supported operations on a descriptor poolBuilds instances of typeVulkanDescriptorPoolCreateInfo.Builds instances of typeVulkanDescriptorPoolSize.Builds instances of typeVulkanDescriptorSetAllocateInfo.Structure specifying a descriptor set layout binding.Builds instances of typeVulkanDescriptorSetLayoutBinding.Structure specifying a descriptor set layout binding.Flags specifying descriptor set layout properties.Builds instances of typeVulkanDescriptorSetLayoutCreateInfo.A descriptor set layout.Specifies the type of a descriptor in a descriptor set.An exception raised by attempting to call a method on an object that has been closed/destroyed.The flags used to create device queues.The base type of driver identifiers.An unrecognized identifier returned from a driver.Indicate which dynamic state is taken from dynamic state commands.The type of enums with integer values.The type of enums with integer values.Functions over enum ←→ integer maps.Functions to map error codes to humanly readable names.Flags specified when creating events.The type of Vulkan event creation information.Builds instances of typeVulkanEventCreateInfo.The type of Vulkan event creation information.The base type of exceptions raised by the API.An extension.Builds instances of typeVulkanExtensionProperties.An extension.Functions for handling Vulkan extensions.An extension.Structure specifying a two-dimensional extent.Builds instances of typeVulkanExtent2D.Structure specifying a two-dimensional extent.Structure specifying a three-dimensional extent.Builds instances of typeVulkanExtent3D.Structure specifying a three-dimensional extent.An annotation that indicates that external synchronization is required.Flags specified when creating fences.The type of Vulkan fence creation information.Builds instances of typeVulkanFenceCreateInfo.The type of Vulkan fence creation information.A fence represents a GPU to CPU synchronization.Note: This enum is not hand-written: See formats.shThe channels present in a color image.A description of whether a format represents compressed or uncompressed data.The type of data specified by a format.The interpretation of data in a format.Structure specifying image format properties.Builds instances of typeVulkanFormatProperties.Structure specifying image format properties.The space of a format.Bitmask controlling how a framebuffer is created.Structure specifying parameters of a newly created framebuffer.Builds instances of typeVulkanFramebufferCreateInfo.Structure specifying parameters of a newly created framebuffer.Structure specifying parameters of a newly created graphics pipeline.Builds instances of typeVulkanGraphicsPipelineCreateInfo.Structure specifying parameters of a newly created graphics pipeline.The base type of dispatchable Vulkan handles.The base type of non-dispatchable Vulkan handles.The base type of Vulkan handles.Vulkan host allocation functions.Builds instances of typeVulkanHostAllocatorCallbacks.Vulkan host allocation functions.A function to allocate memory.A function to deallocate memory.A function called on internal allocations.A function called on internal allocations.A function to reallocate memory.The type of host allocators.Bitmask specifying which aspects of an image are included in a view.Structure specifying an image blit operation.Builds instances of typeVulkanImageBlit.Structure specifying an image blit operation.Structure specifying an image copy operation.Builds instances of typeVulkanImageCopy.Structure specifying an image copy operation.Flags specified when creating images.Builds instances of typeVulkanImageCreateInfo.Structure specifying image format properties.Builds instances of typeVulkanImageFormatProperties.Structure specifying image format properties.Structure specifying the parameters of an image memory barrier.Builds instances of typeVulkanImageMemoryBarrier.Structure specifying the parameters of an image memory barrier.Structure specifying an image subresource.Builds instances of typeVulkanImageSubresource.Structure specifying a image subresource layers.Builds instances of typeVulkanImageSubresourceLayers.Structure specifying a image subresource layers.Structure specifying a image subresource range.Builds instances of typeVulkanImageSubresourceRange.Structure specifying a image subresource range.Structure specifying an image subresource.The type of Vulkan images.Flags specified when creating image views.The type of Vulkan image view creation information.Builds instances of typeVulkanImageViewCreateInfo.The type of Vulkan image view creation information.The type of image view.The type of Vulkan image views.An exception raised by attempting to use a class that is not compatible with a particular provider implementation.The type of index buffer indices.Information required to create a Vulkan instance.Builds instances of typeVulkanInstanceCreateInfo.Information required to create a Vulkan instance.Info required to configure an extension by instance creation.Functions to provide Vulkan instances.An initialized instance.Allocation type.A description of a layer.Builds instances of typeVulkanLayerProperties.A description of a layer.Functions for handling Vulkan layers.The inclusive range of supported sizes for points.Builds instances of typeVulkanLineWidthRange.The inclusive range of supported sizes for points.Flags specified when creating logical devices.Parameters used to create logical devices.Builds instances of typeVulkanLogicalDeviceCreateInfo.Parameters used to create logical devices.The information required to create a queue on a device.Builds instances of typeVulkanLogicalDeviceQueueCreateInfo.The information required to create a queue on a device.A reference to a logical Vulkan device.The status of an event.The status of an event.The result of fetching data for a pipeline cache.The result of waiting.The logical operations supported by Vulkan are summarized in the following table in which: ¬ is bitwise invert ∧ is bitwise and ∨ is bitwise or ⊕ is bitwise exclusive or s is the fragment’s Rs0, Gs0, Bs0 or As0 component value for the fragment output corresponding to the color attachment being updated d is the color attachment’s R, G, B or A component valueBuilds instances of typeVulkanMappedMemoryRange.A pointer to an area of mapped memory.Builds instances of typeVulkanMemoryAllocateInfo.Structure specifying the parameters of a global memory barrier.Builds instances of typeVulkanMemoryBarrier.Structure specifying the parameters of a global memory barrier.Structure specifying a memory heap.Builds instances of typeVulkanMemoryHeap.The unique index of a memory heap.Structure specifying a memory heap.Flags specified when mapping memory.The properties of a heap.Builds instances of typeVulkanMemoryRequirements.A memory type.Builds instances of typeVulkanMemoryType.The unique index of a memory type.A memory type.An exception raised by one or more required extensions not being present.An exception raised by one or more required extensions not being present.An exception raised by no memory type being available to provide for a specific allocation.Structure specifying a two-dimensional offset.Builds instances of typeVulkanOffset2D.Structure specifying a two-dimensional offset.Structure specifying a three-dimensional offset.Builds instances of typeVulkanOffset3D.Structure specifying a three-dimensional offset.Physical device driver properties.The features supported by a physical device.Builds instances of typeVulkanPhysicalDeviceFeatures.The features supported by a physical device.Builds instances of typeVulkanPhysicalDeviceFeatures10.The features supported by a physical device.The features supported by a physical Vulkan 1.1 device.Builds instances of typeVulkanPhysicalDeviceFeatures11.The features supported by a physical Vulkan 1.1 device.The features supported by a physical Vulkan 1.2 device.Builds instances of typeVulkanPhysicalDeviceFeatures12.The features supported by a physical Vulkan 1.2 device.The features supported by a physical Vulkan 1.3 device.Builds instances of typeVulkanPhysicalDeviceFeatures13.The features supported by a physical Vulkan 1.3 device.Functions over device feature structures.The features supported by a physical device.The ID properties for the device.The limits of a physical device.Builds instances of typeVulkanPhysicalDeviceLimits.The limits of a physical device.The memory properties for a physical device.Builds instances of typeVulkanPhysicalDeviceMemoryProperties.The memory properties for a physical device.The basic properties of a device.Builds instances of typeVulkanPhysicalDeviceProperties.The basic properties of a device.The type of device.A reference to a physical Vulkan device.Specify the bind point of a pipeline object to a command buffer.Flags specified when creating pipeline caches.The type of pipeline cache creation information.Builds instances of typeVulkanPipelineCacheCreateInfo.The type of pipeline cache creation information.Structure specifying a pipeline color blend attachment state.Builds instances of typeVulkanPipelineColorBlendAttachmentState.Structure specifying a pipeline color blend attachment state.Vulkan 1.1 specification: "VkPipelineColorBlendStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Structure specifying parameters of a newly created pipeline color blend state.Builds instances of typeVulkanPipelineColorBlendStateCreateInfo.Structure specifying parameters of a newly created pipeline color blend state.Bitmask controlling how a pipeline is created.Flags specified when creating depth/stencil state.Structure specifying parameters of a newly created pipeline depth stencil state.Builds instances of typeVulkanPipelineDepthStencilStateCreateInfo.Structure specifying parameters of a newly created pipeline depth stencil state.Flags specified when creating dynamic pipeline state.Structure specifying parameters of a newly created pipeline dynamic state.Builds instances of typeVulkanPipelineDynamicStateCreateInfo.Structure specifying parameters of a newly created pipeline dynamic state.Vulkan 1.1 specification: "VkPipelineInputAssemblyStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Builds instances of typeVulkanPipelineInputAssemblyStateCreateInfo.Vulkan 1.1 specification: "VkPipelineLayoutCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Builds instances of typeVulkanPipelineLayoutCreateInfo.Flags specified when creating pipelines.Builds instances of typeVulkanPipelineMultisampleStateCreateInfo.Vulkan 1.1 specification: "VulkanPipelineRasterizationStateCreateFlag is a bitmask type for setting a mask, but is currently reserved for future use."Builds instances of typeVulkanPipelineRasterizationStateCreateInfo.Flags specified when creating pipeline shader stages.Builds instances of typeVulkanPipelineShaderStageCreateInfo.Bitmask specifying pipeline stages.Flags specified when creating pipeline tessellation stages.Structure specifying parameters of a newly created pipeline tessellation state.Builds instances of typeVulkanPipelineTessellationStateCreateInfo.Structure specifying parameters of a newly created pipeline tessellation state.Flags specified when creating pipeline shader stages.Builds instances of typeVulkanPipelineVertexInputStateCreateInfo.Vulkan 1.1 specification: "VkPipelineViewportStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Builds instances of typeVulkanPipelineViewportStateCreateInfo.The inclusive range of supported sizes for points.Builds instances of typeVulkanPointSizeRange.The inclusive range of supported sizes for points.Supported primitive topologies.Structure specifying a push constant range.Builds instances of typeVulkanPushConstantRange.Structure specifying a push constant range.Bitmask specifying constraints on a query.Specify the type of queries managed by a query pool.Bitmask specifying queried pipeline statistics.Vulkan 1.1 specification: "VkQueryPoolCreateFlagBits is a bitmask type for setting a mask, but is currently reserved for future use."Structure specifying parameters of a newly created query pool.Builds instances of typeVulkanQueryPoolCreateInfo.Structure specifying parameters of a newly created query pool.The index of a queue family.The properties of a queue family.Builds instances of typeVulkanQueueFamilyProperties.The properties of a queue family.The queue family property flags.The index of a queue within the queue family to which it belongs.A queue on a logical device.Structure specifying a two-dimensional subregion.Builds instances of typeVulkanRectangle2D.Structure specifying a two-dimensional subregion.Structure specifying how to begin a render pass.Builds instances of typeVulkanRenderPassBeginInfo.Structure specifying how to begin a render pass.Vulkan 1.1 specification: "VkRenderPassCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Structure specifying parameters of a newly created render pass.Builds instances of typeVulkanRenderPassCreateInfo.Structure specifying parameters of a newly created render pass.An exception raised by mishandling a resource.Bitmask specifying sample counts supported for an image used for storage operations.Vulkan 1.1 specification: "VkSamplerCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."Structure specifying how to create a sampler.Builds instances of typeVulkanSamplerCreateInfo.Structure specifying how to create a sampler.Flags specified when creating semaphores.The type of Vulkan semaphore creation information.Builds instances of typeVulkanSemaphoreCreateInfo.The type of Vulkan semaphore creation information.A semaphore represents a GPU to GPU synchronization.Flags specified when creating shader modules.The type of Vulkan image view creation information.Builds instances of typeVulkanShaderModuleCreateInfo.The type of Vulkan image view creation information.The type of shader modules.Builds instances of typeVulkanSpecializationMap.Builds instances of typeVulkanSpecializationMapEntry.Builds instances of typeVulkanStencilOpState.The type of Vulkan submission information.Builds instances of typeVulkanSubmitInfo.The type of Vulkan submission information.Structure specifying a subpass dependency.Builds instances of typeVulkanSubpassDependency.Structure specifying a subpass dependency.Structure specifying a subpass description.Builds instances of typeVulkanSubpassDescription.Flags specified when creating subpasses.Structure specifying a subpass description.Structure specifying subresource layout.Builds instances of typeVulkanSubresourceLayout.Structure specifying subresource layout.Allocation scope.An allocator for temporary, aligned memory.A receiver of allocated memory.A receiver of allocated memory.An exception type used to temporarily wrap exceptions in an unchecked wrapper (for use in streams and the like).Functions involving vendor IDs.A Vulkan API version consisting of a major, minor, and patch component.Builds instances of typeVulkanVersion.Functions for encoding and decoding Vulkan version numbers.A Vulkan API version consisting of a major, minor, and patch component.Structure specifying vertex input attribute description.Builds instances of typeVulkanVertexInputAttributeDescription.Structure specifying vertex input attribute description.Structure specifying vertex input binding description.Builds instances of typeVulkanVertexInputBindingDescription.Structure specifying vertex input binding description.Structure specifying a viewport.Builds instances of typeVulkanViewport.The inclusive range that the corners of a viewport must be contained in.Builds instances of typeVulkanViewportBoundsRange.The inclusive range that the corners of a viewport must be contained in.The maximum viewport dimensions in the X (width) and Y (height) dimensions, respectively.Builds instances of typeVulkanViewportDimensions.The maximum viewport dimensions in the X (width) and Y (height) dimensions, respectively.Structure specifying a viewport.Builds instances of typeVulkanWriteDescriptorSet.