Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Name

VK_KHR_pipeline_executable_properties - device extension

VK_KHR_pipeline_executable_properties

Name String

VK_KHR_pipeline_executable_properties

Extension Type

Device extension

Registered Extension Number

270

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Special Use

• Developer tools

Contact

• Jason Ekstrand https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_pipeline_executable_properties:%20&body=@jekstrand%20

Other Extension Metadata

Last Modified Date

2019-05-28

IP Status

No known IP claims.

Interactions and External Dependencies; Contributors

• Jason Ekstrand, Intel
• Ian Romanick, Intel
• Kenneth Graunke, Intel
• Baldur Karlsson, Valve
• Jesse Hall, Google
• Jeff Bolz, Nvidia
• Piers Daniel, Nvidia
• Tobias Hector, AMD
• Jan-Harald Fredriksen, ARM
• Tom Olson, ARM
• Daniel Koch, Nvidia
• Spencer Fricke, Samsung

Description

When a pipeline is created, its state and shaders are compiled into zero or more device-specific executables, which are used when executing commands against that pipeline. This extension adds a mechanism to query properties and statistics about the different executables produced by the pipeline compilation process. This is intended to be used by debugging and performance tools to allow them to provide more detailed information to the user. Certain compile-time shader statistics provided through this extension may be useful to developers for debugging or performance analysis.

New Commands

• getPipelineExecutableInternalRepresentationsKHR

• getPipelineExecutablePropertiesKHR
• getPipelineExecutableStatisticsKHR

New Structures

• PipelineExecutableInfoKHR

• PipelineExecutableInternalRepresentationKHR
• PipelineExecutablePropertiesKHR
• PipelineExecutableStatisticKHR
• PipelineInfoKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

New Unions

• PipelineExecutableStatisticValueKHR

New Enums

• PipelineExecutableStatisticFormatKHR

New Enum Constants

• KHR_PIPELINE_EXECUTABLE_PROPERTIES_EXTENSION_NAME

• KHR_PIPELINE_EXECUTABLE_PROPERTIES_SPEC_VERSION

• Extending PipelineCreateFlagBits:

  • PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR
  • PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
  • STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
  • STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR
  • STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
  • STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
  • STRUCTURE_TYPE_PIPELINE_INFO_KHR

Issues

1) What should we call the pieces of the pipeline which are produced by the compilation process and about which you can query properties and statistics?

RESOLVED: Call them "executables". The name "binary" was used in early drafts of the extension but it was determined that "pipeline binary" could have a fairly broad meaning (such as a binary serialized form of an entire pipeline) and was too big of a namespace for the very specific needs of this extension.

Version History

• Revision 1, 2019-05-28 (Jason Ekstrand)

  • Initial draft

See Also

PhysicalDevicePipelineExecutablePropertiesFeaturesKHR, PipelineExecutableInfoKHR, PipelineExecutableInternalRepresentationKHR, PipelineExecutablePropertiesKHR, PipelineExecutableStatisticFormatKHR, PipelineExecutableStatisticKHR, PipelineExecutableStatisticValueKHR, PipelineInfoKHR, getPipelineExecutableInternalRepresentationsKHR, getPipelineExecutablePropertiesKHR, getPipelineExecutableStatisticsKHR

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getPipelineExecutablePropertiesKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the device that created the pipeline.

-> PipelineInfoKHR

pPipelineInfo describes the pipeline being queried.

-> io (Result, "properties" ::: Vector PipelineExecutablePropertiesKHR)

vkGetPipelineExecutablePropertiesKHR - Get the executables associated with a pipeline

Description

If pProperties is NULL, then the number of executables associated with the pipeline is returned in pExecutableCount. Otherwise, pExecutableCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pExecutableCount is less than the number of executables associated with the pipeline, at most pExecutableCount structures will be written and getPipelineExecutablePropertiesKHR will return INCOMPLETE.

Valid Usage

• pipelineExecutableInfo must be enabled

• pipeline member of pPipelineInfo must have been created with device

Valid Usage (Implicit)

