Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -3,5 +3,4 @@ sphinx_rtd_theme>=1.0.0
exhale>=0.3.1
sphinxcontrib-mermaid>=0.7.1
plotly>=5.7.0
pandas>=1.4.2
recommonmark>=0.7.1
pandas>=1.4.2
11 changes: 0 additions & 11 deletions documentation/source/code/main.rst

This file was deleted.

5 changes: 2 additions & 3 deletions documentation/source/conf.py
Original file line number Diff line number Diff line change
@@ -13,7 +13,6 @@
extensions = [
'breathe',
'exhale',
'recommonmark',
'sphinxcontrib.mermaid'
]
source_suffix = ['.rst']
@@ -53,9 +52,9 @@

# Setup the breathe extension
breathe_projects = {
"vulkan-renderer": "../doxygen-output/xml"
"inexor-vulkan-renderer": "../doxygen-output/xml"
}
breathe_default_project = "vulkan-renderer"
breathe_default_project = "inexor-vulkan-renderer"
breathe_default_members = ('private-members', 'members', 'undoc-members')

# Setup the exhale extension
17 changes: 2 additions & 15 deletions documentation/source/development/getting-started.rst
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ Required Software
-----------------

`Git <https://www.git-scm.com/>`__
Git for cloning (downloading) the source code.
Git is a general purpose version control system required to download the source code.

`Python <https://www.python.org/>`__ with `pip <https://pypi.org/project/pip/>`__
Required for generating the documentation and the C++ package manager.
@@ -19,39 +19,26 @@ Required Software

`Vulkan SDK <https://vulkan.lunarg.com/sdk/home>`__
Vulkan SDK contains the libraries and tools which are necessary to work with Vulkan API.

Update your Vulkan SDK as often as possible, because new versions will be released frequently which contains new features and bug fixes.

Make sure you add the ``glslangValidator`` in the Vulkan SDK's bin folder to your path variable.

Optional Software
-----------------

`GitKraken Git GUI <https://www.gitkraken.com/git-client>`__.
A Git user interface with many features which is easy to use.

`GitHub Desktop <https://desktop.github.com/>`__
An open source Git user interface which is easy to use.

`Ninja Build System <https://ninja-build.org/>`__
Improve your build times with ninja.

`RenderDoc <https://renderdoc.org/>`__
Powerful open source graphics debugger. Inexor has full RenderDoc integration.
A powerful open source graphics debugger.

`Doxygen <http://www.doxygen.nl/download.html>`__
Required for generating the documentation.

`Notepad++ <https://notepad-plus-plus.org/downloads/>`__
Free and open source text editor.

`Atom.io <https://atom.io/>`__
Free and open source text editor.

`Visual Studio Code <https://code.visualstudio.com/>`__
Free and open source text editor.


Does my graphics card support Vulkan?
-------------------------------------

11 changes: 6 additions & 5 deletions documentation/source/development/platforms.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Supported platforms
===================
Platform Support
=================

- Vulkan API is completely platform-agnostic, which allows it to run on various operating systems.
- The required drivers for Vulkan are usually part of your graphic card's drivers.
@@ -10,7 +10,7 @@ Supported platforms
Microsoft Windows
-----------------

- We support x64 Microsoft Windows 8, 8.1 and 10.
- We support x64 Microsoft Windows 8, 8.1, 10, and 11
- We have :ref:`build instructions for Windows<BUILDING windows>`.

Linux
@@ -24,9 +24,10 @@ macOS and iOS
-------------

- We do not support macOS or iOS because it would require us to use `MoltenVK <https://github.com/KhronosGroup/MoltenVK>`__ to get Vulkan running on Mac OS.
- Additionally, this would require some changes in the engines as not all of Inexor's dependencies are available on macOS or iOS.
- Also, this would require fundamental changes to the engine code.

Android
-------

- We also do not support Android because this would require some changes in the engines as not all of Inexor's dependencies are available on Android.
- We do not support Android yet because this would require fundamental changes in the engine.
- Also, this would require fundamental changes to the engine code.
2 changes: 1 addition & 1 deletion documentation/source/faq/main.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Frequently asked questions
Frequently Asked Questions
==========================

Please visit `inexor.org <https://inexor.org>`__ and join our `Discord server <https://discord.com/invite/acUW8k7>`__.
Binary file modified documentation/source/images/inexor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 8 additions & 24 deletions documentation/source/index.rst
Original file line number Diff line number Diff line change
@@ -2,12 +2,12 @@
Vulkan-Renderer
===============

|language| |platforms| |github actions| |readthedocs| |discord| |license|
|language| |platforms| |github actions| |discord| |license|

.. image:: /images/inexor-banner.svg
:width: 700px

**Inexor is a MIT-licensed open-source project which develops a new 3D octree game engine by combining modern C++ with Vulkan API.**

**A new 3D game engine for Linux and Windows using C++20 and Vulkan API in early development.**

