Skip to content

Commit

Permalink
Fix some markup (#900)
Browse files Browse the repository at this point in the history
* Fix some markup

* Fix some more markup
  • Loading branch information
krOoze authored and oddhack committed Jan 28, 2019
1 parent 30f7463 commit e666c58
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 47 deletions.
4 changes: 2 additions & 2 deletions chapters/VK_EXT_debug_utils.txt
Expand Up @@ -418,8 +418,8 @@ sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageSeverity and
sname:VkDebugUtilsMessengerCreateInfoEXT::pname:messageType determine when
that sname:VkDebugUtilsMessengerCreateInfoEXT::pname:pfnUserCallback is
called.
The process to determine if the user's pfnUserCallback is triggered when an
event occurs is as follows:
The process to determine if the user's pname:pfnUserCallback is triggered
when an event occurs is as follows:

. The implementation will perform a bitwise AND of the event's
elink:VkDebugUtilsMessageSeverityFlagBitsEXT with the
Expand Down
4 changes: 2 additions & 2 deletions chapters/VK_KHR_incremental_present/wsi.txt
Expand Up @@ -37,8 +37,8 @@ include::../../api/structs/VkPresentRegionsKHR.txt[]
* [[VUID-VkPresentRegionsKHR-swapchainCount-01260]]
pname:swapchainCount must: be the same value as
sname:VkPresentInfoKHR::pname:swapchainCount, where
sname:VkPresentInfoKHR is in the pNext-chain of this
sname:VkPresentRegionsKHR structure.
sname:VkPresentInfoKHR is in the pname:pNext chain of this
sname:VkPresentRegionsKHR structure
****

include::../../validity/structs/VkPresentRegionsKHR.txt[]
Expand Down
2 changes: 1 addition & 1 deletion chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt
Expand Up @@ -32,7 +32,7 @@ will reflect that size.
In this case, applications should use the same size for the swapchain's
pname:imageExtent.
Otherwise, the pname:currentExtent will have the special value
[eq]#(0xFFFFFFFF, 0xFFFFFFFF), indicating that applications are expected to
[eq]#(0xFFFFFFFF, 0xFFFFFFFF)#, indicating that applications are expected to
choose an appropriate size for the swapchain's pname:imageExtent (e.g., by
matching the result of a call to
code:nn::code:vi::code:GetDisplayResolution).
Expand Down
22 changes: 11 additions & 11 deletions chapters/VK_NVX_device_generated_commands/generation.txt
Expand Up @@ -116,42 +116,42 @@ include::../../api/structs/VkCmdProcessCommandsInfoNVX.txt[]
****
* [[VUID-VkCmdProcessCommandsInfoNVX-objectTable-01331]]
The provided pname:objectTable must: include all objects referenced by
the generation process.
the generation process
* [[VUID-VkCmdProcessCommandsInfoNVX-indirectCommandsTokenCount-01332]]
pname:indirectCommandsTokenCount must: match the
pname:indirectCommandsLayout's pname:tokenCount.
pname:indirectCommandsLayout's pname:tokenCount
* [[VUID-VkCmdProcessCommandsInfoNVX-tokenType-01333]]
The pname:tokenType member of each entry in the
pname:pIndirectCommandsTokens array must: match the values used at
creation time of pname:indirectCommandsLayout
* [[VUID-VkCmdProcessCommandsInfoNVX-targetCommandBuffer-01334]]
If pname:targetCommandBuffer is provided, it must: have reserved command
space.
space
* [[VUID-VkCmdProcessCommandsInfoNVX-targetCommandBuffer-01335]]
If pname:targetCommandBuffer is provided, the pname:objectTable must:
match the reservation's objectTable and must: have had all referenced
objects registered at reservation time.
match the reservation's pname:objectTable and must: have had all
referenced objects registered at reservation time
* [[VUID-VkCmdProcessCommandsInfoNVX-targetCommandBuffer-01336]]
If pname:targetCommandBuffer is provided, the
pname:indirectCommandsLayout must: match the reservation's
indirectCommandsLayout.
pname:indirectCommandsLayout
* [[VUID-VkCmdProcessCommandsInfoNVX-targetCommandBuffer-01337]]
If pname:targetCommandBuffer is provided, the pname:maxSequencesCount
must: not exceed the reservation's maxSequencesCount.
must: not exceed the reservation's pname:maxSequencesCount
* [[VUID-VkCmdProcessCommandsInfoNVX-sequencesCountBuffer-01338]]
If pname:sequencesCountBuffer is used, its usage flag must: have
ename:VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set.
the ename:VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
* [[VUID-VkCmdProcessCommandsInfoNVX-sequencesCountBuffer-01339]]
If pname:sequencesCountBuffer is used, pname:sequencesCountOffset must:
be aligned to
sname:VkDeviceGeneratedCommandsLimitsNVX::pname:minSequenceCountBufferOffsetAlignment.
sname:VkDeviceGeneratedCommandsLimitsNVX::pname:minSequenceCountBufferOffsetAlignment
* [[VUID-VkCmdProcessCommandsInfoNVX-sequencesIndexBuffer-01340]]
If pname:sequencesIndexBuffer is used, its usage flag must: have
ename:VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set.
the ename:VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
* [[VUID-VkCmdProcessCommandsInfoNVX-sequencesIndexBuffer-01341]]
If pname:sequencesIndexBuffer is used, pname:sequencesIndexOffset must:
be aligned to
sname:VkDeviceGeneratedCommandsLimitsNVX::pname:minSequenceIndexBufferOffsetAlignment.
sname:VkDeviceGeneratedCommandsLimitsNVX::pname:minSequenceIndexBufferOffsetAlignment
****