• device must be a valid Device handle

• pPipelineInfo must be a valid pointer to a valid PipelineInfoKHR structure
• pExecutableCount must be a valid pointer to a uint32_t value
• If the value referenced by pExecutableCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pExecutableCount PipelineExecutablePropertiesKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutablePropertiesKHR, PipelineInfoKHR

getPipelineExecutableStatisticsKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the device that created the pipeline.

-> PipelineExecutableInfoKHR

pExecutableInfo describes the pipeline executable being queried.

-> io (Result, "statistics" ::: Vector PipelineExecutableStatisticKHR)

vkGetPipelineExecutableStatisticsKHR - Get compile time statistics associated with a pipeline executable

Description

If pStatistics is NULL, then the number of statistics associated with the pipeline executable is returned in pStatisticCount. Otherwise, pStatisticCount must point to a variable set by the user to the number of elements in the pStatistics array, and on return the variable is overwritten with the number of structures actually written to pStatistics. If pStatisticCount is less than the number of statistics associated with the pipeline executable, at most pStatisticCount structures will be written and getPipelineExecutableStatisticsKHR will return INCOMPLETE.

Valid Usage

• pipelineExecutableInfo must be enabled

• pipeline member of pExecutableInfo must have been created with device
• pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR set in the flags field of GraphicsPipelineCreateInfo or ComputePipelineCreateInfo

Valid Usage (Implicit)

• device must be a valid Device handle

• pExecutableInfo must be a valid pointer to a valid PipelineExecutableInfoKHR structure
• pStatisticCount must be a valid pointer to a uint32_t value
• If the value referenced by pStatisticCount is not 0, and pStatistics is not NULL, pStatistics must be a valid pointer to an array of pStatisticCount PipelineExecutableStatisticKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutableInfoKHR, PipelineExecutableStatisticKHR

getPipelineExecutableInternalRepresentationsKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the device that created the pipeline.

-> PipelineExecutableInfoKHR

pExecutableInfo describes the pipeline executable being queried.

-> io (Result, "internalRepresentations" ::: Vector PipelineExecutableInternalRepresentationKHR)

vkGetPipelineExecutableInternalRepresentationsKHR - Get internal representations of the pipeline executable

Description

If pInternalRepresentations is NULL, then the number of internal representations associated with the pipeline executable is returned in pInternalRepresentationCount. Otherwise, pInternalRepresentationCount must point to a variable set by the user to the number of elements in the pInternalRepresentations array, and on return the variable is overwritten with the number of structures actually written to pInternalRepresentations. If pInternalRepresentationCount is less than the number of internal representations associated with the pipeline executable, at most pInternalRepresentationCount structures will be written and getPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE.

While the details of the internal representations remain implementation dependent, the implementation should order the internal representations in the order in which they occur in the compile pipeline with the final shader assembly (if any) last.

Valid Usage

• pipelineExecutableInfo must be enabled

• pipeline member of pExecutableInfo must have been created with device
• pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR set in the flags field of GraphicsPipelineCreateInfo or ComputePipelineCreateInfo

Valid Usage (Implicit)

• device must be a valid Device handle

• pExecutableInfo must be a valid pointer to a valid PipelineExecutableInfoKHR structure
• pInternalRepresentationCount must be a valid pointer to a uint32_t value
• If the value referenced by pInternalRepresentationCount is not 0, and pInternalRepresentations is not NULL, pInternalRepresentations must be a valid pointer to an array of pInternalRepresentationCount PipelineExecutableInternalRepresentationKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutableInfoKHR, PipelineExecutableInternalRepresentationKHR

data PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

VkPhysicalDevicePipelineExecutablePropertiesFeaturesKHR - Structure describing whether pipeline executable properties are available

Members

The members of the PhysicalDevicePipelineExecutablePropertiesFeaturesKHR structure describe the following features:

Description

If the PhysicalDevicePipelineExecutablePropertiesFeaturesKHR structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDevicePipelineExecutablePropertiesFeaturesKHR can also be included in the pNext chain of DeviceCreateInfo to enable features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Fields

