Vulkan.Core10.OtherTypes

datadata PipelineCacheHeaderVersionOne

VkPipelineCacheHeaderVersionOne - Structure describing the layout of the pipeline cache header

Description

Unlike most structures declared by the Vulkan API, all fields of this structure are written with the least significant byte first, regardless of host byte-order.

The C language specification does not define the packing of structure members. This layout assumes tight structure member packing, with members laid out in the order listed in the structure, and the intended size of the structure is 32 bytes. If a compiler produces code that diverges from that pattern, applications must employ another method to set values at the correct offsets.

Valid Usage (Implicit)

Constructors

PipelineCacheHeaderVersionOne
- headerSize :: Word32
  headerSize is the length in bytes of the pipeline cache header.
  headerSize must be 32
  headerSize must not exceed the size of the pipeline cache
- headerVersion :: PipelineCacheHeaderVersion
  headerVersion is a PipelineCacheHeaderVersion value specifying the version of the header. A consumer of the pipeline cache should use the cache version to interpret the remainder of the cache header. headerVersion must be written as exactly 4 bytes.
  headerVersion must be PIPELINE_CACHE_HEADER_VERSION_ONE
  headerVersion must be a valid PipelineCacheHeaderVersion value
- vendorID :: Word32
  vendorID is the PhysicalDeviceProperties::vendorID of the implementation.
- deviceID :: Word32
  deviceID is the PhysicalDeviceProperties::deviceID of the implementation.
- pipelineCacheUUID :: ByteString
  pipelineCacheUUID is the PhysicalDeviceProperties::pipelineCacheUUID of the implementation.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show PipelineCacheHeaderVersionOneDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Storable PipelineCacheHeaderVersionOneDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
FromCStruct PipelineCacheHeaderVersionOneDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
ToCStruct PipelineCacheHeaderVersionOneDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Zero PipelineCacheHeaderVersionOneDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes

datadata DrawIndirectCommand

#

VkDrawIndirectCommand - Structure specifying an indirect drawing command

Description

The members of DrawIndirectCommand have the same meaning as the similarly named parameters of cmdDraw.

Valid Usage

If the bound graphics pipeline state was created with PipelineVertexInputDivisorStateCreateInfo in the pNext chain of GraphicsPipelineCreateInfo::pVertexInputState, any member of PipelineVertexInputDivisorStateCreateInfo::pVertexBindingDivisors has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0

If shader objects are used for drawing or the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, any member of the pVertexBindingDescriptions parameter to the cmdSetVertexInputEXT call that sets this dynamic state has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0
If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

Constructors

DrawIndirectCommand
- vertexCount :: Word32
  vertexCount is the number of vertices to draw.
- instanceCount :: Word32
  instanceCount is the number of instances to draw.
- firstVertex :: Word32
  firstVertex is the index of the first vertex to draw.
- firstInstance :: Word32
  firstInstance is the instance ID of the first instance to draw.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Show DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Storable DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
FromCStruct DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
ToCStruct DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Zero DrawIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes

datadata DrawIndexedIndirectCommand

#

VkDrawIndexedIndirectCommand - Structure specifying an indexed indirect drawing command

Description

The members of DrawIndexedIndirectCommand have the same meaning as the similarly named parameters of cmdDrawIndexed.

Valid Usage

If the bound graphics pipeline state was created with PipelineVertexInputDivisorStateCreateInfo in the pNext chain of GraphicsPipelineCreateInfo::pVertexInputState, any member of PipelineVertexInputDivisorStateCreateInfo::pVertexBindingDivisors has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0

If shader objects are used for drawing or the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, any member of the pVertexBindingDescriptions parameter to the cmdSetVertexInputEXT call that sets this dynamic state has a value other than 1 in divisor, and PhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0
If the robustBufferAccess2 feature is not enabled, (indexSize × (firstIndex + indexCount)) must be less than or equal to the size of the bound index buffer range, with indexSize being based on the type specified by indexType, and the other parameters sourced from this command
If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

Constructors

DrawIndexedIndirectCommand
- indexCount :: Word32
  indexCount is the number of vertices to draw.
- instanceCount :: Word32
  instanceCount is the number of instances to draw.
