Graphics.Vulkan.Extensions.VK_AMD_shader_info

Documentation

newtype VkShaderInfoTypeAMD

Constructors

VkShaderInfoTypeAMD Int32

Instances

Eq VkShaderInfoTypeAMD

Methods

(==) :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> Bool

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

Ord VkShaderInfoTypeAMD

Methods

compare :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> Ordering

(<) :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> Bool

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

(>) :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> Bool

(>=) :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> Bool

max :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD

min :: VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD -> VkShaderInfoTypeAMD

Read VkShaderInfoTypeAMD

Methods

readsPrec :: Int -> ReadS VkShaderInfoTypeAMD

readList :: ReadS [VkShaderInfoTypeAMD]

readPrec :: ReadPrec VkShaderInfoTypeAMD

readListPrec :: ReadPrec [VkShaderInfoTypeAMD]

Show VkShaderInfoTypeAMD

Methods

showsPrec :: Int -> VkShaderInfoTypeAMD -> ShowS

show :: VkShaderInfoTypeAMD -> String

showList :: [VkShaderInfoTypeAMD] -> ShowS

Storable VkShaderInfoTypeAMD

Methods

sizeOf :: VkShaderInfoTypeAMD -> Int

alignment :: VkShaderInfoTypeAMD -> Int

peekElemOff :: Ptr VkShaderInfoTypeAMD -> Int -> IO VkShaderInfoTypeAMD

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

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

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

peek :: Ptr VkShaderInfoTypeAMD -> IO VkShaderInfoTypeAMD

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

pattern VK_SHADER_INFO_TYPE_STATISTICS_AMD :: VkShaderInfoTypeAMD

pattern VK_SHADER_INFO_TYPE_BINARY_AMD :: VkShaderInfoTypeAMD

pattern VK_SHADER_INFO_TYPE_DISASSEMBLY_AMD :: VkShaderInfoTypeAMD

pattern VK_AMD_SHADER_INFO_SPEC_VERSION :: Integral a => a

pattern VK_AMD_SHADER_INFO_EXTENSION_NAME :: (Eq a, IsString a) => a

vkGetShaderInfoAMD :: ("device" ::: VkDevice) -> ("pipeline" ::: VkPipeline) -> ("shaderStage" ::: VkShaderStageFlagBits) -> ("infoType" ::: VkShaderInfoTypeAMD) -> ("pInfoSize" ::: Ptr CSize) -> ("pInfo" ::: Ptr ()) -> IO VkResult

vkGetShaderInfoAMD - Get information about a shader in a pipeline

Parameters

• device is the device that created pipeline.

• pipeline is the target of the query.
• shaderStage identifies the particular shader within the pipeline about which information is being queried.
• infoType describes what kind of information is being queried.
• pInfoSize is a pointer to a value related to the amount of data the query returns, as described below.
• pInfo is either NULL or a pointer to a buffer.

Description

If pInfo is NULL, then the maximum size of the information that can be retrieved about the shader, in bytes, is returned in pInfoSize. Otherwise, pInfoSize must point to a variable set by the user to the size of the buffer, in bytes, pointed to by pInfo, and on return the variable is overwritten with the amount of data actually written to pInfo.

If pInfoSize is less than the maximum size that can be retrieved by the pipeline cache, then at most pInfoSize bytes will be written to pInfo, and vkGetShaderInfoAMD will return VK_INCOMPLETE.

Not all information is available for every shader and implementations may not support all kinds of information for any shader. When a certain type of information is unavailable, the function returns VK_ERROR_FEATURE_NOT_PRESENT.

If information is successfully and fully queried, the function will return VK_SUCCESS.

For VK_SHADER_INFO_TYPE_STATISTICS_AMD, an instance of VkShaderStatisticsInfoAMD will be written to the buffer pointed to by pInfo. This structure will be populated with statistics regarding the physical device resources used by that shader along with other miscellaneous information and is described in further detail below.

For VK_SHADER_INFO_TYPE_DISASSEMBLY_AMD, pInfo points to a UTF-8 null-terminated string containing human-readable disassembly. The exact formatting and contents of the disassembly string are vendor-specific.

The formatting and contents of all other types of information, including VK_SHADER_INFO_TYPE_BINARY_AMD, are left to the vendor and are not further specified by this extension.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pipeline must be a valid VkPipeline handle
• shaderStage must be a valid VkShaderStageFlagBits value
• infoType must be a valid VkShaderInfoTypeAMD value
• pInfoSize must be a valid pointer to a size_t value
• If the value referenced by pInfoSize is not 0, and pInfo is not NULL, pInfo must be a valid pointer to an array of pInfoSize bytes
• pipeline must have been created, allocated, or retrieved from device

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_FEATURE_NOT_PRESENT