include::../../validity/structs/VkCmdProcessCommandsInfoNVX.txt[]
Expand Down
12 changes: 6 additions & 6 deletions chapters/descriptorsets.txt
Expand Up @@ -3818,8 +3818,8 @@ include::../api/protos/vkCmdPushDescriptorSetWithTemplateKHR.txt[]

* pname:commandBuffer is the command buffer that the descriptors will be
recorded in.
* pname:descriptorUpdateTemplate A descriptor update template which
defines how to interpret the descriptor information in pData.
* pname:descriptorUpdateTemplate is a descriptor update template that
defines how to interpret the descriptor information in pname:pData.
* pname:layout is a slink:VkPipelineLayout object used to program the
bindings.
It must: be compatible with the layout used to create the
Expand All @@ -3828,15 +3828,15 @@ include::../api/protos/vkCmdPushDescriptorSetWithTemplateKHR.txt[]
that will be updated.
This must: be the same number used to create the
pname:descriptorUpdateTemplate handle.
* pname:pData Points to memory which contains the descriptors for the
* pname:pData points to memory which contains the descriptors for the
templated update.

.Valid Usage
****
* [[VUID-vkCmdPushDescriptorSetWithTemplateKHR-commandBuffer-00366]]
The pipelineBindPoint specified during the creation of the descriptor
update template must: be supported by the pname:commandBuffer's parent
sname:VkCommandPool's queue family
The pname:pipelineBindPoint specified during the creation of the
descriptor update template must: be supported by the
pname:commandBuffer's parent sname:VkCommandPool's queue family
* [[VUID-vkCmdPushDescriptorSetWithTemplateKHR-pData-01686]]
pname:pData must: be a valid pointer to a memory that contains one or
more valid instances of slink:VkDescriptorImageInfo,
Expand Down
11 changes: 6 additions & 5 deletions chapters/dispatch.txt
Expand Up @@ -30,8 +30,8 @@ include::../api/protos/vkCmdDispatch.txt[]
dimension.

When the command is executed, a global workgroup consisting of
[eq]#groupCountX {times} groupCountY {times} groupCountZ# local workgroups
is assembled.
[eq]#pname:groupCountX {times} pname:groupCountY {times} pname:groupCountZ#
local workgroups is assembled.

.Valid Usage
****
Expand Down Expand Up @@ -352,9 +352,10 @@ endif::VK_KHR_device_group[]
dimension.

When the command is executed, a global workgroup consisting of
[eq]#groupCountX {times} groupCountY {times} groupCountZ# local workgroups
is assembled, with code:WorkgroupId values ranging from [eq]#[baseGroup,
baseGroup {plus} groupCount)# in each component.
[eq]#pname:groupCountX {times} pname:groupCountY {times} pname:groupCountZ#
local workgroups is assembled, with code:WorkgroupId values ranging from
[eq]#[ptext:baseGroup*, ptext:baseGroup* {plus} ptext:groupCount*)# in each
component.
flink:vkCmdDispatch is equivalent to
`vkCmdDispatchBase(0,0,0,groupCountX,groupCountY,groupCountZ)`.

