Skip to content

Commit

Permalink
Fix some markup (#2200)
Browse files Browse the repository at this point in the history
  • Loading branch information
krOoze authored Aug 22, 2023
1 parent b9aad70 commit 8b900b9
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 43 deletions.
2 changes: 1 addition & 1 deletion appendices/VK_KHR_maintenance5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The new features are as follows:
* A function flink:vkGetRenderingAreaGranularityKHR to query the optimal
render area for a dynamic rendering instance.
* A property to indicate that depth/stencil texturing operations with
enum:VK_COMPONENT_SWIZZLE_ONE have defined behavior
ename:VK_COMPONENT_SWIZZLE_ONE have defined behavior
* Add flink:vkGetImageSubresourceLayout2KHR and a new function
flink:vkGetDeviceImageSubresourceLayoutKHR to allow the application to
query the image memory layout without having to create an image object
Expand Down
8 changes: 4 additions & 4 deletions appendices/VK_KHR_portability_subset.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ include::{generated}/meta/{refprefix}VK_KHR_portability_subset.adoc[]

=== Description

The `VK_KHR_portability_subset extension allows a non-conformant Vulkan
implementation to be built on top of another non-Vulkan graphics API, and
identifies differences between that implementation and a fully-conformant
native Vulkan implementation.
The `apiext:VK_KHR_portability_subset` extension allows a non-conformant
Vulkan implementation to be built on top of another non-Vulkan graphics API,
and identifies differences between that implementation and a
fully-conformant native Vulkan implementation.

This extension provides Vulkan implementations with the ability to mark
otherwise-required capabilities as unsupported, or to establish additional
Expand Down
8 changes: 4 additions & 4 deletions chapters/VK_HUAWEI_cluster_culling_shader/drawing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ include::{chapters}/commonvalidity/draw_common.adoc[]
include::{chapters}/commonvalidity/draw_mesh_common.adoc[]
ifdef::VK_NV_mesh_shader,VK_EXT_mesh_shader[]
* [[VUID-vkCmdDrawClusterHUAWEI-None-07819]]
The pipelineStatistics member used to create any active Pipeline
Statistics Query must also not contain
VK_QUERY_PIPELINE_STATISTIC_TASK_SHADER_INVOCATIONS_BIT_EXT,
VK_QUERY_PIPELINE_STATISTIC_MESH_SHADER_INVOCATIONS_BIT_EXT
The pname:pipelineStatistics member used to create any active
<<queries-pipestats, Pipeline Statistics Query>> must: not contain
ename:VK_QUERY_PIPELINE_STATISTIC_TASK_SHADER_INVOCATIONS_BIT_EXT, or
ename:VK_QUERY_PIPELINE_STATISTIC_MESH_SHADER_INVOCATIONS_BIT_EXT
endif::VK_NV_mesh_shader,VK_EXT_mesh_shader[]
* [[VUID-vkCmdDrawClusterHUAWEI-groupCountX-07820]]
pname:groupCountX must: be less than or equal to
Expand Down
4 changes: 2 additions & 2 deletions chapters/VK_KHR_swapchain/PresentId.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ include::{generated}/api/structs/VkPresentIdKHR.adoc[]
structure.
* pname:swapchainCount is the number of swapchains being presented to the
fname:vkQueuePresentKHR command.
* pname:pPresentIds is `NULL` or a pointer to an array of uint64_t with
pname:swapchainCount entries.
* pname:pPresentIds is `NULL` or a pointer to an array of
code:uint64_t with pname:swapchainCount entries.
If not `NULL`, each non-zero value in pname:pPresentIds specifies the
present id to be associated with the presentation of the swapchain with
the same index in the flink:vkQueuePresentKHR call.
Expand Down
2 changes: 1 addition & 1 deletion chapters/VK_NV_optical_flow/optical_flow.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ include::{generated}/validity/structs/VkOpticalFlowImageFormatInfoNV.adoc[]

[open,refpage='VkOpticalFlowUsageFlagBitsNV',desc='Bits specifying usage for optical flow operations',type='enums']
--
Bits which can: be set in VkOpticalFlowImageFormatInfoNV::pname:usage,
Bits which can: be set in slink:VkOpticalFlowImageFormatInfoNV::pname:usage,
controlling optical flow usage, are:

include::{generated}/api/enums/VkOpticalFlowUsageFlagBitsNV.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion chapters/commonvalidity/attachment_description_common.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Common Valid Usage
// Common to attachment description structures
* [[VUID-{refpage}-format-06698]]
pname:format must: not be VK_FORMAT_UNDEFINED
pname:format must: not be ename:VK_FORMAT_UNDEFINED
* [[VUID-{refpage}-format-06699]]
If pname:format includes a color or depth component and pname:loadOp is
ename:VK_ATTACHMENT_LOAD_OP_LOAD, then pname:initialLayout must: not be
Expand Down
4 changes: 2 additions & 2 deletions chapters/commonvalidity/copy_image_common.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,8 @@ ifdef::VK_KHR_maintenance5[]
* [[VUID-{refpage}-srcImage-08793]]
If pname:srcImage and pname:dstImage have the same elink:VkImageType,
and neither of the pname:layerCount members of pname:srcSubresource or
pname:dstSubresource are VK_REMAINING_ARRAY_LAYERS, the pname:layerCount
members must: match
pname:dstSubresource are ename:VK_REMAINING_ARRAY_LAYERS, the
pname:layerCount members must: match
* [[VUID-{refpage}-srcImage-08794]]
If pname:srcImage and pname:dstImage have the same elink:VkImageType,
and one of the pname:layerCount members of pname:srcSubresource or
Expand Down
2 changes: 1 addition & 1 deletion chapters/commonvalidity/draw_common.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2007,7 +2007,7 @@ ifdef::VK_EXT_line_rasterization[]
ename:VK_LINE_RASTERIZATION_MODE_DEFAULT_EXT, then the
<<features-stippledRectangularLines, pname:stippledRectangularLines>>
feature must: be enabled and
slink:VkPhysicalDeviceLimits::pname:strictLines must be VK_TRUE
slink:VkPhysicalDeviceLimits::pname:strictLines must be ename:VK_TRUE
endif::VK_EXT_line_rasterization[]
ifdef::VK_EXT_conservative_rasterization[]
* [[VUID-{refpage}-conservativePointAndLineRasterization-07499]]
Expand Down
4 changes: 2 additions & 2 deletions chapters/commonvalidity/image_blit_common.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ ifdef::VK_KHR_maintenance5[]
pname:dstSubresource must: not be ename:VK_REMAINING_ARRAY_LAYERS
* [[VUID-{refpage}-layerCount-08800]]
If neither of the pname:layerCount members of pname:srcSubresource or
pname:dstSubresource are VK_REMAINING_ARRAY_LAYERS, the pname:layerCount
members must: match
pname:dstSubresource are ename:VK_REMAINING_ARRAY_LAYERS, the
pname:layerCount members must: match
* [[VUID-{refpage}-layerCount-08801]]
If one of the pname:layerCount members of pname:srcSubresource or
pname:dstSubresource is ename:VK_REMAINING_ARRAY_LAYERS, the other
Expand Down
4 changes: 2 additions & 2 deletions chapters/commonvalidity/image_resolve_common.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ ifdef::VK_KHR_maintenance5[]
pname:dstSubresource must: not be ename:VK_REMAINING_ARRAY_LAYERS
* [[VUID-{refpage}-layerCount-08803]]
If neither of the pname:layerCount members of pname:srcSubresource or
pname:dstSubresource are VK_REMAINING_ARRAY_LAYERS, the pname:layerCount
members must: match
pname:dstSubresource are ename:VK_REMAINING_ARRAY_LAYERS, the
pname:layerCount members must: match
* [[VUID-{refpage}-layerCount-08804]]
If one of the pname:layerCount members of pname:srcSubresource or
pname:dstSubresource is ename:VK_REMAINING_ARRAY_LAYERS, the other
Expand Down
8 changes: 4 additions & 4 deletions chapters/descriptorsets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5605,7 +5605,7 @@ endif::VK_VERSION_1_2,VK_EXT_descriptor_indexing[]
be enabled
* [[VUID-vkGetDescriptorSetLayoutSizeEXT-layout-08012]]
pname:layout must: have been created with the
VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set
ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set
****

include::{generated}/validity/protos/vkGetDescriptorSetLayoutSizeEXT.adoc[]
Expand Down Expand Up @@ -5677,7 +5677,7 @@ endif::VK_VALVE_mutable_descriptor_type[]
be enabled
* [[VUID-vkGetDescriptorSetLayoutBindingOffsetEXT-layout-08014]]
pname:layout must: have been created with the
VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set
ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT flag set
****

include::{generated}/validity/protos/vkGetDescriptorSetLayoutBindingOffsetEXT.adoc[]
Expand Down Expand Up @@ -6183,8 +6183,8 @@ endif::VK_KHR_maintenance5[]
If <<limits-bufferlessPushDescriptors,
sname:VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:bufferlessPushDescriptors>>
is ename:VK_FALSE, and pname:usage contains
VK_BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, then the
pname:pNext chain must: include a
ename:VK_BUFFER_USAGE_PUSH_DESCRIPTORS_DESCRIPTOR_BUFFER_BIT_EXT, then
the pname:pNext chain must: include a
slink:VkDescriptorBufferBindingPushDescriptorBufferHandleEXT structure
* [[VUID-VkDescriptorBufferBindingInfoEXT-address-08057]]
pname:address must: be aligned to
Expand Down
4 changes: 2 additions & 2 deletions chapters/fragops.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -707,8 +707,8 @@ include::{generated}/api/protos/vkCmdSetSampleMaskEXT.adoc[]
recorded.
* pname:samples specifies the number of sample bits in the
pname:pSampleMask.
* pname:pSampleMask is a pointer to an array of VkSampleMask values, where
the array size is based on the pname:samples parameter.
* pname:pSampleMask is a pointer to an array of basetype:VkSampleMask
values, where the array size is based on the pname:samples parameter.

This command sets the sample mask for subsequent drawing commands
ifdef::VK_EXT_shader_object[]
Expand Down
2 changes: 1 addition & 1 deletion chapters/limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1673,7 +1673,7 @@ include::{generated}/api/structs/VkPhysicalDeviceMaintenance5PropertiesKHR.adoc[
<<fragops-shader, fragment shaders>> using the code:EarlyFragmentTests
execution mode.
* pname:depthStencilSwizzleOneSupport is a boolean indicating that
depth/stencil texturing operations with enum:VK_COMPONENT_SWIZZLE_ONE
depth/stencil texturing operations with ename:VK_COMPONENT_SWIZZLE_ONE
have defined behavior.
* pname:polygonModePointSize is a boolean value indicating whether the
point size of the final rasterization of polygons with
Expand Down
2 changes: 1 addition & 1 deletion chapters/pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4358,7 +4358,7 @@ ifdef::VK_EXT_shader_tile_image[]
slink:VkPipelineDynamicStateCreateInfo::pname:pDynamicStates, and the
fragment shader declares the code:EarlyFragmentTests execution mode and
uses code:OpStencilAttachmentReadEXT, the value of
slink::VkStencilOpState::pname:writeMask for both pname:front and
slink:VkStencilOpState::pname:writeMask for both pname:front and
pname:back in slink:VkPipelineDepthStencilStateCreateInfo must: be `0`
endif::VK_EXT_shader_tile_image[]
ifdef::VK_VERSION_1_3,VK_KHR_dynamic_rendering[]
Expand Down
8 changes: 4 additions & 4 deletions chapters/queries.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1857,7 +1857,7 @@ happens-after>> another timestamp write in the same submission must: not
have a lower value unless its value overflows the maximum supported integer
bit width of the query.
ifdef::VK_EXT_calibrated_timestamps[]
If apiext:`VK_EXT_calibrated_timestamps` is enabled, this extends to
If `apiext:VK_EXT_calibrated_timestamps` is enabled, this extends to
timestamp writes across all submissions on the same logical device: any
timestamp write that <<synchronization-dependencies-execution,
happens-after>> another must: not have a lower value unless its value
Expand All @@ -1877,7 +1877,7 @@ the execution time of a sequence of commands is only a reliable measurement
if the two timestamp writes were performed in the same
ifdef::VK_EXT_calibrated_timestamps[]
submission, or if the writes were performed on the same logical device and
apiext:`VK_EXT_calibrated_timestamps` is enabled.
`apiext:VK_EXT_calibrated_timestamps` is enabled.
endif::VK_EXT_calibrated_timestamps[]
ifndef::VK_EXT_calibrated_timestamps[]
submission.
Expand Down Expand Up @@ -1988,7 +1988,7 @@ happens-after>> another timestamp write in the same submission must: not
have a lower value unless its value overflows the maximum supported integer
bit width of the query.
ifdef::VK_EXT_calibrated_timestamps[]
If apiext:`VK_EXT_calibrated_timestamps` is enabled, this extends to
If `apiext:VK_EXT_calibrated_timestamps` is enabled, this extends to
timestamp writes across all submissions on the same logical device: any
timestamp write that <<synchronization-dependencies-execution,
happens-after>> another must: not have a lower value unless its value
Expand All @@ -2008,7 +2008,7 @@ the execution time of a sequence of commands is only a reliable measurement
if the two timestamp writes were performed in the same
ifdef::VK_EXT_calibrated_timestamps[]
submission, or if the writes were performed on the same logical device and
apiext:`VK_EXT_calibrated_timestamps` is enabled.
`apiext:VK_EXT_calibrated_timestamps` is enabled.
endif::VK_EXT_calibrated_timestamps[]
ifndef::VK_EXT_calibrated_timestamps[]
submission.
Expand Down
4 changes: 2 additions & 2 deletions chapters/renderpass.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3902,8 +3902,8 @@ include::{generated}/api/structs/VkMultisampledRenderToSingleSampledInfoEXT.adoc
* pname:multisampledRenderToSingleSampledEnable controls whether
multisampled rendering to single-sampled attachments is performed as
described <<multisampled-render-to-single-sampled, below>>.
* pname:rasterizationSamples is a VkSampleCountFlagBits specifying the
number of samples used in rasterization.
* pname:rasterizationSamples is a elink:VkSampleCountFlagBits specifying
the number of samples used in rasterization.

.Valid Usage
****
Expand Down
14 changes: 7 additions & 7 deletions chapters/resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -257,17 +257,17 @@ ifdef::VK_EXT_descriptor_buffer[]
ename:VK_BUFFER_USAGE_SAMPLER_DESCRIPTOR_BUFFER_BIT_EXT, creating this
sname:VkBuffer must: not cause the total required space for all
currently valid buffers using this flag on the device to exceed
VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:samplerDescriptorBufferAddressSpaceSize
slink:VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:samplerDescriptorBufferAddressSpaceSize
or
VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:descriptorBufferAddressSpaceSize
slink:VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:descriptorBufferAddressSpaceSize
* [[VUID-VkBufferCreateInfo-usage-08098]]
If pname:usage includes
ename:VK_BUFFER_USAGE_RESOURCE_DESCRIPTOR_BUFFER_BIT_EXT, creating this
sname:VkBuffer must: not cause the total required space for all
currently valid buffers using this flag on the device to exceed
VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:resourceDescriptorBufferAddressSpaceSize
slink:VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:resourceDescriptorBufferAddressSpaceSize
or
VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:descriptorBufferAddressSpaceSize
slink:VkPhysicalDeviceDescriptorBufferPropertiesEXT::pname:descriptorBufferAddressSpaceSize
* [[VUID-VkBufferCreateInfo-flags-08099]]
If pname:flags includes
ename:VK_BUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT, the
Expand Down Expand Up @@ -1073,9 +1073,9 @@ ifdef::VK_KHR_maintenance5[]
* [[VUID-VkBufferViewCreateInfo-pNext-08781]]
If the pname:pNext chain includes a
slink:VkBufferUsageFlags2CreateInfoKHR, its pname:usage must: be a
subset of the VkBufferCreateInfo::usage specified or
VkBufferUsageFlags2CreateInfoKHR::usage from VkBufferCreateInfo::pNext
when creating pname:buffer
subset of the slink:VkBufferCreateInfo::pname:usage specified or
slink:VkBufferUsageFlags2CreateInfoKHR::pname:usage from
slink:VkBufferCreateInfo::pname:pNext when creating pname:buffer
endif::VK_KHR_maintenance5[]
****

Expand Down
2 changes: 1 addition & 1 deletion chapters/synchronization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1477,7 +1477,7 @@ ifdef::VK_NV_device_generated_commands[]
Such access occurs in the
ename:VK_PIPELINE_STAGE_COMMAND_PREPROCESS_BIT_NV pipeline stage.
* ename:VK_ACCESS_COMMAND_PREPROCESS_WRITE_BIT_NV specifies writes to the
target command buffer:VkBuffer preprocess outputs in
target command buffer preprocess outputs in
flink:vkCmdPreprocessGeneratedCommandsNV.
Such access occurs in the
ename:VK_PIPELINE_STAGE_COMMAND_PREPROCESS_BIT_NV pipeline stage.
Expand Down
2 changes: 1 addition & 1 deletion chapters/textures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3544,7 +3544,7 @@ slink:VkPhysicalDeviceImageProcessingPropertiesQCOM.code:maxBoxFilterBlockSize.
The input code:sampler must: be created with code:addressModeU and
code:addressModeV, equal to ename:VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, or
ename:VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER with
VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK.
ename:VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK.


[[textures-boxfilter-filteroperation]]
Expand Down

0 comments on commit 8b900b9

Please sign in to comment.