diff --git a/doc/Demo.md b/doc/Demo.md index 324ca9643eb8bed55b6edc259ed790e68661fd93..72b1fb82ead18e3d06ab66d687627fda1ffc4623 100644 --- a/doc/Demo.md +++ b/doc/Demo.md @@ -8,29 +8,29 @@ # Demo -The demonstration projects are in the [liblava-demo](../liblava-demo) folder. Screenshots and a brief description in [README](../README.md/#demos) +You can find the demonstration projects in the `liblava-demo` folder ## Roboto -*Apache License, Version 2.0* [GitHub](https://github.com/google/fonts/tree/master/apache/roboto) [Website](https://fonts.google.com/specimen/Roboto) +*Apache License, Version 2.0* / [GitHub](https://github.com/google/fonts/tree/master/apache/roboto) / [Website](https://fonts.google.com/specimen/Roboto) * [Roboto-Regular.ttf](../res/font/imgui/Roboto-Regular.ttf) ## Font Awesome -*Font Awesome Free License* [GitHub](https://github.com/FortAwesome/Font-Awesome) [Website](https://fontawesome.com) +*Font Awesome Free License* / [GitHub](https://github.com/FortAwesome/Font-Awesome) / [Website](https://fontawesome.com) * [fa-solid-900.ttf](../res/font/icon/fa-solid-900.ttf) ## Barbarella -*Shader by Weyland Yutani* [Website](https://www.shadertoy.com/view/XdfGDr) +*Shader by Weyland Yutani* / [Website](https://www.shadertoy.com/view/XdfGDr) * [lamp.frag](../res/lamp/lamp.frag) ## Spawn Model -*CC BY-SA 3.0* [Website](https://opengameart.org/content/lava-spawn) +*CC BY-SA 3.0* / [Website](https://opengameart.org/content/lava-spawn) * [lava-spawn-game.mtl](../res/spawn/lava-spawn-game.mtl) * [lava-spawn-game.obj](../res/spawn/lava-spawn-game.obj) diff --git a/doc/Guide.md b/doc/Guide.md index 39830b6fefb07ee86e677dbd496f16cbf97012c6..1d4f67d28daa70393796449c711459958ff1aa65 100644 --- a/doc/Guide.md +++ b/doc/Guide.md @@ -8,7 +8,11 @@ # Guide -*WIP* +[Lifetime of an Object](#lifetime-of-an-object) / [Command-Line Arguments](#command-line-arguments) + +--- + +<br /> ## Lifetime of an Object @@ -129,4 +133,8 @@ buffer::ptr use_buffer_on_heap() { <br /> +*WIP* + +<br /> + <a href="https://git.io/liblava"><img src="https://github.com/liblava.png" width="50"></a> diff --git a/doc/Modules.md b/doc/Modules.md index 2448e994d74adc0bd7667b712f3fc41881b76f86..811783da9363438279fca24164e3b24229d95223 100644 --- a/doc/Modules.md +++ b/doc/Modules.md @@ -8,55 +8,55 @@ # Modules -## lava [demo](../liblava-demo) ➜ app +## lava [demo](../liblava-demo) / app [](../liblava-demo/lamp.cpp) [](../liblava-demo/spawn.cpp) [](../liblava-demo/triangle.cpp) <br /> -## lava [app](../liblava/app) ➜ block + frame + asset +## lava [app](../liblava/app) / block + frame + asset [](../liblava/app/app.hpp) [](../liblava/app/camera.hpp) [](../liblava/app/config.hpp) [](../liblava/app/forward_shading.hpp) [](../liblava/app/imgui.hpp) <br /> -## lava [block](../liblava/block) ➜ base +## lava [block](../liblava/block) / base [](../liblava/block/attachment.hpp) [](../liblava/block/block.hpp) [](../liblava/block/descriptor.hpp) [](../liblava/block/pipeline.hpp) [](../liblava/block/render_pass.hpp) [](../liblava/block/subpass.hpp) <br /> -## lava [frame](../liblava/frame) ➜ resource +## lava [frame](../liblava/frame) / resource [](../liblava/frame/frame.hpp) [](../liblava/frame/input.hpp) [](../liblava/frame/render_target.hpp) [](../liblava/frame/renderer.hpp) [](../liblava/frame/swapchain.hpp) [](../liblava/frame/window.hpp) <br /> -## lava [asset](../liblava/asset) ➜ resource + file +## lava [asset](../liblava/asset) / resource + file [](../liblava/asset/image_data.hpp) [](../liblava/asset/mesh_loader.hpp) [](../liblava/asset/texture_loader.hpp) <br /> -## lava [resource](../liblava/resource) ➜ base +## lava [resource](../liblava/resource) / base [](../liblava/resource/buffer.hpp) [](../liblava/resource/format.hpp) [](../liblava/resource/image.hpp) [](../liblava/resource/mesh.hpp) [](../liblava/resource/texture.hpp) <br /> -## lava [base](../liblava/base) ➜ util +## lava [base](../liblava/base) / util [](../liblava/base/base.hpp) [](../liblava/base/device.hpp) [](../liblava/base/instance.hpp) [](../liblava/base/memory.hpp) [](../liblava/base/physical_device.hpp) [](../liblava/base/queue.hpp) <br /> -## lava [file](../liblava/file) ➜ util +## lava [file](../liblava/file) / util [](../liblava/file/file.hpp) [](../liblava/file/file_system.hpp) [](../liblava/file/file_utils.hpp) [](../liblava/file/json_file.hpp) <br /> -## lava [util](../liblava/util) ➜ core +## lava [util](../liblava/util) / core [](../liblava/util/log.hpp) [](../liblava/util/random.hpp) [](../liblava/util/telegram.hpp) [](../liblava/util/thread.hpp) [](../liblava/util/utility.hpp) diff --git a/doc/README.md b/doc/README.md index a08a33bb6fbabe58922ca5e966d6dc3b5f610343..04c734f0b1304ae3eb26aefaf6a44872bcf03ea3 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,4 +6,6 @@ <br /> -This is the official documentation and is constantly evolving... if you need any help, please feel free to ask us on ➜ [Discord](https://discord.lava-block.com) \ No newline at end of file +This is the official documentation and is constantly evolving... + +If you need any help, please feel free to ask us on ➜ [Discord](https://discord.lava-block.com) \ No newline at end of file diff --git a/doc/Reference.md b/doc/Reference.md index c7e823c1d76bc03efd94b75896d8a135b70e4a17..76e4a8716dec1581399aad3baad78d707a2bdad1 100644 --- a/doc/Reference.md +++ b/doc/Reference.md @@ -8,9 +8,9 @@ # Reference -Run [doc/build.bat](build.bat) or [doc/build.sh](build.sh) to generate the documentation with [Doxygen](https://www.doxygen.nl) +To generate the documentation with [Doxygen](https://www.doxygen.nl) run the appropriate `doc/build` script -## You can find the latest here ➜ [liblava.lava-block.com](https://liblava.lava-block.com) +## Here you can find the latest ➜ [liblava.lava-block.com](https://liblava.lava-block.com) <br /> diff --git a/doc/Tests.md b/doc/Tests.md index 98ede286fd2b1bf0ba5c5a2889f1b604edde20ff..d47ce9b71c627a474fe294438528103589b03fb6 100644 --- a/doc/Tests.md +++ b/doc/Tests.md @@ -8,9 +8,9 @@ # Tests -Run the **lava** executable to test our [Tutorial examples](../tests/tests.cpp) +Run the `lava` executable to test our [Tutorial](../tests/tests.cpp) examples -Let it simply flow... +<br /> ### List all tests: @@ -27,19 +27,21 @@ lava -t 7. gamepad 8. [imgui demo](Tutorial.md/#8-imgui-demo) -### Run test 2 for example: +<br /> + +### Run *window input* test for example: ```bash -lava 2 +lava 3 ``` -The **driver** starts the *last* test when you provide *no* command line arguments +If you *do not* specify a number, the *last test* will be started <br /> ## Unit testing -In addition run **lava-unit** that will check parts of **liblava** using [Catch2](https://github.com/catchorg/Catch2) test framework +In addition run `lava-unit` to check parts of the library with [Catch2](https://github.com/catchorg/Catch2) test framework <br /> diff --git a/doc/Third-Party.md b/doc/Third-Party.md index a11155a71ff6fd28471eafe9bddccc715bdb69fb..5ab5ad892442c98c5ff81560f82fa289ca9b8ec7 100644 --- a/doc/Third-Party.md +++ b/doc/Third-Party.md @@ -8,61 +8,61 @@ # Third-Party -* [argh](https://github.com/adishavit/argh) **Argh! A minimalist argument handler** *3-clause BSD* +* [argh](https://github.com/adishavit/argh) / **Argh! A minimalist argument handler** / *3-clause BSD* [](../liblava/frame/frame.hpp) -* [Catch2](https://github.com/catchorg/Catch2) **A modern, C++-native, header-only, test framework for unit-tests, TDD and BDD** *BSL 1.0* +* [Catch2](https://github.com/catchorg/Catch2) / **A modern, C++-native, header-only, test framework for unit-tests, TDD and BDD** / *BSL 1.0* -* [glfw](https://github.com/glfw/glfw) **A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input** *zlib* +* [glfw](https://github.com/glfw/glfw) / **A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input** / *zlib* [](../liblava/frame/frame.cpp) [](../liblava/frame/input.cpp) [](../liblava/frame/window.cpp) -* [gli](https://github.com/g-truc/gli) **OpenGL Image (GLI)** *MIT* +* [gli](https://github.com/g-truc/gli) / **OpenGL Image (GLI)** / *MIT* [](../liblava/asset/texture_loader.cpp) -* [glm](https://github.com/g-truc/glm) **OpenGL Mathematics (GLM)** *MIT* +* [glm](https://github.com/g-truc/glm) / **OpenGL Mathematics (GLM)** / *MIT* [](../liblava/core/math.hpp) -* [IconFontCppHeaders](https://github.com/juliettef/IconFontCppHeaders) **C, C++ headers and C# classes for icon fonts** *zlib* +* [IconFontCppHeaders](https://github.com/juliettef/IconFontCppHeaders) / **C, C++ headers and C# classes for icon fonts** / *zlib* [](../liblava-demo/demo.hpp) -* [imgui](https://github.com/ocornut/imgui) **Dear ImGui - Bloat-free Graphical User interface for C++ with minimal dependencies** *MIT* +* [imgui](https://github.com/ocornut/imgui) / **Dear ImGui - Bloat-free Graphical User interface for C++ with minimal dependencies** / *MIT* [](../liblava/app/imgui.cpp) -* [json](https://github.com/nlohmann/json) **JSON for Modern C++** *MIT* +* [json](https://github.com/nlohmann/json) / **JSON for Modern C++** / *MIT* [](../liblava/file/json_file.hpp) -* [physfs](https://github.com/Didstopia/physfs) **A portable, flexible file i/o abstraction** *zlib* +* [physfs](https://github.com/Didstopia/physfs) / **A portable, flexible file i/o abstraction** / *zlib* [](../liblava/file/file.cpp) [](../liblava/file/file_system.cpp) -* [spdlog](https://github.com/gabime/spdlog) **Fast C++ logging library** *MIT* +* [spdlog](https://github.com/gabime/spdlog) / **Fast C++ logging library** / *MIT* [](../liblava/util/log.hpp) -* [stb](https://github.com/nothings/stb) **Single-file public domain libraries for C/C++** *MIT* +* [stb](https://github.com/nothings/stb) / **Single-file public domain libraries for C/C++** / *MIT* [](../liblava/asset/image_data.cpp) [](../liblava/asset/texture_loader.cpp) -* [tinyobjloader](https://github.com/syoyo/tinyobjloader) **Tiny but powerful single file wavefront obj loader** *MIT* +* [tinyobjloader](https://github.com/syoyo/tinyobjloader) / **Tiny but powerful single file wavefront obj loader** / *MIT* [](../liblava/asset/mesh_loader.hpp) -* [volk](https://github.com/zeux/volk) **Meta loader for Vulkan API** *MIT* +* [volk](https://github.com/zeux/volk) / **Meta loader for Vulkan API** / *MIT* [](../liblava/base/base.hpp) -* [Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) **Vulkan Header files and API registry** *Apache 2.0* +* [Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) / **Vulkan Header files and API registry** / *Apache 2.0* [](../liblava/base/base.hpp) [](../liblava/frame/window.hpp) -* [VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) **Easy to integrate Vulkan memory allocation library** *MIT* +* [VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) / **Easy to integrate Vulkan memory allocation library** / *MIT* [](../liblava/base/memory.hpp)