Expand Down
8 changes: 4 additions & 4 deletions chapters/drawing.txt
Expand Up @@ -777,9 +777,9 @@ The assembled primitives execute the bound graphics pipeline.
ename:VK_PIPELINE_BIND_POINT_GRAPHICS requires any dynamic state, that
state must: have been set on the current command buffer
* [[VUID-vkCmdDrawIndexed-indexSize-00463]]
[eq]#(pname:indexSize * (pname:firstIndex {plus} pname:indexCount)
[eq]#(code:indexSize * (pname:firstIndex {plus} pname:indexCount)
{plus} pname:offset)# must: be less than or equal to the size of the
bound index buffer, with indexSize being based on the type specified by
bound index buffer, with code:indexSize being based on the type specified by
pname:indexType, where the index buffer, pname:indexType, and
pname:offset are specified via fname:vkCmdBindIndexBuffer
* [[VUID-vkCmdDrawIndexed-None-00464]]
Expand Down Expand Up @@ -1773,9 +1773,9 @@ the similarly named parameters of flink:vkCmdDrawIndexed.
entirely contained within the corresponding vertex buffer binding, as
described in <<fxvertex-input>>
* [[VUID-VkDrawIndexedIndirectCommand-indexSize-00553]]
[eq]#(pname:indexSize * (pname:firstIndex {plus} pname:indexCount)
[eq]#(code:indexSize * (pname:firstIndex {plus} pname:indexCount)
{plus} pname:offset)# must: be less than or equal to the size of the
bound index buffer, with pname:indexSize being based on the type
bound index buffer, with code:indexSize being based on the type
specified by pname:indexType, where the index buffer, pname:indexType,
and pname:offset are specified via fname:vkCmdBindIndexBuffer
* [[VUID-VkDrawIndexedIndirectCommand-firstInstance-00554]]
Expand Down
2 changes: 1 addition & 1 deletion chapters/features.txt
Expand Up @@ -4292,7 +4292,7 @@ whether or not the feature is enabled.
| code:uint32_t | pname:maxMemoryAllocationCount | -
| code:uint32_t | pname:maxSamplerAllocationCount | -
| basetype:VkDeviceSize | pname:bufferImageGranularity | -
| basetype:VkDeviceSize | pname:sparseAddressSpaceSize | sparseBinding
| basetype:VkDeviceSize | pname:sparseAddressSpaceSize | pname:sparseBinding
| code:uint32_t | pname:maxBoundDescriptorSets | -
| code:uint32_t | pname:maxPerStageDescriptorSamplers | -
| code:uint32_t | pname:maxPerStageDescriptorUniformBuffers | -
Expand Down
4 changes: 2 additions & 2 deletions chapters/fragops.txt
Expand Up @@ -1367,8 +1367,8 @@ each be modulated (multiplied) by that color sample's associated value of
Which components are modulated is controlled by
pname:coverageModulationMode.

If this structure is not present, it is as if coverageModulationMode is
ename:VK_COVERAGE_MODULATION_MODE_NONE_NV.
If this structure is not present, it is as if pname:coverageModulationMode
is ename:VK_COVERAGE_MODULATION_MODE_NONE_NV.

.Valid Usage
****
Expand Down
6 changes: 3 additions & 3 deletions chapters/interfaces.txt
Expand Up @@ -389,11 +389,11 @@ not be two output variables which have the same location, component, and
index, either explicitly declared or implied.

Output values written by a fragment shader must: be declared with either
code:OpTypeFloat or code:OpTypeInt, and a Width of 32.
code:OpTypeFloat or code:OpTypeInt, and a code:Width of 32.
ifdef::VK_VERSION_1_1,VK_KHR_16bit_storage[]
If pname:storageInputOutput16 is supported, output values written by a
fragment shader can: be also declared with either code:OpTypeFloat or
code:OpTypeInt and a Width of 16.
code:OpTypeInt and a code:Width of 16.
endif::VK_VERSION_1_1,VK_KHR_16bit_storage[]
Composites of these types are also permitted.
If the color attachment has a signed or unsigned normalized fixed-point
Expand Down Expand Up @@ -1228,7 +1228,7 @@ The code:BaseVertex decoration must: be used only within vertex shaders.
The variable decorated with code:BaseVertex must: be declared using the
input storage class.
+
The variable decorated with codeBaseVertex must: be declared as a scalar
The variable decorated with code:BaseVertex must: be declared as a scalar
32-bit integer.