- firstIndex :: Word32
  firstIndex is the base index within the index buffer.
- vertexOffset :: Int32
  vertexOffset is the value added to the vertex index before indexing into the vertex buffer.
- firstInstance :: Word32
  firstInstance is the instance ID of the first instance to draw.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Show DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Storable DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
FromCStruct DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
ToCStruct DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Zero DrawIndexedIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes

datadata DispatchIndirectCommand

#

VkDispatchIndirectCommand - Structure specifying an indirect dispatching command

Description

The members of DispatchIndirectCommand have the same meaning as the corresponding parameters of cmdDispatch.

Valid Usage

Constructors

DispatchIndirectCommand
- x :: Word32
  x is the number of local workgroups to dispatch in the X dimension.
  x must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[0]
- y :: Word32
  y is the number of local workgroups to dispatch in the Y dimension.
  y must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[1]
- z :: Word32
  z is the number of local workgroups to dispatch in the Z dimension.
  z must be less than or equal to PhysicalDeviceLimits::maxComputeWorkGroupCount[2]

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Show DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Storable DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
FromCStruct DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
ToCStruct DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes
Zero DispatchIndirectCommandDefined in vulkan-3.27 · Vulkan.Core10.OtherTypes

datadata BaseOutStructure

#

VkBaseOutStructure - Base structure for a read-only pointer chain

Description

BaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

Constructors

BaseOutStructure
- sType :: StructureType
  sType is the structure type of the structure being iterated through.
- next :: Ptr BaseOutStructure
  pNext is NULL or a pointer to the next structure in a structure chain.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Show BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Storable BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
FromCStruct BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
ToCStruct BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Zero BaseOutStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends

datadata BaseInStructure

#

VkBaseInStructure - Base structure for a read-only pointer chain

Description

BaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

Constructors

BaseInStructure
- sType :: StructureType
  sType is the structure type of the structure being iterated through.
- next :: Ptr BaseInStructure
  pNext is NULL or a pointer to the next structure in a structure chain.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Show BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Storable BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
FromCStruct BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
ToCStruct BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends
Zero BaseInStructureDefined in vulkan-3.27 · Vulkan.CStruct.Extends

newtypenewtype PipelineCacheHeaderVersion

#

VkPipelineCacheHeaderVersion - Encode pipeline cache version

Description

PIPELINE_CACHE_HEADER_VERSION_ONE specifies version one of the pipeline cache, described by PipelineCacheHeaderVersionOne.

PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM specifies a pipeline cache for offline built data graph models, described by PipelineCacheHeaderVersionDataGraphQCOM.

Constructors

PipelineCacheHeaderVersion Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion
Ord PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion
Read PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion
Show PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion
Storable PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion
Zero PipelineCacheHeaderVersionDefined in vulkan-3.27 · Vulkan.Core10.Enums.PipelineCacheHeaderVersion

patternpattern PIPELINE_CACHE_HEADER_VERSION_DATA_GRAPH_QCOM :: PipelineCacheHeaderVersion

#

patternpattern PIPELINE_CACHE_HEADER_VERSION_ONE :: PipelineCacheHeaderVersion

#

patternpattern PIPELINE_CACHE_HEADER_VERSION_SAFETY_CRITICAL_ONE :: PipelineCacheHeaderVersion

#

newtypenewtype ObjectType

#

VkObjectType - Specify an enumeration to track object handle types

Description

'

