Skip to content

Commit 4dcb0f0

Browse files
committed
Fix Antora bugs related to using xref instead of Link.
1 parent a7178c7 commit 4dcb0f0

13 files changed

Lines changed: 52 additions & 52 deletions

File tree

en/Building_a_Simple_Engine/Advanced_Topics/01_introduction.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ Welcome — this section collects short, conversational guides that explain what
66

77
Start anywhere that matches your interest:
88

9-
* xref:Planar_Reflections.adoc[Planar Reflections]
10-
* xref:Ray_Query_Rendering.adoc[Ray Query Rendering]
11-
* xref:Ray_Query_Reflections_and_Transparency.adoc[Ray Query Reflections and Transparency]
12-
* xref:Rendering_Pipeline_Overview.adoc[Rendering Pipeline Overview]
13-
* xref:Forward_ForwardPlus_Deferred.adoc[Forward, Forward+, Deferred]
14-
* xref:ForwardPlus_Rendering.adoc[Forward+ Rendering]
15-
* xref:Culling.adoc[Frustum Culling and Distance LOD]
16-
* xref:Mipmaps_and_LOD.adoc[Mipmaps and LOD]
17-
* xref:GLTF_Animation.adoc[glTF Animation & Transform Composition]
18-
* xref:Push_Constants_Per_Object.adoc[Push Constants (per‑object material)]
19-
* xref:Descriptor_Indexing_UpdateAfterBind.adoc[Descriptor Indexing & Stable Updates]
20-
* xref:Separate_Image_Sampler_Descriptors.adoc[Separate Image/Sampler]
21-
* xref:Synchronization_and_Streaming.adoc[Synchronization & Streaming]
22-
* xref:Synchronization_2_Frame_Pacing.adoc[Synchronization 2 & Frame Pacing]
23-
* xref:Robustness2.adoc[VK_EXT_robustness2]
24-
* xref:Dynamic_Rendering_Local_Read.adoc[Dynamic Rendering Local Read]
25-
* xref:Shader_Tile_Image.adoc[Shader Tile Image]
9+
* link:Planar_Reflections.adoc[Planar Reflections]
10+
* link:Ray_Query_Rendering.adoc[Ray Query Rendering]
11+
* link:Ray_Query_Reflections_and_Transparency.adoc[Ray Query Reflections and Transparency]
12+
* link:Rendering_Pipeline_Overview.adoc[Rendering Pipeline Overview]
13+
* link:Forward_ForwardPlus_Deferred.adoc[Forward, Forward+, Deferred]
14+
* link:ForwardPlus_Rendering.adoc[Forward+ Rendering]
15+
* link:Culling.adoc[Frustum Culling and Distance LOD]
16+
* link:Mipmaps_and_LOD.adoc[Mipmaps and LOD]
17+
* link:GLTF_Animation.adoc[glTF Animation & Transform Composition]
18+
* link:Push_Constants_Per_Object.adoc[Push Constants (per‑object material)]
19+
* link:Descriptor_Indexing_UpdateAfterBind.adoc[Descriptor Indexing & Stable Updates]
20+
* link:Separate_Image_Sampler_Descriptors.adoc[Separate Image/Sampler]
21+
* link:Synchronization_and_Streaming.adoc[Synchronization & Streaming]
22+
* link:Synchronization_2_Frame_Pacing.adoc[Synchronization 2 & Frame Pacing]
23+
* link:Robustness2.adoc[VK_EXT_robustness2]
24+
* link:Dynamic_Rendering_Local_Read.adoc[Dynamic Rendering Local Read]
25+
* link:Shader_Tile_Image.adoc[Shader Tile Image]
2626

2727
link:../index.html[Back to Building a Simple Engine]

en/Building_a_Simple_Engine/Appendix/appendix.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,5 +335,5 @@ When designing your engine architecture, consider:
335335
3. *Team Size and Experience* - More complex architectures may be harder to work with for smaller teams.
336336
4. *Project Scope* - A small project may not need the complexity of a full ECS.
337337

