Vulkan.Extensions.VK_AMD_shader_info

Documentation

getShaderInfoAMD

Arguments

:: forall io. MonadIO io

=> Device

device is the device that created pipeline.

-> Pipeline

pipeline is the target of the query.

-> ShaderStageFlagBits

shaderStage identifies the particular shader within the pipeline about which information is being queried.

-> ShaderInfoTypeAMD

infoType describes what kind of information is being queried.

-> io (Result, "info" ::: ByteString)

vkGetShaderInfoAMD - Get information about a shader in a pipeline

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 getShaderInfoAMD will return 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 ERROR_FEATURE_NOT_PRESENT.

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

For infoType SHADER_INFO_TYPE_STATISTICS_AMD, a ShaderStatisticsInfoAMD structure 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 infoType SHADER_INFO_TYPE_DISASSEMBLY_AMD, pInfo is a pointer 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 infoType 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 Device handle

• pipeline must be a valid Pipeline handle
• shaderStage must be a valid ShaderStageFlagBits value
• infoType must be a valid ShaderInfoTypeAMD 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

• SUCCESS
• INCOMPLETE

Failure

• ERROR_FEATURE_NOT_PRESENT
• ERROR_OUT_OF_HOST_MEMORY

See Also

Device, Pipeline, ShaderInfoTypeAMD, ShaderStageFlagBits

data ShaderResourceUsageAMD

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

See Also

ShaderStatisticsInfoAMD

Constructors

ShaderResourceUsageAMD

Fields

• numUsedVgprs :: Word32

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

• numUsedSgprs :: Word32

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

• ldsSizePerLocalWorkGroup :: Word32

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

• ldsUsageSizeInBytes :: Word64

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

• scratchMemUsageInBytes :: Word64

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

Instances

Eq ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

(==) :: ShaderResourceUsageAMD -> ShaderResourceUsageAMD -> Bool

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

Show ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

showsPrec :: Int -> ShaderResourceUsageAMD -> ShowS

show :: ShaderResourceUsageAMD -> String

showList :: [ShaderResourceUsageAMD] -> ShowS

Generic ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Associated Types

type Rep ShaderResourceUsageAMD :: Type -> Type

Methods

from :: ShaderResourceUsageAMD -> Rep ShaderResourceUsageAMD x

to :: Rep ShaderResourceUsageAMD x -> ShaderResourceUsageAMD

Storable ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

sizeOf :: ShaderResourceUsageAMD -> Int

alignment :: ShaderResourceUsageAMD -> Int

peekElemOff :: Ptr ShaderResourceUsageAMD -> Int -> IO ShaderResourceUsageAMD

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

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

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

peek :: Ptr ShaderResourceUsageAMD -> IO ShaderResourceUsageAMD

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

FromCStruct ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

peekCStruct :: Ptr ShaderResourceUsageAMD -> IO ShaderResourceUsageAMD

ToCStruct ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

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

pokeCStruct :: Ptr ShaderResourceUsageAMD -> ShaderResourceUsageAMD -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ShaderResourceUsageAMD -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

zero :: ShaderResourceUsageAMD

type Rep ShaderResourceUsageAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