• VK_ERROR_OUT_OF_HOST_MEMORY

See Also

VkDevice, VkPipeline, VkShaderInfoTypeAMD, VkShaderStageFlagBits

data VkShaderResourceUsageAMD

VkShaderResourceUsageAMD - Resource usage information about a particular shader within a pipeline

Description

See Also

VkShaderStatisticsInfoAMD

Constructors

VkShaderResourceUsageAMD

Fields

• vkNumUsedVgprs :: Word32

  numUsedVgprs is the number of vector instruction general-purpose registers used by this shader.

• vkNumUsedSgprs :: Word32

  numUsedSgprs is the number of scalar instruction general-purpose registers used by this shader.

• vkLdsSizePerLocalWorkGroup :: Word32

  ldsSizePerLocalWorkGroup is the maximum local data store size per work group in bytes.

• vkLdsUsageSizeInBytes :: CSize

  ldsUsageSizeInBytes is the LDS usage size in bytes per work group by this shader.

• vkScratchMemUsageInBytes :: CSize

  scratchMemUsageInBytes is the scratch memory usage in bytes by this shader.

Instances

Eq VkShaderResourceUsageAMD

Methods

(==) :: VkShaderResourceUsageAMD -> VkShaderResourceUsageAMD -> Bool

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

Show VkShaderResourceUsageAMD

Methods

showsPrec :: Int -> VkShaderResourceUsageAMD -> ShowS

show :: VkShaderResourceUsageAMD -> String

showList :: [VkShaderResourceUsageAMD] -> ShowS

Storable VkShaderResourceUsageAMD

Methods

sizeOf :: VkShaderResourceUsageAMD -> Int

alignment :: VkShaderResourceUsageAMD -> Int

peekElemOff :: Ptr VkShaderResourceUsageAMD -> Int -> IO VkShaderResourceUsageAMD

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

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

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

peek :: Ptr VkShaderResourceUsageAMD -> IO VkShaderResourceUsageAMD

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

data VkShaderStatisticsInfoAMD

VkShaderStatisticsInfoAMD - Statistical information about a particular shader within a pipeline

Description

Some implementations may merge multiple logical shader stages together in a single shader. In such cases, shaderStageMask will contain a bitmask of all of the stages that are active within that shader. Consequently, if specifying those stages as input to vkGetShaderInfoAMD, the same output information may be returned for all such shader stage queries.

The number of available VGPRs and SGPRs (numAvailableVgprs and numAvailableSgprs respectively) are the shader-addressable subset of physical registers that is given as a limit to the compiler for register assignment. These values may further be limited by implementations due to performance optimizations where register pressure is a bottleneck.

See Also

VkShaderResourceUsageAMD, VkShaderStageFlags

Constructors

VkShaderStatisticsInfoAMD

Fields

• vkShaderStageMask :: VkShaderStageFlags

  shaderStageMask are the combination of logical shader stages contained within this shader.

• vkResourceUsage :: VkShaderResourceUsageAMD

  resourceUsage is an instance of VkShaderResourceUsageAMD describing internal physical device resources used by this shader.

• vkNumPhysicalVgprs :: Word32

  numPhysicalVgprs is the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device.

• vkNumPhysicalSgprs :: Word32

  numPhysicalSgprs is the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device.

• vkNumAvailableVgprs :: Word32

  numAvailableVgprs is the maximum limit of VGPRs made available to the shader compiler.

• vkNumAvailableSgprs :: Word32

  numAvailableSgprs is the maximum limit of SGPRs made available to the shader compiler.

• vkComputeWorkGroupSize :: Vector 3 Word32

  computeWorkGroupSize is the local workgroup size of this shader in { X, Y, Z } dimensions.

Instances

Eq VkShaderStatisticsInfoAMD

Methods

(==) :: VkShaderStatisticsInfoAMD -> VkShaderStatisticsInfoAMD -> Bool

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

Show VkShaderStatisticsInfoAMD

Methods

showsPrec :: Int -> VkShaderStatisticsInfoAMD -> ShowS

show :: VkShaderStatisticsInfoAMD -> String

showList :: [VkShaderStatisticsInfoAMD] -> ShowS

Storable VkShaderStatisticsInfoAMD

Methods

sizeOf :: VkShaderStatisticsInfoAMD -> Int

alignment :: VkShaderStatisticsInfoAMD -> Int

peekElemOff :: Ptr VkShaderStatisticsInfoAMD -> Int -> IO VkShaderStatisticsInfoAMD

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

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

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

peek :: Ptr VkShaderStatisticsInfoAMD -> IO VkShaderStatisticsInfoAMD

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