Documentation
#############
@@ -18,7 +18,8 @@ Quickstart: :ref:`Building Instructions<BUILDING>` (:ref:`BUILDING Windows`/:ref
:maxdepth: 2

development/main
code/main
reference/main
exhale-generated/main
contributing/main
faq/main
changelog/main
@@ -28,32 +29,15 @@ Quickstart: :ref:`Building Instructions<BUILDING>` (:ref:`BUILDING Windows`/:ref

.. include:: /faq/main.rst

.. Badges.

.. |language| image:: https://img.shields.io/badge/language-C%2B%2B17-brightgreen
.. |language| image:: https://img.shields.io/badge/language-C%2B%2B20-brightgreen

.. |platforms| image:: https://img.shields.io/badge/platforms-Linux%20%26%20Windows-brightgreen

.. |github actions| image:: https://img.shields.io/github/workflow/status/inexorgame/vulkan-renderer/Build
:target: https://github.com/inexorgame/vulkan-renderer/actions?query=workflow%3A%22Build%22
.. |github actions| image:: https://img.shields.io/github/actions/workflow/status/inexorgame/vulkan-renderer/build.yml?branch=main
:target: https://github.com/inexorgame/vulkan-renderer/actions?query=build.yml

.. |discord| image:: https://img.shields.io/discord/698219248954376256?logo=discord
:target: https://discord.com/invite/acUW8k7

.. |license| image:: https://img.shields.io/github/license/inexorgame/vulkan-renderer?color=brightgreen
:target: https://inexor-vulkan-renderer.readthedocs.io/en/latest/license/main.html

.. |contributors| image:: https://img.shields.io/github/contributors/inexorgame/vulkan-renderer
:target: https://inexor-vulkan-renderer.readthedocs.io/en/latest/contributing/contributors.html

.. |downloads| image:: https://img.shields.io/github/downloads/inexorgame/vulkan-renderer/total?color=brightgreen

.. |readthedocs| image:: https://readthedocs.org/projects/inexor-vulkan-renderer/badge/?version=latest
:target: https://inexor-vulkan-renderer.readthedocs.io

.. |last commit| image:: https://img.shields.io/github/last-commit/inexorgame/vulkan-renderer

.. |issues| image:: https://img.shields.io/github/issues/inexorgame/vulkan-renderer
:target: https://github.com/inexorgame/vulkan-renderer/issues

.. |code size| image:: https://img.shields.io/github/languages/code-size/inexorgame/vulkan-renderer
8 changes: 3 additions & 5 deletions documentation/source/license/main.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
*******************
Source Code License
*******************


***********
MIT License
***********

.. include:: ../../../LICENSE
12 changes: 6 additions & 6 deletions documentation/source/links/main.rst
Original file line number Diff line number Diff line change
@@ -52,15 +52,15 @@ Beginner Vulkan API tutorials
- `Sascha Willems' tutorial about Vulkan debug markers <https://www.saschawillems.de/blog/2016/05/28/tutorial-on-using-vulkans-vk_ext_debug_marker-with-renderdoc/>`__
- `Awesome Vulkan list <https://github.com/vinjn/awesome-vulkan>`__

Migrating from OpenGL to Vulkan API
-----------------------------------
Migrating to Vulkan API
-----------------------

- `Dustin Land's blog series 'I Am Graphics And So Can You' <https://www.fasterthan.life/blog/2017/7/11/i-am-graphics-and-so-can-you-part-1>`__
- `Transitioning from OpenGL to Vulkan <https://developer.nvidia.com/transitioning-opengl-vulkan>`__
- `Porting a Graphics Engine to the Vulkan API <https://community.arm.com/developer/tools-software/graphics/b/blog/posts/porting-a-graphics-engine-to-the-vulkan-api>`__

Advanced Vulkan API tutorials and articles
------------------------------------------
Advanced Vulkan API tutorials
-----------------------------

- `Sascha Willems' glTF2 + PBR (physically based rendering) demo <https://github.com/SaschaWillems/Vulkan-glTF-PBR>`__
- `NVidia Developer Blog: Tips and Tricks: Vulkan Dos and Don’ts <https://developer.nvidia.com/blog/vulkan-dos-donts/>`__
@@ -78,7 +78,7 @@ Advanced Vulkan API tutorials and articles
- `Vulkan Barriers Explained <https://gpuopen.com/learn/vulkan-barriers-explained/>`__
- `GPUOpen performance guide <https://gpuopen.com/performance/#barriers>`__

Vulkan API presentations
Vulkan API Presentations
------------------------

- `NVidia: GPU-driven rendering <http://on-demand.gputechconf.com/gtc/2016/presentation/s6138-christoph-kubisch-pierre-boudier-gpu-driven-rendering.pdf>`__
@@ -89,7 +89,7 @@ Vulkan API presentations
- `Get Your Engine Ready for Vulkan on Mobile <https://developer.arm.com/-/media/Files/pdf/graphics-and-multimedia/Get%20Your%20Engine%20Ready%20for%20Vulkan%20on%20Mobile.pdf>`__
- `Vulkan’s Key Features on ARM Architecture <https://developer.arm.com/-/media/Files/pdf/graphics-and-multimedia/Vulkan%20API%20key%20features%20on%20ARM%20architecture.pdf>`__

Vulkan API example projects
Vulkan API Example Projects
----------------------------

- `The official Khronos Vulkan samples <https://github.com/KhronosGroup/Vulkan-Samples>`__
File renamed without changes.
File renamed without changes