type Rep ShaderResourceUsageAMD = D1 ('MetaData "ShaderResourceUsageAMD" "Vulkan.Extensions.VK_AMD_shader_info" "vulkan-3.6.2-inplace" 'False) (C1 ('MetaCons "ShaderResourceUsageAMD" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numUsedVgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "numUsedSgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "ldsSizePerLocalWorkGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "ldsUsageSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "scratchMemUsageInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64)))))

data ShaderStatisticsInfoAMD

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 getShaderInfoAMD, 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

ShaderResourceUsageAMD, ShaderStageFlags

Constructors

ShaderStatisticsInfoAMD

Fields

• shaderStageMask :: ShaderStageFlags

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

• resourceUsage :: ShaderResourceUsageAMD

  resourceUsage is a ShaderResourceUsageAMD structure describing internal physical device resources used by this shader.

• numPhysicalVgprs :: Word32

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

• numPhysicalSgprs :: Word32

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

• numAvailableVgprs :: Word32

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

• numAvailableSgprs :: Word32

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

• computeWorkGroupSize :: (Word32, Word32, Word32)

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

Instances

Show ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

showsPrec :: Int -> ShaderStatisticsInfoAMD -> ShowS

show :: ShaderStatisticsInfoAMD -> String

showList :: [ShaderStatisticsInfoAMD] -> ShowS

Generic ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Associated Types

type Rep ShaderStatisticsInfoAMD :: Type -> Type

Methods

from :: ShaderStatisticsInfoAMD -> Rep ShaderStatisticsInfoAMD x

to :: Rep ShaderStatisticsInfoAMD x -> ShaderStatisticsInfoAMD

FromCStruct ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

peekCStruct :: Ptr ShaderStatisticsInfoAMD -> IO ShaderStatisticsInfoAMD

ToCStruct ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

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

pokeCStruct :: Ptr ShaderStatisticsInfoAMD -> ShaderStatisticsInfoAMD -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ShaderStatisticsInfoAMD -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

zero :: ShaderStatisticsInfoAMD

type Rep ShaderStatisticsInfoAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

type Rep ShaderStatisticsInfoAMD = D1 ('MetaData "ShaderStatisticsInfoAMD" "Vulkan.Extensions.VK_AMD_shader_info" "vulkan-3.6.2-inplace" 'False) (C1 ('MetaCons "ShaderStatisticsInfoAMD" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shaderStageMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShaderStageFlags) :*: (S1 ('MetaSel ('Just "resourceUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShaderResourceUsageAMD) :*: S1 ('MetaSel ('Just "numPhysicalVgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))) :*: ((S1 ('MetaSel ('Just "numPhysicalSgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "numAvailableVgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "numAvailableSgprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "computeWorkGroupSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Word32, Word32, Word32))))))

newtype ShaderInfoTypeAMD

VkShaderInfoTypeAMD - Enum specifying which type of shader info to query

See Also

getShaderInfoAMD

Constructors

ShaderInfoTypeAMD Int32

Bundled Patterns

pattern SHADER_INFO_TYPE_STATISTICS_AMD :: ShaderInfoTypeAMD

SHADER_INFO_TYPE_STATISTICS_AMD specifies that device resources used by a shader will be queried.

pattern SHADER_INFO_TYPE_BINARY_AMD :: ShaderInfoTypeAMD

SHADER_INFO_TYPE_BINARY_AMD specifies that implementation-specific information will be queried.

pattern SHADER_INFO_TYPE_DISASSEMBLY_AMD :: ShaderInfoTypeAMD

SHADER_INFO_TYPE_DISASSEMBLY_AMD specifies that human-readable dissassembly of a shader.

Instances

Eq ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

(==) :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> Bool

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

Ord ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

compare :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> Ordering

(<) :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> Bool

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

(>) :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> Bool

(>=) :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> Bool

max :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> ShaderInfoTypeAMD

min :: ShaderInfoTypeAMD -> ShaderInfoTypeAMD -> ShaderInfoTypeAMD

Read ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

readsPrec :: Int -> ReadS ShaderInfoTypeAMD

readList :: ReadS [ShaderInfoTypeAMD]

readPrec :: ReadPrec ShaderInfoTypeAMD

readListPrec :: ReadPrec [ShaderInfoTypeAMD]

Show ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

showsPrec :: Int -> ShaderInfoTypeAMD -> ShowS

show :: ShaderInfoTypeAMD -> String

showList :: [ShaderInfoTypeAMD] -> ShowS

Storable ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

sizeOf :: ShaderInfoTypeAMD -> Int

alignment :: ShaderInfoTypeAMD -> Int

peekElemOff :: Ptr ShaderInfoTypeAMD -> Int -> IO ShaderInfoTypeAMD

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

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

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

peek :: Ptr ShaderInfoTypeAMD -> IO ShaderInfoTypeAMD

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

Zero ShaderInfoTypeAMD

Defined in Vulkan.Extensions.VK_AMD_shader_info

Methods

zero :: ShaderInfoTypeAMD

type AMD_SHADER_INFO_SPEC_VERSION = 1

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

type AMD_SHADER_INFO_EXTENSION_NAME = "VK_AMD_shader_info"

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