mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 12:35:11 +00:00
194a7f4d0d
* Update release number to 122.
Internal Issues:
* Add style guide language on not using standalone `+` signs (internal
issue 736); not using leading whitespace for markup (internal issue
747); and on keeping descriptions of a single API in a contiguous block
of markup (internal issue 949), and apply them to the specification.
* Add a glossary definition of "`constant integral expression`", pointing
to the SPIR-V "`constant instruction`" definition (internal issue 1225).
* Many minor edits to improve writing style consistency and capture
additional style guidelines (internal issue 1553).
* Clarify that <<fragops-depth-write, depth writes are not performed>> if
there is no depth framebuffer attachment (internal issue 1771).
* Allow implementations to use rectangular line style of interpolation for
<<primsrast-lines-bresenham, wide Bresenham lines>>, though replicating
attributes is still preferred. Clarify that code:FragCoord is not
replicated (internal issue 1772).
* Resolve a contradiction in valid usage statements for
slink:VkImageCreateInfo and slink:VkImageStencilUsageCreateInfoEXT
(internal issue 1773).
* Add style guide discussion of markup for indented equations, and use
markup workaround for asciidoctor 2 compatibility (internal issue 1793).
* Deprecate the `<<VK_EXT_validation_flags>>` extension in `vk.xml` and
the extension appendix (internal issue 1801).
* Add a new checker script `scripts/xml_consistency.py`. This is not
currently run as part of internal CI (internal merge request 3285).
* Correct "`an`" -> "`a`" prepositions where needed (internal merge
request 3334).
* Clarify that the <<features-uniformBufferStandardLayout,
pname:uniformBufferStandardLayout>> feature is only required when the
extension defining it is supported (internal merge request 3341).
* Bring scripts into closer sync with OpenXR, mainly through conversion of
comments to docstrings where appropriate, and add gen-scripts-docs.sh
(internal merge request 3324).
* Correct pname:maxDrawMeshTasksCount to 2^16^-1 in the <<limits-required,
Required Limits>> table (internal merge requests 3361).
New Extensions
* `<<VK_IMG_format_pvrtc>>` (public issue 512).
134 lines
5.9 KiB
Plaintext
134 lines
5.9 KiB
Plaintext
// This section is included inside the Pipelines chapter (pipelines.txt)
|
|
|
|
[open,refpage='vkGetShaderInfoAMD',desc='Get information about a shader in a pipeline',type='protos']
|
|
--
|
|
|
|
Information about a particular shader that has been compiled as part of a
|
|
pipeline object can be extracted by calling:
|
|
|
|
include::{generated}/api/protos/vkGetShaderInfoAMD.txt[]
|
|
|
|
* pname:device is the device that created pname:pipeline.
|
|
* pname:pipeline is the target of the query.
|
|
* pname:shaderStage identifies the particular shader within the pipeline
|
|
about which information is being queried.
|
|
* pname:infoType describes what kind of information is being queried.
|
|
* pname:pInfoSize is a pointer to a value related to the amount of data
|
|
the query returns, as described below.
|
|
* pname:pInfo is either NULL or a pointer to a buffer.
|
|
|
|
If pname:pInfo is `NULL`, then the maximum size of the information that can:
|
|
be retrieved about the shader, in bytes, is returned in pname:pInfoSize.
|
|
Otherwise, pname:pInfoSize must: point to a variable set by the user to the
|
|
size of the buffer, in bytes, pointed to by pname:pInfo, and on return the
|
|
variable is overwritten with the amount of data actually written to
|
|
pname:pInfo.
|
|
|
|
If pname:pInfoSize is less than the maximum size that can: be retrieved by
|
|
the pipeline cache, then at most pname:pInfoSize bytes will be written to
|
|
pname:pInfo, and fname:vkGetShaderInfoAMD will return ename: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
|
|
ename:VK_ERROR_FEATURE_NOT_PRESENT.
|
|
|
|
If information is successfully and fully queried, the function will return
|
|
ename:VK_SUCCESS.
|
|
|
|
For pname:infoType ename:VK_SHADER_INFO_TYPE_STATISTICS_AMD, an instance of
|
|
sname:VkShaderStatisticsInfoAMD will be written to the buffer pointed to by
|
|
pname: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 pname:infoType ename:VK_SHADER_INFO_TYPE_DISASSEMBLY_AMD, pname: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
|
|
pname:infoType ename:VK_SHADER_INFO_TYPE_BINARY_AMD, are left to the vendor
|
|
and are not further specified by this extension.
|
|
|
|
include::{generated}/validity/protos/vkGetShaderInfoAMD.txt[]
|
|
--
|
|
|
|
[open,refpage='VkShaderInfoTypeAMD',desc='Enum specifying which type of shader info to query',type='enums']
|
|
--
|
|
Possible values of flink:vkGetShaderInfoAMD::pname:infoType, specifying the
|
|
information being queried from a shader, are:
|
|
|
|
include::{generated}/api/enums/VkShaderInfoTypeAMD.txt[]
|
|
|
|
* ename:VK_SHADER_INFO_TYPE_STATISTICS_AMD specifies that device resources
|
|
used by a shader will be queried.
|
|
* ename:VK_SHADER_INFO_TYPE_BINARY_AMD specifies that
|
|
implementation-specific information will be queried.
|
|
* ename:VK_SHADER_INFO_TYPE_DISASSEMBLY_AMD specifies that human-readable
|
|
dissassembly of a shader.
|
|
--
|
|
|
|
[open,refpage='VkShaderStatisticsInfoAMD',desc='Statistical information about a particular shader within a pipeline',type='structs']
|
|
--
|
|
|
|
The sname:VkShaderStatisticsInfoAMD structure is defined as:
|
|
|
|
include::{generated}/api/structs/VkShaderStatisticsInfoAMD.txt[]
|
|
|
|
* pname:shaderStageMask are the combination of logical shader stages
|
|
contained within this shader.
|
|
* pname:resourceUsage is an instance of slink:VkShaderResourceUsageAMD
|
|
describing internal physical device resources used by this shader.
|
|
* pname:numPhysicalVgprs is the maximum number of vector instruction
|
|
general-purpose registers (VGPRs) available to the physical device.
|
|
* pname:numPhysicalSgprs is the maximum number of scalar instruction
|
|
general-purpose registers (SGPRs) available to the physical device.
|
|
* pname:numAvailableVgprs is the maximum limit of VGPRs made available to
|
|
the shader compiler.
|
|
* pname:numAvailableSgprs is the maximum limit of SGPRs made available to
|
|
the shader compiler.
|
|
* pname:computeWorkGroupSize is the local workgroup size of this shader in
|
|
{ X, Y, Z } dimensions.
|
|
|
|
Some implementations may merge multiple logical shader stages together in a
|
|
single shader.
|
|
In such cases, pname:shaderStageMask will contain a bitmask of all of the
|
|
stages that are active within that shader.
|
|
Consequently, if specifying those stages as input to
|
|
flink:vkGetShaderInfoAMD, the same output information may: be returned for
|
|
all such shader stage queries.
|
|
|
|
The number of available VGPRs and SGPRs (pname:numAvailableVgprs and
|
|
pname: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.
|
|
|
|
include::{generated}/validity/structs/VkShaderStatisticsInfoAMD.txt[]
|
|
--
|
|
|
|
[open,refpage='VkShaderResourceUsageAMD',desc='Resource usage information about a particular shader within a pipeline',type='structs']
|
|
--
|
|
|
|
The sname:VkShaderResourceUsageAMD structure is defined as:
|
|
|
|
include::{generated}/api/structs/VkShaderResourceUsageAMD.txt[]
|
|
|
|
* pname:numUsedVgprs is the number of vector instruction general-purpose
|
|
registers used by this shader.
|
|
* pname:numUsedSgprs is the number of scalar instruction general-purpose
|
|
registers used by this shader.
|
|
* pname:ldsSizePerLocalWorkGroup is the maximum local data store size per
|
|
work group in bytes.
|
|
* pname:ldsUsageSizeInBytes is the LDS usage size in bytes per work group
|
|
by this shader.
|
|
* pname:scratchMemUsageInBytes is the scratch memory usage in bytes by
|
|
this shader.
|
|
|
|
include::{generated}/validity/structs/VkShaderResourceUsageAMD.txt[]
|
|
--
|