Skip to content

Commit

Permalink
Fix references to images in proposal documents (#2441)
Browse files Browse the repository at this point in the history
* Make proposal images work in github repository rendering

* Fix images pathname

* Propagate everything under images/proposals/ into the Antora features module
  • Loading branch information
oddhack authored Oct 3, 2024
1 parent 486e4b2 commit 817d35d
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 2 deletions.
2 changes: 1 addition & 1 deletion antora/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ setup_features: features_nav
-root . \
-component $(shell realpath antora/features/modules/features) \
-xrefpath antora/features \
./images/tile_image.svg \
`find ./images/proposals -type f` \
`find ./proposals -name '[A-Za-z]*.adoc'`

# Construct the features nav.adoc from the current list of
Expand Down
9 changes: 9 additions & 0 deletions antora/features/modules/features/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@
* xref:proposals/Roadmap.adoc[Vulkan Roadmap]
* Feature Descriptions
** xref:proposals/VK_AMDX_shader_enqueue.adoc[]
** xref:proposals/VK_AMD_anti_lag.adoc[]
** xref:proposals/VK_AMD_shader_early_and_late_fragment_tests.adoc[]
** xref:proposals/VK_ANDROID_external_format_resolve.adoc[]
** xref:proposals/VK_ARM_render_pass_striped.adoc[]
** xref:proposals/VK_EXT_attachment_feedback_loop_dynamic_state.adoc[]
** xref:proposals/VK_EXT_attachment_feedback_loop_layout.adoc[]
** xref:proposals/VK_EXT_calibrated_timestamps.adoc[]
** xref:proposals/VK_EXT_depth_bias_control.adoc[]
** xref:proposals/VK_EXT_depth_clamp_control.adoc[]
** xref:proposals/VK_EXT_descriptor_buffer.adoc[]
** xref:proposals/VK_EXT_device_fault.adoc[]
** xref:proposals/VK_EXT_device_generated_commands.adoc[]
** xref:proposals/VK_EXT_dynamic_rendering_unused_attachments.adoc[]
** xref:proposals/VK_EXT_extended_dynamic_state3.adoc[]
** xref:proposals/VK_EXT_external_memory_acquire_unmodified.adoc[]
Expand All @@ -30,6 +33,7 @@
** xref:proposals/VK_EXT_image_sliced_view_of_3d.adoc[]
** xref:proposals/VK_EXT_layer_settings.adoc[]
** xref:proposals/VK_EXT_legacy_dithering.adoc[]
** xref:proposals/VK_EXT_legacy_vertex_attributes.adoc[]
** xref:proposals/VK_EXT_map_memory_placed.adoc[]
** xref:proposals/VK_EXT_mesh_shader.adoc[]
** xref:proposals/VK_EXT_metal_objects.adoc[]
Expand All @@ -43,13 +47,15 @@
** xref:proposals/VK_EXT_rasterization_order_attachment_access.adoc[]
** xref:proposals/VK_EXT_shader_module_identifier.adoc[]
** xref:proposals/VK_EXT_shader_object.adoc[]
** xref:proposals/VK_EXT_shader_replicated_composites.adoc[]
** xref:proposals/VK_EXT_shader_tile_image.adoc[]
** xref:proposals/VK_EXT_subpass_merge_feedback.adoc[]
** xref:proposals/VK_EXT_surface_maintenance1.adoc[]
** xref:proposals/VK_EXT_swapchain_maintenance1.adoc[]
** xref:proposals/VK_GOOGLE_surfaceless_query.adoc[]
** xref:proposals/VK_HUAWEI_cluster_culling_shader.adoc[]
** xref:proposals/VK_HUAWEI_invocation_mask.adoc[]
** xref:proposals/VK_KHR_compute_shader_derivatives.adoc[]
** xref:proposals/VK_KHR_cooperative_matrix.adoc[]
** xref:proposals/VK_KHR_dynamic_rendering.adoc[]
** xref:proposals/VK_KHR_dynamic_rendering_local_read.adoc[]
Expand All @@ -58,13 +64,16 @@
** xref:proposals/VK_KHR_load_store_op_none.adoc[]
** xref:proposals/VK_KHR_maintenance5.adoc[]
** xref:proposals/VK_KHR_maintenance6.adoc[]
** xref:proposals/VK_KHR_maintenance7.adoc[]
** xref:proposals/VK_KHR_map_memory2.adoc[]
** xref:proposals/VK_KHR_pipeline_binary.adoc[]
** xref:proposals/VK_KHR_ray_tracing_position_fetch.adoc[]
** xref:proposals/VK_KHR_shader_expect_assume.adoc[]
** xref:proposals/VK_KHR_shader_float_controls2.adoc[]
** xref:proposals/VK_KHR_shader_integer_dot_product.adoc[]
** xref:proposals/VK_KHR_shader_maximal_reconvergence.adoc[]
** xref:proposals/VK_KHR_shader_quad_control.adoc[]
** xref:proposals/VK_KHR_shader_relaxed_extended_instruction.adoc[]
** xref:proposals/VK_KHR_shader_subgroup_rotate.adoc[]
** xref:proposals/VK_KHR_vertex_attribute_divisor.adoc[]
** xref:proposals/VK_KHR_video_decode_av1.adoc[]
Expand Down
File renamed without changes
2 changes: 2 additions & 0 deletions proposals/VK_EXT_device_generated_commands.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
:toc: left
:refpage: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/
:sectnums:
// Required so images render in github
ifndef::images[:images: ../images]

This document details API design for indirect execution of device generated commands, improving performance by eliminating unnecessary host and device work.

Expand Down
6 changes: 5 additions & 1 deletion proposals/VK_EXT_shader_tile_image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
:toc: left
:refpage: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/
:sectnums:
// Required so images render in github
ifndef::images[:images: ../images]

`VK_EXT_shader_tile_image` is a device extension that explicitly enables access to on-chip pixel data. For GPUs supporting this extension, it is a replacement for many use-cases for subpasses, which are not available when the `VK_KHR_dynamic_rendering` extension is used.

Expand Down Expand Up @@ -85,7 +87,9 @@ Tile image variables currently have to 'alias' a color attachment location, and

=== Concept

image::{images}/tile_image.svg[align="center",title="Tile Image",align="center",opts="{imageopts}"]
images = {images} path = {images}/proposals/tile_image.svg

image::{images}/proposals/tile_image.svg[align="center",title="Tile Image",align="center",opts="{imageopts}"]

Introduce the concept of a 'tile image'. When the extension is enabled, the framebuffer is logically divided into a grid of non-overlapping tiles called tile images.

Expand Down
10 changes: 10 additions & 0 deletions proposals/template.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
:toc: left
:refpage: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/
:sectnums:
// Required so images render in github
ifndef::images[:images: ../images]

.How to Use This Document
[NOTE]
Expand All @@ -20,6 +22,14 @@ GitHub and GitLab asciidoctor renderers.
When calling out existing API constructs or extensions, the `refpage` attribute should be used to link to the relevant Khronos reference page.
For example - "...used to extend link:{refpage}VkGraphicsPipelineCreateInfo.html[VkGraphicsPipelineCreateInfo]..."
If adding an image to a proposal document, it must be located in
`../images/proposals/`, and referred to as
[source,asciidoc]
----
image::{images}/proposals/filename.svg[image options]
----
====

A short summary of this proposal should be written here.
Expand Down

0 comments on commit 817d35d

Please sign in to comment.