endif::VK_VERSION_1_1,VK_KHR_shader_draw_parameters[]
Expand Down
2 changes: 1 addition & 1 deletion chapters/memory.txt
Expand Up @@ -3170,7 +3170,7 @@ endif::VK_KHR_device_group[]
* [[VUID-vkGetDeviceGroupPeerMemoryFeatures-remoteDeviceIndex-00693]]
pname:remoteDeviceIndex must: be a valid device index
* [[VUID-vkGetDeviceGroupPeerMemoryFeatures-localDeviceIndex-00694]]
pname:localDeviceIndex must: not equal remoteDeviceIndex
pname:localDeviceIndex must: not equal pname:remoteDeviceIndex
****

include::../validity/protos/vkGetDeviceGroupPeerMemoryFeatures.txt[]
Expand Down
2 changes: 1 addition & 1 deletion chapters/renderpass.txt
Expand Up @@ -638,7 +638,7 @@ endif::VK_KHR_maintenance2[]
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:aspectReferenceCount is the number of elements in the
pAspectReferences array.
pname:pAspectReferences array.
* pname:pAspectReferences points to an array of pname:aspectReferenceCount
number of slink:VkInputAttachmentAspectReference structures describing
which aspect(s) can: be accessed for a given input attachment within a
Expand Down
6 changes: 3 additions & 3 deletions chapters/resources.txt
Expand Up @@ -3531,13 +3531,13 @@ a render pass instance still apply to the entire subresource referenced
which includes all the slices of the selected mip level.
endif::VK_VERSION_1_1,VK_KHR_maintenance1[]

When using an imageView of a depth/stencil image to populate a descriptor
When using an image view of a depth/stencil image to populate a descriptor
set (e.g. for sampling in the shader, or for use as an input attachment),
the pname:aspectMask must: only include one bit and selects whether the
imageView is used for depth reads (i.e. using a floating-point sampler or
image view is used for depth reads (i.e. using a floating-point sampler or
input attachment in the shader) or stencil reads (i.e. using an unsigned
integer sampler or input attachment in the shader).
When an imageView of a depth/stencil image is used as a depth/stencil
When an image view of a depth/stencil image is used as a depth/stencil
framebuffer attachment, the pname:aspectMask is ignored and both depth and
stencil image subresources are used.

Expand Down
10 changes: 6 additions & 4 deletions chapters/sparsemem.txt
Expand Up @@ -1471,8 +1471,9 @@ binding range specified must: be within the mip tail region of the metadata
aspect.
In this case the pname:resourceOffset is not required: to be a simple device
address offset within the resource.
However, it _is_ defined to be within [eq]#[imageMipTailOffset,
imageMipTailOffset {plus} imageMipTailSize)# for the metadata aspect.
However, it _is_ defined to be within [eq]#[pname:imageMipTailOffset,
pname:imageMipTailOffset {plus} pname:imageMipTailSize)# for the metadata
aspect.
See slink:VkSparseMemoryBind for the full constraints on binding region with
this flag present.
====
Expand All @@ -1498,7 +1499,7 @@ include::../api/structs/VkSparseImageMemoryBindInfo.txt[]

* pname:image is the slink:VkImage object to be bound
* pname:bindCount is the number of slink:VkSparseImageMemoryBind
structures in pBinds array
structures in pname:pBinds array
* pname:pBinds is a pointer to array of slink:VkSparseImageMemoryBind
structures

Expand All @@ -1524,7 +1525,8 @@ The sname:VkSparseImageMemoryBind structure is defined as:

include::../api/structs/VkSparseImageMemoryBind.txt[]

* pname:subresource is the aspectMask and region of interest in the image.
* pname:subresource is the image _aspect_ and region of interest in the
image.
* pname:offset are the coordinates of the first texel within the image
subresource to bind.
* pname:extent is the size in texels of the region within the image
Expand Down
2 changes: 1 addition & 1 deletion config/vulkan-macros/extension.rb
Expand Up @@ -204,7 +204,7 @@ class BasetypeInlineMacro < CodeInlineMacroBase

class CodeInlineMacro < StrongInlineMacroBase
named :code
match /code:(\w+)/
match /code:(\w+(\.\w+)*)/
end

# The tag: and attr: macros are only used in registry.txt
Expand Down

0 comments on commit e666c58

Please sign in to comment.