Skip to content
Snippets Groups Projects
Commit a80fddb1 authored by Lava Block's avatar Lava Block
Browse files

docs minor

parent 039df376
Branches
No related tags found
No related merge requests found
......@@ -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)
......
......@@ -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>
......@@ -8,55 +8,55 @@
# Modules
## lava [demo](../liblava-demo) &nbsp; ➜ app
## lava [demo](../liblava-demo) / app
[![lamp](https://img.shields.io/badge/lava-lamp-brightgreen.svg)](../liblava-demo/lamp.cpp) [![spawn](https://img.shields.io/badge/lava-spawn-brightgreen.svg)](../liblava-demo/spawn.cpp) [![triangle](https://img.shields.io/badge/lava-triangle-brightgreen.svg)](../liblava-demo/triangle.cpp)
<br />
## lava [app](../liblava/app) &nbsp; ➜ block + frame + asset
## lava [app](../liblava/app) / block + frame + asset
[![app](https://img.shields.io/badge/lava-app-brightgreen.svg)](../liblava/app/app.hpp) [![camera](https://img.shields.io/badge/lava-camera-brightgreen.svg)](../liblava/app/camera.hpp) [![config](https://img.shields.io/badge/lava-config-brightgreen.svg)](../liblava/app/config.hpp) [![forward_shading](https://img.shields.io/badge/lava-forward_shading-brightgreen.svg)](../liblava/app/forward_shading.hpp) [![imgui](https://img.shields.io/badge/lava-imgui-brightgreen.svg)](../liblava/app/imgui.hpp)
<br />
## lava [block](../liblava/block) &nbsp; ➜ base
## lava [block](../liblava/block) / base
[![attachment](https://img.shields.io/badge/lava-attachment-red.svg)](../liblava/block/attachment.hpp) [![block](https://img.shields.io/badge/lava-block-red.svg)](../liblava/block/block.hpp) [![descriptor](https://img.shields.io/badge/lava-descriptor-red.svg)](../liblava/block/descriptor.hpp) [![pipeline](https://img.shields.io/badge/lava-pipeline-red.svg)](../liblava/block/pipeline.hpp) [![render_pass](https://img.shields.io/badge/lava-render_pass-red.svg)](../liblava/block/render_pass.hpp) [![subpass](https://img.shields.io/badge/lava-subpass-red.svg)](../liblava/block/subpass.hpp)
<br />
## lava [frame](../liblava/frame) &nbsp; ➜ resource
## lava [frame](../liblava/frame) / resource
[![frame](https://img.shields.io/badge/lava-frame-red.svg)](../liblava/frame/frame.hpp) [![input](https://img.shields.io/badge/lava-input-red.svg)](../liblava/frame/input.hpp) [![render_target](https://img.shields.io/badge/lava-render_target-red.svg)](../liblava/frame/render_target.hpp) [![renderer](https://img.shields.io/badge/lava-renderer-red.svg)](../liblava/frame/renderer.hpp) [![swapchain](https://img.shields.io/badge/lava-swapchain-red.svg)](../liblava/frame/swapchain.hpp) [![window](https://img.shields.io/badge/lava-window-red.svg)](../liblava/frame/window.hpp)
<br />
## lava [asset](../liblava/asset) &nbsp; ➜ resource + file
## lava [asset](../liblava/asset) / resource + file
[![image_data](https://img.shields.io/badge/lava-image_data-orange.svg)](../liblava/asset/image_data.hpp) [![mesh_loader](https://img.shields.io/badge/lava-mesh_loader-orange.svg)](../liblava/asset/mesh_loader.hpp) [![texture_loader](https://img.shields.io/badge/lava-texture_loader-orange.svg)](../liblava/asset/texture_loader.hpp)
<br />
## lava [resource](../liblava/resource) &nbsp; ➜ base
## lava [resource](../liblava/resource) / base
[![buffer](https://img.shields.io/badge/lava-buffer-orange.svg)](../liblava/resource/buffer.hpp) [![format](https://img.shields.io/badge/lava-format-orange.svg)](../liblava/resource/format.hpp) [![image](https://img.shields.io/badge/lava-image-orange.svg)](../liblava/resource/image.hpp) [![mesh](https://img.shields.io/badge/lava-mesh-orange.svg)](../liblava/resource/mesh.hpp) [![texture](https://img.shields.io/badge/lava-texture-orange.svg)](../liblava/resource/texture.hpp)
<br />
## lava [base](../liblava/base) &nbsp; ➜ util
## lava [base](../liblava/base) / util
[![base](https://img.shields.io/badge/lava-base-orange.svg)](../liblava/base/base.hpp) [![device](https://img.shields.io/badge/lava-device-orange.svg)](../liblava/base/device.hpp) [![instance](https://img.shields.io/badge/lava-instance-orange.svg)](../liblava/base/instance.hpp) [![memory](https://img.shields.io/badge/lava-memory-orange.svg)](../liblava/base/memory.hpp) [![physical_device](https://img.shields.io/badge/lava-physical_device-orange.svg)](../liblava/base/physical_device.hpp) [![queue](https://img.shields.io/badge/lava-queue-orange.svg)](../liblava/base/queue.hpp)
<br />
## lava [file](../liblava/file) &nbsp; ➜ util
## lava [file](../liblava/file) / util
[![file](https://img.shields.io/badge/lava-file-blue.svg)](../liblava/file/file.hpp) [![file_system](https://img.shields.io/badge/lava-file_system-blue.svg)](../liblava/file/file_system.hpp) [![file_utils](https://img.shields.io/badge/lava-file_utils-blue.svg)](../liblava/file/file_utils.hpp) [![json_file](https://img.shields.io/badge/lava-json_file-blue.svg)](../liblava/file/json_file.hpp)
<br />
## lava [util](../liblava/util) &nbsp; ➜ core
## lava [util](../liblava/util) / core
[![log](https://img.shields.io/badge/lava-log-blue.svg)](../liblava/util/log.hpp) [![random](https://img.shields.io/badge/lava-random-blue.svg)](../liblava/util/random.hpp) [![telegram](https://img.shields.io/badge/lava-telegram-blue.svg)](../liblava/util/telegram.hpp) [![thread](https://img.shields.io/badge/lava-thread-blue.svg)](../liblava/util/thread.hpp) [![utility](https://img.shields.io/badge/lava-utility-blue.svg)](../liblava/util/utility.hpp)
......
......@@ -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
......@@ -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 />
......
......@@ -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 />
......
......@@ -8,61 +8,61 @@
# Third-Party
* [argh](https://github.com/adishavit/argh) &nbsp; **Argh! A minimalist argument handler** &nbsp; *3-clause BSD*
* [argh](https://github.com/adishavit/argh) / **Argh! A minimalist argument handler** / *3-clause BSD*
[![frame](https://img.shields.io/badge/lava-frame-red.svg)](../liblava/frame/frame.hpp)
* [Catch2](https://github.com/catchorg/Catch2) &nbsp; **A modern, C++-native, header-only, test framework for unit-tests, TDD and BDD** &nbsp; *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) &nbsp; **A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input** &nbsp; *zlib*
* [glfw](https://github.com/glfw/glfw) / **A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input** / *zlib*
[![frame](https://img.shields.io/badge/lava-frame-red.svg)](../liblava/frame/frame.cpp) [![input](https://img.shields.io/badge/lava-input-red.svg)](../liblava/frame/input.cpp) [![window](https://img.shields.io/badge/lava-window-red.svg)](../liblava/frame/window.cpp)
* [gli](https://github.com/g-truc/gli) &nbsp; **OpenGL Image (GLI)** &nbsp; *MIT*
* [gli](https://github.com/g-truc/gli) / **OpenGL Image (GLI)** / *MIT*
[![texture_loader](https://img.shields.io/badge/lava-texture_loader-orange.svg)](../liblava/asset/texture_loader.cpp)
* [glm](https://github.com/g-truc/glm) &nbsp; **OpenGL Mathematics (GLM)** &nbsp; *MIT*
* [glm](https://github.com/g-truc/glm) / **OpenGL Mathematics (GLM)** / *MIT*
[![math](https://img.shields.io/badge/lava-math-blue.svg)](../liblava/core/math.hpp)
* [IconFontCppHeaders](https://github.com/juliettef/IconFontCppHeaders) &nbsp; **C, C++ headers and C# classes for icon fonts** &nbsp; *zlib*
* [IconFontCppHeaders](https://github.com/juliettef/IconFontCppHeaders) / **C, C++ headers and C# classes for icon fonts** / *zlib*
[![demo](https://img.shields.io/badge/lava-demo-brightgreen.svg)](../liblava-demo/demo.hpp)
* [imgui](https://github.com/ocornut/imgui) &nbsp; **Dear ImGui - Bloat-free Graphical User interface for C++ with minimal dependencies** &nbsp; *MIT*
* [imgui](https://github.com/ocornut/imgui) / **Dear ImGui - Bloat-free Graphical User interface for C++ with minimal dependencies** / *MIT*
[![imgui](https://img.shields.io/badge/lava-imgui-brightgreen.svg)](../liblava/app/imgui.cpp)
* [json](https://github.com/nlohmann/json) &nbsp; **JSON for Modern C++** &nbsp; *MIT*
* [json](https://github.com/nlohmann/json) / **JSON for Modern C++** / *MIT*
[![json_file](https://img.shields.io/badge/lava-json_file-blue.svg)](../liblava/file/json_file.hpp)
* [physfs](https://github.com/Didstopia/physfs) &nbsp; **A portable, flexible file i/o abstraction** &nbsp; *zlib*
* [physfs](https://github.com/Didstopia/physfs) / **A portable, flexible file i/o abstraction** / *zlib*
[![file](https://img.shields.io/badge/lava-file-blue.svg)](../liblava/file/file.cpp) [![file_system](https://img.shields.io/badge/lava-file_system-blue.svg)](../liblava/file/file_system.cpp)
* [spdlog](https://github.com/gabime/spdlog) &nbsp; **Fast C++ logging library** &nbsp; *MIT*
* [spdlog](https://github.com/gabime/spdlog) / **Fast C++ logging library** / *MIT*
[![log](https://img.shields.io/badge/lava-log-blue.svg)](../liblava/util/log.hpp)
* [stb](https://github.com/nothings/stb) &nbsp; **Single-file public domain libraries for C/C++** &nbsp; *MIT*
* [stb](https://github.com/nothings/stb) / **Single-file public domain libraries for C/C++** / *MIT*
[![image_data](https://img.shields.io/badge/lava-image_data-orange.svg)](../liblava/asset/image_data.cpp) [![texture_loader](https://img.shields.io/badge/lava-texture_loader-orange.svg)](../liblava/asset/texture_loader.cpp)
* [tinyobjloader](https://github.com/syoyo/tinyobjloader) &nbsp; **Tiny but powerful single file wavefront obj loader** &nbsp; *MIT*
* [tinyobjloader](https://github.com/syoyo/tinyobjloader) / **Tiny but powerful single file wavefront obj loader** / *MIT*
[![mesh_loader](https://img.shields.io/badge/lava-mesh_loader-orange.svg)](../liblava/asset/mesh_loader.hpp)
* [volk](https://github.com/zeux/volk) &nbsp; **Meta loader for Vulkan API** &nbsp; *MIT*
* [volk](https://github.com/zeux/volk) / **Meta loader for Vulkan API** / *MIT*
[![base](https://img.shields.io/badge/lava-base-orange.svg)](../liblava/base/base.hpp)
* [Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) &nbsp; **Vulkan Header files and API registry** &nbsp; *Apache 2.0*
* [Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) / **Vulkan Header files and API registry** / *Apache 2.0*
[![base](https://img.shields.io/badge/lava-base-orange.svg)](../liblava/base/base.hpp) [![window](https://img.shields.io/badge/lava-window-red.svg)](../liblava/frame/window.hpp)
* [VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) &nbsp; **Easy to integrate Vulkan memory allocation library** &nbsp; *MIT*
* [VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) / **Easy to integrate Vulkan memory allocation library** / *MIT*
[![memory](https://img.shields.io/badge/lava-memory-orange.svg)](../liblava/base/memory.hpp)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment