Module com.io7m.jcoronado.api
Package com.io7m.jcoronado.api
Type-safe Vulkan frontend (API)
-
Interface Summary Interface Description VulkanApplicationInfoType A description of the application that is using Vulkan.VulkanAttachmentDescriptionType Structure specifying an attachment descriptionVulkanAttachmentReferenceType Structure specifying an attachment reference.VulkanBlendConstantsType The R, G, B, and A components of the blend constant that are used in blending.VulkanBufferCopyType Structure specifying a buffer copy operation.VulkanBufferCreateInfoType Information required to create a buffer.VulkanBufferImageCopyType Structure specifying a buffer ↔ image copy operation.VulkanBufferMemoryBarrierType Structure specifying the parameters of a buffer memory barrier.VulkanBufferType VulkanBufferViewCreateInfoType Information required to create a buffer.VulkanBufferViewType VulkanClearAttachmentType Structure specifying a clear attachment.VulkanClearRectangleType Structure specifying a clear rectangle.VulkanClearValueType Union specifying a clear value.VulkanClearValueType.VulkanClearValueColorFloatingPointType A color consisting of floating-point components.VulkanClearValueType.VulkanClearValueColorIntegerSignedType A color consisting of signed integer components.VulkanClearValueType.VulkanClearValueColorIntegerUnsignedType A color consisting of unsigned integer components.VulkanClearValueType.VulkanClearValueColorType A depth/stencil value.VulkanClearValueType.VulkanClearValueDepthStencilType A depth/stencil value.VulkanCommandBufferBeginInfoType Structure specifying parameters of a command.VulkanCommandBufferCreateInfoType Structure specifying parameters of a newly created command buffer.VulkanCommandBufferType VulkanCommandPoolCreateInfoType Structure specifying parameters of a newly created command pool.VulkanCommandPoolType VulkanComponentMappingType A structure specifying a color component mapping.VulkanComputePipelineCreateInfoType Structure specifying parameters of a newly created compute pipeline.VulkanComputeWorkGroupCountType the maximum number of local workgroups that can be dispatched by a single dispatch command.VulkanComputeWorkGroupSizeType the maximum size of a local compute workgroup, per dimension.VulkanCopyDescriptorSetType VulkanDescriptorBufferInfoType VulkanDescriptorImageInfoType VulkanDescriptorPoolCreateInfoType VulkanDescriptorPoolSizeType VulkanDescriptorPoolType VulkanDescriptorSetAllocateInfoType VulkanDescriptorSetLayoutBindingType Structure specifying a descriptor set layout binding.VulkanDescriptorSetLayoutCreateInfoType VulkanDescriptorSetLayoutType A descriptor set layout.VulkanDescriptorSetType VulkanDescriptorUpdateTemplateType VulkanDeviceMemoryType VulkanDeviceType VulkanEnumBitmaskType The type of enums with integer values.VulkanEnumIntegerType The type of enums with integer values.VulkanEventCreateInfoType The type of Vulkan event creation information.VulkanEventType VulkanExtensionPropertiesType An extension.VulkanExtensionType An extension.VulkanExtent2DType Structure specifying a two-dimensional extent.VulkanExtent3DType Structure specifying a three-dimensional extent.VulkanFenceCreateInfoType The type of Vulkan fence creation information.VulkanFenceType A fence represents a GPU to CPU synchronization.VulkanFormatPropertiesType Structure specifying image format properties.VulkanFramebufferCreateInfoType Structure specifying parameters of a newly created framebuffer.VulkanFramebufferType VulkanGraphicsPipelineCreateInfoType Structure specifying parameters of a newly created graphics pipeline.VulkanHandleDispatchableType The base type of dispatchable Vulkan handles.VulkanHandleNonDispatchableType The base type of non-dispatchable Vulkan handles.VulkanHandleType The base type of Vulkan handles.VulkanHostAllocatorCallbacksType Vulkan host allocation functions.VulkanHostAllocatorCallbacksType.AllocationFunctionType A function to allocate memory.VulkanHostAllocatorCallbacksType.DeallocationFunctionType A function to deallocate memory.VulkanHostAllocatorCallbacksType.InternalAllocationNotificationType A function called on internal allocations.VulkanHostAllocatorCallbacksType.InternalFreeNotificationType A function called on internal allocations.VulkanHostAllocatorCallbacksType.ReallocationFunctionType A function to reallocate memory.VulkanHostAllocatorType The type of host allocators.VulkanImageBlitType Structure specifying an image blit operation.VulkanImageCopyType Structure specifying an image copy operation.VulkanImageCreateInfoType VulkanImageFormatPropertiesType Structure specifying image format properties.VulkanImageMemoryBarrierType Structure specifying the parameters of an image memory barrier.VulkanImageSubresourceLayersType Structure specifying a image subresource layers.VulkanImageSubresourceRangeType Structure specifying a image subresource range.VulkanImageSubresourceType Structure specifying an image subresource.VulkanImageType The type of Vulkan images.VulkanImageViewCreateInfoType The type of Vulkan image view creation information.VulkanImageViewType The type of Vulkan image views.VulkanInstanceCreateInfoType Information required to create a Vulkan instance.VulkanInstanceProviderType Functions to provide Vulkan instances.VulkanInstanceType An initialized instance.VulkanLayerPropertiesType A description of a layer.VulkanLineWidthRangeType The inclusive range of supported sizes for points.VulkanLogicalDeviceCreateInfoType Parameters used to create logical devices.VulkanLogicalDeviceQueueCreateInfoType The information required to create a queue on a device.VulkanLogicalDeviceType A reference to a logical Vulkan device.VulkanMappedMemoryRangeType VulkanMappedMemoryType A pointer to an area of mapped memory.VulkanMemoryAllocateInfoType VulkanMemoryBarrierType Structure specifying the parameters of a global memory barrier.VulkanMemoryHeapType Structure specifying a memory heap.VulkanMemoryRequirementsType VulkanMemoryTypeType The type of a heap.VulkanOffset2DType Structure specifying a two-dimensional offset.VulkanOffset3DType Structure specifying a three-dimensional offset.VulkanPhysicalDeviceFeaturesType The features supported by a physical device.VulkanPhysicalDeviceLimitsType The limits of a physical device.VulkanPhysicalDeviceMemoryPropertiesType The memory properties for a physical device.VulkanPhysicalDevicePropertiesType The basic properties of a device.VulkanPhysicalDeviceType A reference to a physical Vulkan device.VulkanPipelineCacheCreateInfoType The type of pipeline cache creation information.VulkanPipelineCacheType VulkanPipelineColorBlendAttachmentStateType Structure specifying a pipeline color blend attachment state.VulkanPipelineColorBlendStateCreateInfoType Structure specifying parameters of a newly created pipeline color blend state.VulkanPipelineDepthStencilStateCreateInfoType Structure specifying parameters of a newly created pipeline depth stencil state.VulkanPipelineDynamicStateCreateInfoType Structure specifying parameters of a newly created pipeline dynamic state.VulkanPipelineInputAssemblyStateCreateInfoType VulkanPipelineLayoutCreateInfoType VulkanPipelineLayoutType VulkanPipelineMultisampleStateCreateInfoType VulkanPipelineRasterizationStateCreateInfoType VulkanPipelineShaderStageCreateInfoType VulkanPipelineTessellationStateCreateInfoType Structure specifying parameters of a newly created pipeline tessellation state.VulkanPipelineType VulkanPipelineVertexInputStateCreateInfoType VulkanPipelineViewportStateCreateInfoType VulkanPointSizeRangeType The inclusive range of supported sizes for points.VulkanPushConstantRangeType Structure specifying a push constant range.VulkanQueryPoolCreateInfoType Structure specifying parameters of a newly created query pool.VulkanQueryPoolType VulkanQueueFamilyPropertiesType The properties of a queue family.VulkanQueueType A queue on a logical device.VulkanRectangle2DType Structure specifying a two-dimensional subregion.VulkanRenderPassBeginInfoType Structure specifying how to begin a render pass.VulkanRenderPassCreateInfoType Structure specifying parameters of a newly created render pass.VulkanRenderPassType VulkanSamplerCreateInfoType Structure specifying how to create a sampler.VulkanSamplerType VulkanSamplerYcbcrConversionType VulkanSemaphoreCreateInfoType The type of Vulkan semaphore creation information.VulkanSemaphoreType A semaphore represents a GPU to GPU synchronization.VulkanShaderModuleCreateInfoType The type of Vulkan image view creation information.VulkanShaderModuleType The type of shader modules.VulkanSpecializationMapEntryType VulkanSpecializationMapType VulkanStencilOpStateType VulkanSubmitInfoType The type of Vulkan submission information.VulkanSubpassDependencyType Structure specifying a subpass dependency.VulkanSubpassDescriptionType Structure specifying a subpass description.VulkanSubresourceLayoutType Structure specifying subresource layout.VulkanTemporaryAllocatorType An allocator for temporary, aligned memory.VulkanTemporaryAllocatorType.ByteBufferMemoryReceiverType<T,E extends java.lang.Exception> A receiver of allocated memory.VulkanTemporaryAllocatorType.RawMemoryReceiverType<T,E extends java.lang.Exception> A receiver of allocated memory.VulkanVersionType A Vulkan API version consisting of a major, minor, and patch component.VulkanVertexInputAttributeDescriptionType Structure specifying vertex input attribute description.VulkanVertexInputBindingDescriptionType Structure specifying vertex input binding description.VulkanViewportBoundsRangeType The inclusive range that the corners of a viewport must be contained in.VulkanViewportDimensionsType The maximum viewport dimensions in the X (width) and Y (height) dimensions, respectively.VulkanViewportType Structure specifying a viewport.VulkanWriteDescriptorSetType -
Enum Summary Enum Description VulkanAccessFlag Bitmask specifying memory access types that will participate in a memory dependency.VulkanAttachmentDescriptionFlag VulkanAttachmentLoadOp VulkanAttachmentStoreOp VulkanBlendFactor VulkanBlendOp VulkanBorderColor VulkanBufferCreateFlag VulkanBufferUsageFlag VulkanBufferViewCreateFlag VulkanClearValueType.Type The actual type of clea value.VulkanClearValueType.VulkanClearValueColorType.ColorType The actual type of clea value.VulkanColorComponentFlag VulkanCommandBufferLevel VulkanCommandBufferUsageFlag Bitmask specifying usage behavior for command buffer.VulkanCommandPoolCreateFlag Bitmask controlling how a command pool is created.VulkanCommandPoolResetFlag VulkanCommandPoolTrimFlag Bitmask controlling how a command pool is trimmed.VulkanCompareOp VulkanComponentSwizzle Specify how a component is swizzled.VulkanCullModeFlag VulkanDependencyFlag Bitmask specifying how execution and memory dependencies are formed.VulkanDescriptorPoolCreateFlag Flags specifying certain supported operations on a descriptor poolVulkanDescriptorPoolResetFlag VulkanDescriptorSetLayoutCreateFlag Flags specifying descriptor set layout properties.VulkanDescriptorType Specifies the type of a descriptor in a descriptor set.VulkanDeviceQueueCreationFlag The flags used to create device queues.VulkanDynamicState Indicate which dynamic state is taken from dynamic state commands.VulkanEventCreateFlag Flags specified when creating events.VulkanFenceCreateFlag Flags specified when creating fences.VulkanFilter VulkanFormat Note: This enum is not hand-written: See formats.shVulkanFormatFeatureFlag VulkanFramebufferCreateFlag Bitmask controlling how a framebuffer is created.VulkanFrontFace VulkanImageAspectFlag Bitmask specifying which aspects of an image are included in a view.VulkanImageCreateFlag Flags specified when creating images.VulkanImageKind VulkanImageLayout VulkanImageTiling VulkanImageUsageFlag VulkanImageViewCreateFlag Flags specified when creating image views.VulkanImageViewKind The type of image view.VulkanIndexType The type of index buffer indices.VulkanInternalAllocation Allocation type.VulkanLogicalDeviceCreateFlag Flags specified when creating logical devices.VulkanLogicalDeviceType.VulkanEventStatus The status of an event.VulkanLogicalDeviceType.VulkanFenceStatus The status of an event.VulkanLogicalDeviceType.VulkanPipelineCacheDataResult The result of fetching data for a pipeline cache.VulkanLogicalDeviceType.VulkanWaitStatus The result of waiting.VulkanLogicOp 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 valueVulkanMemoryHeapFlag VulkanMemoryMapFlag Flags specified when mapping memory.VulkanMemoryPropertyFlag The properties of a heap.VulkanPhysicalDevicePropertiesType.Type The type of device.VulkanPipelineBindPoint Specify the bind point of a pipeline object to a command buffer.VulkanPipelineCacheCreateFlag Flags specified when creating pipeline caches.VulkanPipelineColorBlendStateCreateFlag Vulkan 1.1 specification: "VkPipelineColorBlendStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanPipelineCreateFlag Bitmask controlling how a pipeline is created.VulkanPipelineDepthStencilStateCreateFlag Flags specified when creating depth/stencil state.VulkanPipelineDynamicStateCreateFlag Flags specified when creating dynamic pipeline state.VulkanPipelineInputAssemblyStateCreateFlag Vulkan 1.1 specification: "VkPipelineInputAssemblyStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanPipelineLayoutCreateFlag Vulkan 1.1 specification: "VkPipelineLayoutCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanPipelineMultisampleStateCreateFlag Flags specified when creating pipelines.VulkanPipelineRasterizationStateCreateFlag Vulkan 1.1 specification: "VulkanPipelineRasterizationStateCreateFlag is a bitmask type for setting a mask, but is currently reserved for future use."VulkanPipelineShaderStageCreateFlag Flags specified when creating pipeline shader stages.VulkanPipelineStageFlag Bitmask specifying pipeline stages.VulkanPipelineTessellationStageCreateFlag Flags specified when creating pipeline tessellation stages.VulkanPipelineVertexInputStateCreateFlag Flags specified when creating pipeline shader stages.VulkanPipelineViewportStateCreateFlag Vulkan 1.1 specification: "VkPipelineViewportStateCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanPolygonMode VulkanPrimitiveTopology Supported primitive topologies.VulkanQueryControlFlag Bitmask specifying constraints on a query.VulkanQueryKind Specify the type of queries managed by a query pool.VulkanQueryPipelineStatisticFlag Bitmask specifying queried pipeline statistics.VulkanQueryPoolCreateFlag Vulkan 1.1 specification: "VkQueryPoolCreateFlagBits is a bitmask type for setting a mask, but is currently reserved for future use."VulkanQueueFamilyPropertyFlag The queue family property flags.VulkanRenderPassCreateFlag Vulkan 1.1 specification: "VkRenderPassCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanSampleCountFlag Bitmask specifying sample counts supported for an image used for storage operations.VulkanSamplerAddressMode VulkanSamplerCreateFlag Vulkan 1.1 specification: "VkSamplerCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use."VulkanSamplerMipmapMode VulkanSemaphoreCreateFlag Flags specified when creating semaphores.VulkanShaderModuleCreateFlag Flags specified when creating shader modules.VulkanShaderStageFlag VulkanSharingMode VulkanStencilFaceFlag VulkanStencilOp VulkanSubpassContents VulkanSubpassDescriptionFlag Flags specified when creating subpasses.VulkanSystemAllocationScope Allocation scope.VulkanVertexInputRate -
Exception Summary Exception Description VulkanAllocationFailedException An exception raised by a memory allocation failure.VulkanCallFailedException An exception raised by a failing Vulkan call.VulkanDestroyedException An exception raised by attempting to call a method on an object that has been closed/destroyed.VulkanException The base type of exceptions raised by the API.VulkanIncompatibleClassException An exception raised by attempting to use a class that is not compatible with a particular provider implementation.VulkanMissingRequiredExtensionsException An exception raised by one or more required extensions not being present.VulkanMissingRequiredLayersException An exception raised by one or more required extensions not being present.VulkanMissingRequiredMemoryTypeException An exception raised by no memory type being available to provide for a specific allocation.VulkanResourceException An exception raised by mishandling a resource.VulkanUncheckedException An exception type used to temporarily wrap exceptions in an unchecked wrapper (for use in streams and the like). -
Annotation Types Summary Annotation Type Description VulkanAPIDeviceFeatureRequiredType An annotation that indicates that a device feature is required to use a particular method.VulkanAPIDeviceFeaturesRequiredType A set ofVulkanAPIDeviceFeatureRequiredType
values.VulkanAPIEnumType An annotation that indicates the original C API enum to which the annotated class is analogous.VulkanAPIFunctionsType A set ofVulkanAPIFunctionType
values.VulkanAPIFunctionType An annotation that indicates the original C API function to which the annotated method is analogous.VulkanAPIStructType An annotation that indicates the original C API struct to which the annotated class is analogous.VulkanExternallySynchronizedType An annotation that indicates that external synchronization is required.