ObjectType	Vulkan Handle Type
OBJECT_TYPE_UNKNOWN	Unknown/Undefined Handle
OBJECT_TYPE_INSTANCE	Instance
OBJECT_TYPE_PHYSICAL_DEVICE	PhysicalDevice
OBJECT_TYPE_DEVICE	Device
OBJECT_TYPE_QUEUE	Queue
OBJECT_TYPE_SEMAPHORE	Semaphore
OBJECT_TYPE_COMMAND_BUFFER	CommandBuffer
OBJECT_TYPE_FENCE	Fence
OBJECT_TYPE_DEVICE_MEMORY	DeviceMemory
OBJECT_TYPE_BUFFER	Buffer
OBJECT_TYPE_IMAGE	Image
OBJECT_TYPE_EVENT	Event
OBJECT_TYPE_QUERY_POOL	QueryPool
OBJECT_TYPE_BUFFER_VIEW	BufferView
OBJECT_TYPE_IMAGE_VIEW	ImageView
OBJECT_TYPE_SHADER_MODULE	ShaderModule
OBJECT_TYPE_PIPELINE_CACHE	PipelineCache
OBJECT_TYPE_PIPELINE_LAYOUT	PipelineLayout
OBJECT_TYPE_RENDER_PASS	RenderPass
OBJECT_TYPE_PIPELINE	Pipeline
OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT	DescriptorSetLayout
OBJECT_TYPE_SAMPLER	Sampler
OBJECT_TYPE_DESCRIPTOR_POOL	DescriptorPool
OBJECT_TYPE_DESCRIPTOR_SET	DescriptorSet
OBJECT_TYPE_FRAMEBUFFER	Framebuffer
OBJECT_TYPE_COMMAND_POOL	CommandPool
OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION	SamplerYcbcrConversion
OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE	DescriptorUpdateTemplate
OBJECT_TYPE_PRIVATE_DATA_SLOT	PrivateDataSlot
OBJECT_TYPE_SURFACE_KHR	SurfaceKHR
OBJECT_TYPE_SWAPCHAIN_KHR	SwapchainKHR
OBJECT_TYPE_DISPLAY_KHR	DisplayKHR
OBJECT_TYPE_DISPLAY_MODE_KHR	DisplayModeKHR
OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT	DebugReportCallbackEXT
VK_OBJECT_TYPE_VIDEO_SESSION_KHR	VkVideoSessionKHR
VK_OBJECT_TYPE_VIDEO_SESSION_PARAMETERS_KHR	VkVideoSessionParametersKHR
OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT	DebugUtilsMessengerEXT
OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR	AccelerationStructureKHR
OBJECT_TYPE_VALIDATION_CACHE_EXT	ValidationCacheEXT
OBJECT_TYPE_ACCELERATION_STRUCTURE_NV	AccelerationStructureNV
OBJECT_TYPE_PERFORMANCE_CONFIGURATION_INTEL	PerformanceConfigurationINTEL
OBJECT_TYPE_DEFERRED_OPERATION_KHR	DeferredOperationKHR
OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NV	IndirectCommandsLayoutNV
OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_EXT	IndirectCommandsLayoutEXT
OBJECT_TYPE_INDIRECT_EXECUTION_SET_EXT	IndirectExecutionSetEXT
OBJECT_TYPE_BUFFER_COLLECTION_FUCHSIA	BufferCollectionFUCHSIA
OBJECT_TYPE_MICROMAP_EXT	MicromapEXT
OBJECT_TYPE_OPTICAL_FLOW_SESSION_NV	OpticalFlowSessionNV
OBJECT_TYPE_SHADER_EXT	ShaderEXT
OBJECT_TYPE_TENSOR_ARM	TensorARM
OBJECT_TYPE_TENSOR_VIEW_ARM	TensorViewARM
OBJECT_TYPE_DATA_GRAPH_PIPELINE_SESSION_ARM	DataGraphPipelineSessionARM

ObjectType and Vulkan Handle Relationship

Constructors

ObjectType Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType
Ord ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType
Read ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType
Show ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType
Storable ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType
Zero ObjectTypeDefined in vulkan-3.27 · Vulkan.Core10.Enums.ObjectType

patternpattern OBJECT_TYPE_ACCELERATION_STRUCTURE_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_ACCELERATION_STRUCTURE_NV :: ObjectType

#

patternpattern OBJECT_TYPE_BUFFER :: ObjectType

#

patternpattern OBJECT_TYPE_BUFFER_COLLECTION_FUCHSIA :: ObjectType

#

patternpattern OBJECT_TYPE_BUFFER_VIEW :: ObjectType

#

patternpattern OBJECT_TYPE_COMMAND_BUFFER :: ObjectType

#

patternpattern OBJECT_TYPE_COMMAND_POOL :: ObjectType

#

patternpattern OBJECT_TYPE_CUDA_FUNCTION_NV :: ObjectType

#

