Skip to content

Commit

Permalink
Fix documentation caption levels (#818)
Browse files Browse the repository at this point in the history
* Fix caption levels

Convert new markdown file to asciidoc

* Fix caption levels

Convert new markdown file to asciidoc
  • Loading branch information
SaschaWillems authored Oct 9, 2023
1 parent fcddce0 commit 2ccda98
Show file tree
Hide file tree
Showing 28 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion samples/api/compute_nbody/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Compute shader N-Body simulation
= Compute shader N-Body simulation

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/compute_nbody[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/dynamic_uniform_buffers/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Dynamic Uniform buffers
= Dynamic Uniform buffers

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/dynamic_uniform_buffers[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hdr/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== High dynamic range
= High dynamic range

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hdr[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hello_triangle/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Hello Triangle
= Hello Triangle

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hello_triangle[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_compute_nbody/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== HPP Compute shader N-Body simulation
= HPP Compute shader N-Body simulation

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_compute_nbody[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_dynamic_uniform_buffers/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== HPP Dynamic Uniform Buffers
= HPP Dynamic Uniform Buffers

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_dynamic_uniform_buffers[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_hdr/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== HPP High dynamic range
= HPP High dynamic range

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_hdr[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_hello_triangle/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== HPP Hello Triangle
= HPP Hello Triangle

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_hello_triangle[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_instancing/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== HPP Instancing
= HPP Instancing

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_instancing[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_terrain_tessellation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== Terrain Tessellation with Vulkan-Hpp
= Terrain Tessellation with Vulkan-Hpp

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_terrain_tessellation[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/hpp_texture_loading/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
////
:pp: {plus}{plus}
=== Texture Loading with Vulkan-Hpp
= Texture Loading with Vulkan-Hpp

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hpp_texture_loading[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/instancing/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Instancing
= Instancing

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/instancing[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/swapchain_recreation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Swapchain Recreation +
= Swapchain Recreation

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/swapchain_recreation[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/terrain_tessellation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Terrain Tessellation
= Terrain Tessellation

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/terrain_tessellation[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/api/texture_loading/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Texture loading
= Texture loading

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/texture_loading[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/conservative_rasterization/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Conservative Rasterization
= Conservative Rasterization

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/conservative_rasterization[Khronos Vulkan samples github repository].
Expand Down
10 changes: 5 additions & 5 deletions samples/extensions/dynamic_blending/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
-
////
== Dynamic blending
= Dynamic blending

=== Overview
== Overview

This sample demonstrates the functionality of VK_EXT_extended_dynamic_state3 related to blending. It includes the
following features:
Expand All @@ -29,7 +29,7 @@ following features:
* `vkCmdSetColorBlendAdvancedEXT`: utilizes more complex blending operators.
* `vkCmdSetColorWriteMaskEXT`: toggles individual channels on and off.

=== How to use in Vulkan
== How to use in Vulkan

To utilize this feature, the device extension `VK_EXT_EXTENDED_DYNAMIC_STATE_3_EXTENSION_NAME` need to be enabled.
The extension `VK_EXT_BLEND_OPERATION_ADVANCED_EXTENSION_NAME` is required for the advanced blend equations.
Expand All @@ -46,7 +46,7 @@ blending operators and premultiplication for color blending.
`VkColorComponentFlags` objects. These objects can be created by combining
the desired color bit flags using bitwise oring.

=== The sample
== The sample

The sample demonstrates how to set up an application to work with this
extension:
Expand All @@ -56,7 +56,7 @@ extension:

The sample demonstrates how the use of each operator affects color blending.

=== Documentation links
== Documentation links

https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetColorBlendEnableEXT.html

Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/fragment_shading_rate/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Fragment shading rate
= Fragment shading rate

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/fragment_shading_rate[Khronos Vulkan samples github repository].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
== Fragment Shading Rate
= Fragment Shading Rate

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/fragment_shading_rate_dynamic[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/mesh_shading/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
== Mesh shading
= Mesh shading

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/mesh_shading[Khronos Vulkan samples github repository].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--
////
- Copyright (c) 2023, Arm Limited and Contributors
-
- SPDX-License-Identifier: Apache-2.0
Expand All @@ -15,8 +15,8 @@
- See the License for the specific language governing permissions and
- limitations under the License.
-
-->
////
# OpenCL common source files
= OpenCL common source files

This folder does not contain a sample, but only OpenCL related units shared by the OpenCL interoperability samples in this repository.
2 changes: 1 addition & 1 deletion samples/extensions/open_gl_interop/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== OpenGL interoperability
= OpenGL interoperability

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/open_gl_interop[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/push_descriptors/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Push Descriptors
= Push Descriptors

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/push_descriptors[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/ray_queries/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Basic ray queries
= Basic ray queries

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/ray_queries[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/ray_tracing_basic/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Basic hardware accelerated ray tracing
= Basic hardware accelerated ray tracing

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/ray_tracing_basic[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/raytracing_basic/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Basic hardware accelerated ray tracing
= Basic hardware accelerated ray tracing

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/raytracing_basic[Khronos Vulkan samples github repository].
Expand Down
2 changes: 1 addition & 1 deletion samples/extensions/synchronization_2/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
=== Synchronization2
= Synchronization2

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/extensions/synchronization_2[Khronos Vulkan samples github repository].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-
////
== Texture compression comparison
= Texture compression comparison

ifdef::site-gen-antora[]
TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/performance/texture_compression_comparison[Khronos Vulkan samples github repository].
Expand Down

0 comments on commit 2ccda98

Please sign in to comment.