• pipelineExecutableInfo :: Bool

  pipelineExecutableInfo indicates that the implementation supports reporting properties and statistics about the executables associated with a compiled pipeline.

Instances

Eq PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

(==) :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Bool

(/=) :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Bool

Show PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> ShowS

show :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> String

showList :: [PhysicalDevicePipelineExecutablePropertiesFeaturesKHR] -> ShowS

Storable PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Int

alignment :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Int -> IO PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

pokeElemOff :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> Int -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

pokeByteOff :: Ptr b -> Int -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO ()

peek :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

poke :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO ()

FromCStruct PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

ToCStruct PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> (Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDevicePipelineExecutablePropertiesFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PhysicalDevicePipelineExecutablePropertiesFeaturesKHR

data PipelineInfoKHR

VkPipelineInfoKHR - Structure describing a pipeline

Valid Usage (Implicit)

See Also

Pipeline, StructureType, getPipelineExecutablePropertiesKHR

Constructors

PipelineInfoKHR

Fields

• pipeline :: Pipeline

  pipeline is a Pipeline handle.

  pipeline must be a valid Pipeline handle

Instances

Eq PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

(==) :: PipelineInfoKHR -> PipelineInfoKHR -> Bool

(/=) :: PipelineInfoKHR -> PipelineInfoKHR -> Bool

Show PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineInfoKHR -> ShowS

show :: PipelineInfoKHR -> String

showList :: [PipelineInfoKHR] -> ShowS

Storable PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PipelineInfoKHR -> Int

alignment :: PipelineInfoKHR -> Int

peekElemOff :: Ptr PipelineInfoKHR -> Int -> IO PipelineInfoKHR

pokeElemOff :: Ptr PipelineInfoKHR -> Int -> PipelineInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineInfoKHR

pokeByteOff :: Ptr b -> Int -> PipelineInfoKHR -> IO ()

peek :: Ptr PipelineInfoKHR -> IO PipelineInfoKHR

poke :: Ptr PipelineInfoKHR -> PipelineInfoKHR -> IO ()

FromCStruct PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PipelineInfoKHR -> IO PipelineInfoKHR

ToCStruct PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineInfoKHR -> (Ptr PipelineInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineInfoKHR -> PipelineInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineInfoKHR

data PipelineExecutablePropertiesKHR

VkPipelineExecutablePropertiesKHR - Structure describing a pipeline executable

Description

The stages field may be zero or it may contain one or more bits describing the stages principally used to compile this pipeline. Not all implementations have a 1:1 mapping between shader stages and pipeline executables and some implementations may reduce a given shader stage to fixed function hardware programming such that no executable is available. No guarantees are provided about the mapping between shader stages and pipeline executables and stages should be considered a best effort hint. Because the application cannot rely on the stages field to provide an exact description, name and description provide a human readable name and description which more accurately describes the given pipeline executable.

Valid Usage (Implicit)

See Also

ShaderStageFlags, StructureType, getPipelineExecutablePropertiesKHR

Constructors

PipelineExecutablePropertiesKHR

Fields

• stages :: ShaderStageFlags

  stages is a bitmask of ShaderStageFlagBits indicating which shader stages (if any) were principally used as inputs to compile this pipeline executable.

• name :: ByteString

  name is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this executable.

• description :: ByteString

  description is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this executable.

• subgroupSize :: Word32

  subgroupSize is the subgroup size with which this executable is dispatched.

Instances

Show PipelineExecutablePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutablePropertiesKHR -> ShowS

show :: PipelineExecutablePropertiesKHR -> String

showList :: [PipelineExecutablePropertiesKHR] -> ShowS

Storable PipelineExecutablePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PipelineExecutablePropertiesKHR -> Int

alignment :: PipelineExecutablePropertiesKHR -> Int

peekElemOff :: Ptr PipelineExecutablePropertiesKHR -> Int -> IO PipelineExecutablePropertiesKHR

pokeElemOff :: Ptr PipelineExecutablePropertiesKHR -> Int -> PipelineExecutablePropertiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineExecutablePropertiesKHR

pokeByteOff :: Ptr b -> Int -> PipelineExecutablePropertiesKHR -> IO ()

peek :: Ptr PipelineExecutablePropertiesKHR -> IO PipelineExecutablePropertiesKHR

poke :: Ptr PipelineExecutablePropertiesKHR -> PipelineExecutablePropertiesKHR -> IO ()

FromCStruct PipelineExecutablePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PipelineExecutablePropertiesKHR -> IO PipelineExecutablePropertiesKHR

ToCStruct PipelineExecutablePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineExecutablePropertiesKHR -> (Ptr PipelineExecutablePropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineExecutablePropertiesKHR -> PipelineExecutablePropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineExecutablePropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineExecutablePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineExecutablePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutablePropertiesKHR

data PipelineExecutableInfoKHR

VkPipelineExecutableInfoKHR - Structure describing a pipeline executable to query for associated statistics or internal representations

Valid Usage (Implicit)

See Also

Pipeline, StructureType, getPipelineExecutableInternalRepresentationsKHR, getPipelineExecutableStatisticsKHR

Constructors

PipelineExecutableInfoKHR

Fields

• pipeline :: Pipeline

  pipeline is the pipeline to query.

  pipeline must be a valid Pipeline handle

• executableIndex :: Word32

  executableIndex is the index of the executable to query in the array of executable properties returned by getPipelineExecutablePropertiesKHR.

  executableIndex must be less than the number of executables associated with pipeline as returned in the pExecutableCount parameter of getPipelineExecutablePropertiesKHR

Instances

Eq PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

(==) :: PipelineExecutableInfoKHR -> PipelineExecutableInfoKHR -> Bool

(/=) :: PipelineExecutableInfoKHR -> PipelineExecutableInfoKHR -> Bool

Show PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutableInfoKHR -> ShowS

show :: PipelineExecutableInfoKHR -> String

showList :: [PipelineExecutableInfoKHR] -> ShowS

Storable PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PipelineExecutableInfoKHR -> Int

alignment :: PipelineExecutableInfoKHR -> Int

peekElemOff :: Ptr PipelineExecutableInfoKHR -> Int -> IO PipelineExecutableInfoKHR

pokeElemOff :: Ptr PipelineExecutableInfoKHR -> Int -> PipelineExecutableInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineExecutableInfoKHR

pokeByteOff :: Ptr b -> Int -> PipelineExecutableInfoKHR -> IO ()

peek :: Ptr PipelineExecutableInfoKHR -> IO PipelineExecutableInfoKHR

poke :: Ptr PipelineExecutableInfoKHR -> PipelineExecutableInfoKHR -> IO ()

FromCStruct PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PipelineExecutableInfoKHR -> IO PipelineExecutableInfoKHR

ToCStruct PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineExecutableInfoKHR -> (Ptr PipelineExecutableInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineExecutableInfoKHR -> PipelineExecutableInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineExecutableInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineExecutableInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineExecutableInfoKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutableInfoKHR

data PipelineExecutableStatisticKHR

VkPipelineExecutableStatisticKHR - Structure describing a compile-time pipeline executable statistic

Valid Usage (Implicit)

See Also

PipelineExecutableStatisticFormatKHR, PipelineExecutableStatisticValueKHR, StructureType, getPipelineExecutableStatisticsKHR

Constructors

PipelineExecutableStatisticKHR

Fields

• name :: ByteString

  name is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this statistic.

• description :: ByteString

  description is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this statistic.

• format :: PipelineExecutableStatisticFormatKHR

  format is a PipelineExecutableStatisticFormatKHR value specifying the format of the data found in value.

• value :: PipelineExecutableStatisticValueKHR

  value is the value of this statistic.

Instances

Show PipelineExecutableStatisticKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutableStatisticKHR -> ShowS

show :: PipelineExecutableStatisticKHR -> String

showList :: [PipelineExecutableStatisticKHR] -> ShowS

FromCStruct PipelineExecutableStatisticKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PipelineExecutableStatisticKHR -> IO PipelineExecutableStatisticKHR

ToCStruct PipelineExecutableStatisticKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineExecutableStatisticKHR -> (Ptr PipelineExecutableStatisticKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineExecutableStatisticKHR -> PipelineExecutableStatisticKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineExecutableStatisticKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineExecutableStatisticKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineExecutableStatisticKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutableStatisticKHR

data PipelineExecutableInternalRepresentationKHR

VkPipelineExecutableInternalRepresentationKHR - Structure describing the textual form of a pipeline executable internal representation

Description

If pData is NULL, then the size, in bytes, of the internal representation data is returned in dataSize. Otherwise, dataSize must be the size of the buffer, in bytes, pointed to by pData and on return dataSize is overwritten with the number of bytes of data actually written to pData including any trailing null character. If dataSize is less than the size, in bytes, of the internal representation data, at most dataSize bytes of data will be written to pData and getPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE. If isText is TRUE and pData is not NULL and dataSize is not zero, the last byte written to pData will be a null character.

Valid Usage (Implicit)

See Also

Bool32, StructureType, getPipelineExecutableInternalRepresentationsKHR

Constructors

PipelineExecutableInternalRepresentationKHR

Fields

• name :: ByteString

  name is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this internal representation.

• description :: ByteString

  description is an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this internal representation.

• isText :: Bool

  isText specifies whether the returned data is text or opaque data. If isText is TRUE then the data returned in pData is text and is guaranteed to be a null-terminated UTF-8 string.

• dataSize :: Word64

  dataSize is an integer related to the size, in bytes, of the internal representation data, as described below.

• data' :: Ptr ()

  pData is either NULL or a pointer to an block of data into which the implementation will write the textual form of the internal representation.

Instances

Show PipelineExecutableInternalRepresentationKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutableInternalRepresentationKHR -> ShowS

show :: PipelineExecutableInternalRepresentationKHR -> String

showList :: [PipelineExecutableInternalRepresentationKHR] -> ShowS

Storable PipelineExecutableInternalRepresentationKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PipelineExecutableInternalRepresentationKHR -> Int

alignment :: PipelineExecutableInternalRepresentationKHR -> Int

peekElemOff :: Ptr PipelineExecutableInternalRepresentationKHR -> Int -> IO PipelineExecutableInternalRepresentationKHR

pokeElemOff :: Ptr PipelineExecutableInternalRepresentationKHR -> Int -> PipelineExecutableInternalRepresentationKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineExecutableInternalRepresentationKHR

pokeByteOff :: Ptr b -> Int -> PipelineExecutableInternalRepresentationKHR -> IO ()

peek :: Ptr PipelineExecutableInternalRepresentationKHR -> IO PipelineExecutableInternalRepresentationKHR

poke :: Ptr PipelineExecutableInternalRepresentationKHR -> PipelineExecutableInternalRepresentationKHR -> IO ()

FromCStruct PipelineExecutableInternalRepresentationKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

peekCStruct :: Ptr PipelineExecutableInternalRepresentationKHR -> IO PipelineExecutableInternalRepresentationKHR

ToCStruct PipelineExecutableInternalRepresentationKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineExecutableInternalRepresentationKHR -> (Ptr PipelineExecutableInternalRepresentationKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineExecutableInternalRepresentationKHR -> PipelineExecutableInternalRepresentationKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineExecutableInternalRepresentationKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineExecutableInternalRepresentationKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineExecutableInternalRepresentationKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutableInternalRepresentationKHR

data PipelineExecutableStatisticValueKHR

Constructors

B32 Bool

I64 Int64

U64 Word64

F64 Double

Instances

Show PipelineExecutableStatisticValueKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutableStatisticValueKHR -> ShowS

show :: PipelineExecutableStatisticValueKHR -> String

showList :: [PipelineExecutableStatisticValueKHR] -> ShowS

ToCStruct PipelineExecutableStatisticValueKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

withCStruct :: PipelineExecutableStatisticValueKHR -> (Ptr PipelineExecutableStatisticValueKHR -> IO b) -> IO b

pokeCStruct :: Ptr PipelineExecutableStatisticValueKHR -> PipelineExecutableStatisticValueKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineExecutableStatisticValueKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineExecutableStatisticValueKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineExecutableStatisticValueKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutableStatisticValueKHR

peekPipelineExecutableStatisticValueKHR :: PipelineExecutableStatisticFormatKHR -> Ptr PipelineExecutableStatisticValueKHR -> IO PipelineExecutableStatisticValueKHR

newtype PipelineExecutableStatisticFormatKHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

See Also

PipelineExecutableStatisticKHR

Constructors

PipelineExecutableStatisticFormatKHR Int32

Bundled Patterns

pattern PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR :: PipelineExecutableStatisticFormatKHR

PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR specifies that the statistic is returned as a 32-bit boolean value which must be either TRUE or FALSE and should be read from the b32 field of PipelineExecutableStatisticValueKHR.

pattern PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR :: PipelineExecutableStatisticFormatKHR

PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR specifies that the statistic is returned as a signed 64-bit integer and should be read from the i64 field of PipelineExecutableStatisticValueKHR.

pattern PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR :: PipelineExecutableStatisticFormatKHR

PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR specifies that the statistic is returned as an unsigned 64-bit integer and should be read from the u64 field of PipelineExecutableStatisticValueKHR.

pattern PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR :: PipelineExecutableStatisticFormatKHR

PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR specifies that the statistic is returned as a 64-bit floating-point value and should be read from the f64 field of PipelineExecutableStatisticValueKHR.

Instances

Eq PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

(==) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

(/=) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

Ord PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

compare :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Ordering

(<) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

(<=) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

(>) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

(>=) :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> Bool

max :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR

min :: PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR

Read PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

readsPrec :: Int -> ReadS PipelineExecutableStatisticFormatKHR

readList :: ReadS [PipelineExecutableStatisticFormatKHR]

readPrec :: ReadPrec PipelineExecutableStatisticFormatKHR

readListPrec :: ReadPrec [PipelineExecutableStatisticFormatKHR]

Show PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

showsPrec :: Int -> PipelineExecutableStatisticFormatKHR -> ShowS

show :: PipelineExecutableStatisticFormatKHR -> String

showList :: [PipelineExecutableStatisticFormatKHR] -> ShowS

Storable PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

sizeOf :: PipelineExecutableStatisticFormatKHR -> Int

alignment :: PipelineExecutableStatisticFormatKHR -> Int

peekElemOff :: Ptr PipelineExecutableStatisticFormatKHR -> Int -> IO PipelineExecutableStatisticFormatKHR

pokeElemOff :: Ptr PipelineExecutableStatisticFormatKHR -> Int -> PipelineExecutableStatisticFormatKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineExecutableStatisticFormatKHR

pokeByteOff :: Ptr b -> Int -> PipelineExecutableStatisticFormatKHR -> IO ()

peek :: Ptr PipelineExecutableStatisticFormatKHR -> IO PipelineExecutableStatisticFormatKHR

poke :: Ptr PipelineExecutableStatisticFormatKHR -> PipelineExecutableStatisticFormatKHR -> IO ()

Zero PipelineExecutableStatisticFormatKHR

Defined in Vulkan.Extensions.VK_KHR_pipeline_executable_properties

Methods

zero :: PipelineExecutableStatisticFormatKHR

type KHR_PIPELINE_EXECUTABLE_PROPERTIES_SPEC_VERSION = 1

pattern KHR_PIPELINE_EXECUTABLE_PROPERTIES_SPEC_VERSION :: forall a. Integral a => a

type KHR_PIPELINE_EXECUTABLE_PROPERTIES_EXTENSION_NAME = "VK_KHR_pipeline_executable_properties"

pattern KHR_PIPELINE_EXECUTABLE_PROPERTIES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a