338-
xref:../Engine_Architecture/02_architectural_patterns.adoc[Back to Architectural Patterns]
339-
xref:../Engine_Architecture/05_rendering_pipeline.adoc[Back to Rendering Pipeline]
338+
link:../Engine_Architecture/02_architectural_patterns.adoc[Back to Architectural Patterns]
339+
link:../Engine_Architecture/05_rendering_pipeline.adoc[Back to Rendering Pipeline]

en/Building_a_Simple_Engine/Camera_Transformations/01_introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Before starting this chapter, you should have completed the main Vulkan tutorial
2828
* xref:../../05_Uniform_buffers/00_Descriptor_set_layout_and_buffer.adoc[Uniform buffers]
2929
* Basic programming concepts and C++
3030

31-
xref:02_math_foundations.adoc[Next: Mathematical Foundations]
31+
link:02_math_foundations.adoc[Next: Mathematical Foundations]

en/Building_a_Simple_Engine/Camera_Transformations/04_camera_implementation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,9 +686,9 @@ void gameLoop(float deltaTime) {
686686

687687
[NOTE]
688688
====
689-
For more advanced camera techniques, refer to the Advanced Camera Techniques section in the xref:../Appendix/appendix.adoc[Appendix].
689+
For more advanced camera techniques, refer to the Advanced Camera Techniques section in the link:../Appendix/appendix.adoc[Appendix].
690690
====
691691

692692
In the next section, we'll integrate our camera system with Vulkan to render 3D scenes.
693693

694-
xref:05_vulkan_integration.adoc[Next: Vulkan Integration]
694+
link:05_vulkan_integration.adoc[Next: Vulkan Integration]

en/Building_a_Simple_Engine/Camera_Transformations/06_conclusion.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ A well-designed camera system is essential for any 3D application. It serves as
5252

5353
Remember that the code provided in this chapter is a starting point. Feel free to modify and extend it to suit your specific needs and application requirements.
5454

55-
xref:../Engine_Architecture/conclusion.adoc[Previous: Engine Architecture] | xref:../Lighting_Materials/01_introduction.adoc[Next: Lighting & Materials]
55+
link:../Engine_Architecture/conclusion.adoc[Previous: Engine Architecture] | link:../Lighting_Materials/01_introduction.adoc[Next: Lighting & Materials]

en/Building_a_Simple_Engine/Engine_Architecture/02_architectural_patterns.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ image::../../../images/layered_architecture_diagram.png[Layered Architecture Dia
2323
* Easier to understand and maintain
2424
* Can replace or modify individual layers without affecting others
2525

26-
For detailed information and implementation examples, see the xref:../Appendix/appendix.adoc#layered-architecture[Appendix: Layered Architecture].
26+
For detailed information and implementation examples, see the link:../Appendix/appendix.adoc#layered-architecture[Appendix: Layered Architecture].
2727

2828
==== link:https://www.youtube.com/watch?v=rX0ItVEVjHc[Data-Oriented Design]
2929

@@ -36,7 +36,7 @@ image::../../../images/data_oriented_design_diagram.svg[Data-Oriented Design Dia
3636
* More efficient memory usage
3737
* Easier to parallelize
3838

39-
For detailed information and implementation examples, see the xref:../Appendix/appendix.adoc#data-oriented-design[Appendix: Data-Oriented Design].
39+
For detailed information and implementation examples, see the link:../Appendix/appendix.adoc#data-oriented-design[Appendix: Data-Oriented Design].
4040

4141
==== link:https://gameprogrammingpatterns.com/service-locator.html[Service Locator Pattern]
4242

@@ -49,7 +49,7 @@ image::../../../images/service_locator_pattern_diagram.svg[Service Locator Patte
4949
* Allows for easy service replacement
5050
* Facilitates testing with mock services
5151

52-
For detailed information and implementation examples, see the xref:../Appendix/appendix.adoc#service-locator-pattern[Appendix: Service Locator Pattern].
52+
For detailed information and implementation examples, see the link:../Appendix/appendix.adoc#service-locator-pattern[Appendix: Service Locator Pattern].
5353

5454
=== link:https://gameprogrammingpatterns.com/component.html[Component-Based Architecture]
5555

@@ -164,8 +164,8 @@ While other architectural patterns have their merits, component-based architectu
164164

165165
=== Conclusion
166166

167-
We've provided a brief overview of common architectural patterns, with a focus on Component-Based Architecture which we'll use throughout this tutorial. For more detailed information about other architectural patterns, including implementation examples and comparative analysis, see the xref:../Appendix/appendix.adoc[Appendix: Detailed Architectural Patterns].
167+
We've provided a brief overview of common architectural patterns, with a focus on Component-Based Architecture which we'll use throughout this tutorial. For more detailed information about other architectural patterns, including implementation examples and comparative analysis, see the link:../Appendix/appendix.adoc[Appendix: Detailed Architectural Patterns].
168168

169169
In the next section, we'll dive deeper into component systems and how to implement them effectively in your engine.
170170

171-
xref:01_introduction.adoc[Previous: Introduction] | xref:03_component_systems.adoc[Next: Component Systems]
171+
link:01_introduction.adoc[Previous: Introduction] | link:03_component_systems.adoc[Next: Component Systems]

en/Building_a_Simple_Engine/Engine_Architecture/conclusion.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The architectural foundation we've established in this chapter will support ever
3636

3737
Active implementation proves far more valuable than passive reading when learning engine architecture. Build the code examples as you encounter them, but don't stop there—experiment with variations to understand how different approaches affect your engine's behavior. This experimentation develops the intuitive understanding that separates competent engine developers from those who merely copy implementations.
3838

39-
The architectural concepts we've covered provide a foundation, but production engines require additional sophistication. The xref:../Appendix/appendix.adoc[Appendix] explores advanced rendering techniques and architectural patterns that build on these fundamentals, helping you understand how simple patterns scale to handle complex real-world requirements.
39+
The architectural concepts we've covered provide a foundation, but production engines require additional sophistication. The link:../Appendix/appendix.adoc[Appendix] explores advanced rendering techniques and architectural patterns that build on these fundamentals, helping you understand how simple patterns scale to handle complex real-world requirements.
4040

4141
Studying existing open-source engines like link:https://github.com/TheCherno/Hazel[Hazel] or examining the architectural decisions in established frameworks like link:https://github.com/LWJGL/lwjgl3[LWJGL] provides valuable perspective on how these concepts apply in practice. Look for patterns we've discussed and notice how different engines make different trade-offs based on their specific goals and constraints.
4242

@@ -50,4 +50,4 @@ Building a rendering engine is a challenging but rewarding endeavor. By applying
5050

5151
Good luck with your engine development journey!
5252

53-
xref:06_event_systems.adoc[Previous: Event Systems] | xref:../Camera_Transformations/01_introduction.adoc[Next: Camera Transformations]
53+
link:06_event_systems.adoc[Previous: Event Systems] | link:../Camera_Transformations/01_introduction.adoc[Next: Camera Transformations]

en/Building_a_Simple_Engine/Loading_Models/01_introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ xref:../../06_Texture_mapping/00_Images.adoc[Texture mapping] skills are particu
3030

3131
Finally, basic 3D math understanding (matrices, vectors, quaternions) is crucial for handling model transformations, animations, and scene hierarchies. If you need a refresher, see the xref:../../Building_a_Simple_Engine/Camera_Transformations/02_math_foundations.adoc[Camera Transformations chapter] for detailed coverage of these mathematical concepts.
3232

33-
xref:../GUI/06_conclusion.adoc[Previous: GUI] | xref:02_project_setup.adoc[Next: Setting Up the Project]
33+
link:../GUI/06_conclusion.adoc[Previous: GUI] | link:02_project_setup.adoc[Next: Setting Up the Project]

en/Building_a_Simple_Engine/Loading_Models/05_pbr_rendering.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
=== Building on PBR Knowledge
88

9-
In the xref:../Lighting_Materials/01_introduction.adoc[Lighting & Materials chapter], we explored the fundamentals of Physically Based Rendering (PBR), including its core principles, the BRDF, and material properties. Now, we'll apply that knowledge to implement a PBR pipeline for the glTF models we've loaded.
9+
In the link:../Lighting_Materials/01_introduction.adoc[Lighting & Materials chapter], we explored the fundamentals of Physically Based Rendering (PBR), including its core principles, the BRDF, and material properties. Now, we'll apply that knowledge to implement a PBR pipeline for the glTF models we've loaded.
1010

1111
As we learned in the link:../../15_GLTF_KTX2_Migration.html[glTF and KTX2 Migration chapter], glTF uses PBR with the metallic-roughness workflow for its material system. This aligns perfectly with the PBR concepts we've already covered, making it straightforward to render our glTF models with physically accurate lighting.
1212

@@ -61,7 +61,7 @@ This uniform buffer includes:
6161

6262
[NOTE]
6363
====
64-
We introduced push constants earlier in xref:../Lighting_Materials/03_push_constants.adoc[push constants]; here we focus on how the same mechanism carries glTF metallic‑roughness material knobs efficiently per draw.
64+
We introduced push constants earlier in link:../Lighting_Materials/03_push_constants.adoc[push constants]; here we focus on how the same mechanism carries glTF metallic‑roughness material knobs efficiently per draw.
6565
====
6666

6767
We'll use link:https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#descriptorsets-pushconstant[push constants] to pass material properties to the shader:
@@ -574,4 +574,4 @@ In the next chapter, we'll explore how to render multiple objects with different
574574

575575
If you want to dive deeper into lighting and materials, refer back to the Lighting & Materials chapter, where we explored the theory behind PBR in detail.
576576

577-
xref:04_loading_gltf.adoc[Previous: Loading a glTF Model] | xref:06_multiple_objects.adoc[Next: Rendering Multiple Objects]
577+
link:04_loading_gltf.adoc[Previous: Loading a glTF Model] | link:06_multiple_objects.adoc[Next: Rendering Multiple Objects]

en/Building_a_Simple_Engine/Mobile_Development/06_conclusion.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@ private:
193193

194194
The following short, focused tutorials build directly on the Simple Engine and are great next steps:
195195

196-
- xref:../Advanced_Topics/01_introduction.adoc[Tutorials Index — browse all topics]
197-
- xref:../Advanced_Topics/Mipmaps_and_LOD.adoc[Mipmaps and LOD] — practical guidance on stable texture sampling and anisotropy.
198-
- xref:../Advanced_Topics/Dynamic_Rendering_Local_Read.adoc[Dynamic Rendering Local Read] — optimize same‑pass reads via tile/local memory when supported.
196+
- link:../Advanced_Topics/01_introduction.adoc[Tutorials Index — browse all topics]
197+
- link:../Advanced_Topics/Mipmaps_and_LOD.adoc[Mipmaps and LOD] — practical guidance on stable texture sampling and anisotropy.
198+
- link:../Advanced_Topics/Dynamic_Rendering_Local_Read.adoc[Dynamic Rendering Local Read] — optimize same‑pass reads via tile/local memory when supported.
199199

200200
=== Code Examples
201201

@@ -206,4 +206,4 @@ link:../../attachments/simple_engine/37_mobile_optimizations.cpp[Mobile Optimiza
206206
link:../../attachments/simple_engine/38_tbr_optimizations.cpp[TBR Optimizations C{pp} code]
207207
link:../../attachments/simple_engine/39_mobile_extensions.cpp[Mobile Extensions C{pp} code]
208208

209-
xref:05_vulkan_extensions.adoc[Previous: Vulkan Extensions for Mobile] | link:../index.html[Back to Building a Simple Engine]
209+
link:05_vulkan_extensions.adoc[Previous: Vulkan Extensions for Mobile] | link:../index.html[Back to Building a Simple Engine]

0 commit comments

Comments
 (0)