patternpattern OBJECT_TYPE_CUDA_MODULE_NV :: ObjectType

#

patternpattern OBJECT_TYPE_CU_FUNCTION_NVX :: ObjectType

#

patternpattern OBJECT_TYPE_CU_MODULE_NVX :: ObjectType

#

patternpattern OBJECT_TYPE_DATA_GRAPH_PIPELINE_SESSION_ARM :: ObjectType

#

patternpattern OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_DEFERRED_OPERATION_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_DESCRIPTOR_POOL :: ObjectType

#

patternpattern OBJECT_TYPE_DESCRIPTOR_SET :: ObjectType

#

patternpattern OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT :: ObjectType

#

patternpattern OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE :: ObjectType

#

patternpattern OBJECT_TYPE_DEVICE :: ObjectType

#

patternpattern OBJECT_TYPE_DEVICE_MEMORY :: ObjectType

#

patternpattern OBJECT_TYPE_DISPLAY_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_DISPLAY_MODE_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_EVENT :: ObjectType

#

patternpattern OBJECT_TYPE_EXTERNAL_COMPUTE_QUEUE_NV :: ObjectType

#

patternpattern OBJECT_TYPE_FENCE :: ObjectType

#

patternpattern OBJECT_TYPE_FRAMEBUFFER :: ObjectType

#

patternpattern OBJECT_TYPE_GPA_SESSION_AMD :: ObjectType

#

patternpattern OBJECT_TYPE_IMAGE :: ObjectType

#

patternpattern OBJECT_TYPE_IMAGE_VIEW :: ObjectType

#

patternpattern OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NV :: ObjectType

#

patternpattern OBJECT_TYPE_INDIRECT_EXECUTION_SET_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_INSTANCE :: ObjectType

#

patternpattern OBJECT_TYPE_MICROMAP_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_OPTICAL_FLOW_SESSION_NV :: ObjectType

#

patternpattern OBJECT_TYPE_PERFORMANCE_CONFIGURATION_INTEL :: ObjectType

#

patternpattern OBJECT_TYPE_PHYSICAL_DEVICE :: ObjectType

#

patternpattern OBJECT_TYPE_PIPELINE :: ObjectType

#

patternpattern OBJECT_TYPE_PIPELINE_BINARY_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_PIPELINE_CACHE :: ObjectType

#

patternpattern OBJECT_TYPE_PIPELINE_LAYOUT :: ObjectType

#

patternpattern OBJECT_TYPE_PRIVATE_DATA_SLOT :: ObjectType

#

patternpattern OBJECT_TYPE_QUERY_POOL :: ObjectType

#

patternpattern OBJECT_TYPE_QUEUE :: ObjectType

#

patternpattern OBJECT_TYPE_RENDER_PASS :: ObjectType

#

patternpattern OBJECT_TYPE_SAMPLER :: ObjectType

#

patternpattern OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION :: ObjectType

#

patternpattern OBJECT_TYPE_SEMAPHORE :: ObjectType

#

patternpattern OBJECT_TYPE_SHADER_EXT :: ObjectType

#

patternpattern OBJECT_TYPE_SHADER_INSTRUMENTATION_ARM :: ObjectType

#

patternpattern OBJECT_TYPE_SHADER_MODULE :: ObjectType

#

patternpattern OBJECT_TYPE_SURFACE_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_SWAPCHAIN_KHR :: ObjectType

#

patternpattern OBJECT_TYPE_TENSOR_ARM :: ObjectType

#

patternpattern OBJECT_TYPE_TENSOR_VIEW_ARM :: ObjectType

#

patternpattern OBJECT_TYPE_UNKNOWN :: ObjectType

#

patternpattern OBJECT_TYPE_VALIDATION_CACHE_EXT :: ObjectType

#

newtypenewtype VendorId

#

VkVendorId - Khronos vendor IDs

Description

Khronos vendor IDs may be allocated by vendors at any time. Only the latest canonical versions of this Specification, of the corresponding vk.xml API Registry, and of the corresponding vulkan_core.h header file must contain all reserved Khronos vendor IDs.

Only Khronos vendor IDs are given symbolic names at present. PCI vendor IDs returned by the implementation can be looked up in the PCI-SIG database.