Skip to content

Commit

Permalink
deploy: 5647fba
Browse files Browse the repository at this point in the history
  • Loading branch information
NicSavichev committed Jan 9, 2024
0 parents commit 60125dd
Show file tree
Hide file tree
Showing 281 changed files with 102,265 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 37c8e6399b0a128fb5f8e2f0b494c911
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/dagor-render/index.doctree
Binary file not shown.
Binary file added .doctrees/dagor-render/index/d3dAPI.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/dagor-render/index/d3dAPI/other.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/dagor-render/index/daBFG.doctree
Binary file not shown.
Binary file added .doctrees/dagor-render/index/daBFG/core.doctree
Binary file not shown.
Binary file added .doctrees/dagor-render/index/daBFG/das.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/dagor-render/index/resourceSlot.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/qdox-user-guide/index.doctree
Binary file not shown.
Binary file added .doctrees/qdox-user-guide/qdox.doctree
Binary file not shown.
Binary file added .doctrees/qdox-user-guide/rst-cheatsheet.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
Binary file added _images/biohazard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/magnetic-balls.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions _sources/dagor-render/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. Dagor Engine Render documentation master file
Dagor Engine Render
===============================================

.. toctree::
:maxdepth: 4
:caption: Contents:
:glob:

index/*

15 changes: 15 additions & 0 deletions _sources/dagor-render/index/d3dAPI.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
D3D API
=================================================

D3D API is our unified API which hides GAPI calls for different platforms.

.. toctree::
:maxdepth: 2
:caption: Contents:

d3dAPI/Buffers
d3dAPI/RenderPass
d3dAPI/other
d3dAPI/constants
d3dAPI/textures
d3dAPI/helperClasses
5 changes: 5 additions & 0 deletions _sources/dagor-render/index/d3dAPI/Buffers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Buffers
=================================================

.. autodoxygenfile:: dag_drv3d_buffers.h
:project: d3dAPI
31 changes: 31 additions & 0 deletions _sources/dagor-render/index/d3dAPI/RenderPass.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
RenderPass
=================================================

* See samples/testDrv3d/render_pass_tests.h for example usage

Callable d3d:: methods

.. doxygengroup:: RenderPassD3D
:project: d3dAPI
:members:
:undoc-members:
:content-only:

=================================================

Related structures

.. doxygengroup:: RenderPassStructs
:project: d3dAPI
:members:
:undoc-members:
:content-only:

=================================================

Related constants

.. doxygengroup:: RenderPassConsts
:project: d3dAPI
:members:
:content-only:
5 changes: 5 additions & 0 deletions _sources/dagor-render/index/d3dAPI/constants.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Constants, Structures and Enumerations
=================================================

.. autodoxygenfile:: dag_drv3dConsts.h
:project: d3dAPI
10 changes: 10 additions & 0 deletions _sources/dagor-render/index/d3dAPI/helperClasses.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Helper classes for D3D API
=================================================

These classes are not part of core D3D API, but they simplifies common usages of D3D API.

.. toctree::
:maxdepth: 2
:caption: Contents:

helperClasses/multidrawContext
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
MultidrawContext
=================================================

.. autodoxygenfile:: dag_multidrawContext.h
:project: d3dAPI
5 changes: 5 additions & 0 deletions _sources/dagor-render/index/d3dAPI/other.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
All other methods
=================================================

.. autodoxygenfile:: dag_drv3d.h
:project: d3dAPI
5 changes: 5 additions & 0 deletions _sources/dagor-render/index/d3dAPI/textures.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Textures
=================================================

.. autodoxygenfile:: dag_tex3d.h
:project: d3dAPI
20 changes: 20 additions & 0 deletions _sources/dagor-render/index/daBFG.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
daBFG API
=================================================

daBFG is a library for constructing and executing a *frame graph*, a computational graph for specifying a rendering pipeline of an real time application. It supports many fun features, such as:
* Homogenous management of many types of resources: transient and temporal, CPU data, GPU textures and buffers, external resources like system backbuffers
* Memory aliasing for all internally managed resources (even temporal ones!)
* Automatic barriers
* Global state management: (fake) render passes, bindings, VRS and more!
* Multiplexing support: want to run your graph multiple times for VR? No problem! It just works (as long as you annotate node multiplexing modes correctly and don't do any global state crimes)
* More to come soon!

.. toctree::
:maxdepth: 2
:caption: Contents:

daBFG/core
daBFG/declaringNodes
daBFG/graphState
daBFG/runtime
daBFG/das
28 changes: 28 additions & 0 deletions _sources/dagor-render/index/daBFG/core.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Core Functions
=================================================

The library exposes several global functions for controlling the global
graph state encapsulated inside the library, listed below. The graph
is always singular and global by design. This allows for the most
effective optimization of memory and other resources due to all
information being visible and available to the backend.

However, for separating different logical parts of the global graph,
e.g. for different viewports (editor and game preview) all daBfg entities
(nodes, resources, automatic resolutions, etc) are namespaced. A node
might have the name "/foo/bar/node", but you never actually use this
name to refer to a node, as we don't want to be parsing strings.
Instead, wrapper objects describing a particular namespace are used.

Hence, the code that wants to register various objects inside the graph,
like nodes and resolutions, must use the :cpp:class:`dabfg::NameSpace`
class to do so, although aliases for calling methods of this class on
the global namespace :cpp:func:`dabfg::root` are available.

.. doxygengroup:: DabfgCore
:project: daBFG
:members:

.. doxygengroup:: DabfgCoreAliases
:project: daBFG
:members:
Loading

0 comments on commit 60125dd

Please sign in to comment.