documenting

This commit is contained in:
2020-02-04 00:21:15 -08:00
parent da836f318e
commit 4b8fffc6bf
16 changed files with 378 additions and 40 deletions

30
notes/CanvasFont.txt Normal file
View File

@@ -0,0 +1,30 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:42:36-08:00
====== CanvasFont ======
< Link to Documentation > [[~/source/Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html|Documentation]]
===== Details =====
<details>
**<notes>**
--------------------
===== Data =====
**Borrowed:**
**Owns:**
--------------------

29
notes/CanvasFrame.txt Normal file
View File

@@ -0,0 +1,29 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:57:15-08:00
====== CanvasFrame ======
[[~/source/Trac3r-rust/doc/sfml_rust/canvas_frame/struct.CanvasFrame.html|Documentation]]
===== Details =====
Canvas frame
**<notes>**
--------------------
===== Data =====
**Borrowed:**
**Owns:**
--------------------

30
notes/CanvasImage.txt Normal file
View File

@@ -0,0 +1,30 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:42:33-08:00
====== CanvasImage ======
< Link to Documentation > [[~/source/Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html|Documentation]]
===== Details =====
<details>
**<notes>**
--------------------
===== Data =====
**Borrowed:**
**Owns:**
--------------------

67
notes/CanvasState.txt Normal file
View File

@@ -0,0 +1,67 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:30:41-08:00
====== CanvasState ======
[[~/source/Trac3r-rust/doc/sfml_rust/canvas/struct.CanvasState.html|Documentation]]
===== Details =====
The gist of this class is basically draw everything 2D and have all the resources to do so. It holds binary buffer blobs for resources, it's own compiled shaders, render_pass, and all of the vertex buffers in order to draw those binary buffer blobs.
**window_size_dependent_setup** is currently hosted inside this class. If a second graphics class is added I will add some shared library for this to live.
**render_pass **the render pass is created with our depth stencil data **D32Sfloat_S8Uint** and the color attachment for the render output. This is highly 2D dependent
===== Interface =====
Generally there is a get for handle and pointer and a load (or create) for each of the stored items.
The class then interacts with these stored items by taking and executing a list of operations to perform on them.
CanvasFrame
--------------------
===== Data =====
**Borrowed:**
queue
device
**Owns:**
render_pass
[[CanvasImage]]
[[CanvasTexture]]
[[CanvasFont]]
CompiledGraphicsPipeline
colored_vertex_buffer
image_vertex_buffer
text_instances
--------------------

30
notes/CanvasTexture.txt Normal file
View File

@@ -0,0 +1,30 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:43:28-08:00
====== CanvasTexture ======
< Link to Documentation > [[~/source/Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html|Documentation]]
===== Details =====
<details>
**<notes>**
--------------------
===== Data =====
**Borrowed:**
**Owns:**
--------------------

30
notes/CompuState.txt Normal file
View File

@@ -0,0 +1,30 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T22:18:20-08:00
====== CompuState ======
[[~/source/Trac3r-rust/doc/sfml_rust/compu_state/struct.CompuState.html|Documentation]]
===== Details =====
Compustate is a very simplified sibling to the CanvasState. We only hold the binary [[~/source/Trac3r-rust/doc/sfml_rust/compu_buffer/struct.CompuBuffers.html|CompuBuffers]] and the compiled kernels to compute them.
--------------------
===== Data =====
**Borrowed:**
device
**Owns:**
[[~/source/Trac3r-rust/doc/sfml_rust/compu_buffer/struct.CompuBuffers.html|CompuBuffers]]
CompuKernel
--------------------

View File

@@ -3,11 +3,8 @@ Wiki-Format: zim 0.4
Creation-Date: 2020-01-22T18:39:43-08:00
====== Dynamic Vertex ======
Created Wednesday 22 January 2020
{{{code: lang="rust" linenumbers="True"
#[derive(Default, Debug, Clone)]
pub struct RuntimeVertexDef {
buffers: Vec<(u32, usize, InputRate)>, // (attribute id, stride, Vertex or Instance data)
@@ -63,3 +60,6 @@ unsafe impl VertexSource<Vec<Arc<dyn BufferAccess + Send + Sync>>> for RuntimeVe
}
}
}}}

13
notes/Home.txt Normal file
View File

@@ -0,0 +1,13 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T22:11:42-08:00
====== Home ======
[[~/source/Trac3r-rust/doc/sfml_rust/index.html|Documentation Root]]
[[VkProcessor]] [[~/source/Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html|===========]]
[[CanvasState]] [[~/source/Trac3r-rust/doc/sfml_rust/canvas/canvas_state/index.html|===========]]
[[CompuState]] [[~/source/Trac3r-rust/doc/sfml_rust/compute/compu_state/struct.CompuState.html|===========]]

View File

@@ -0,0 +1,42 @@
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2020-02-03T23:31:13-08:00
====== TemplateStructPage ======
< Link to Documentation > [[~/source/Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html|Documentation]]
===== Details =====
<details>
**<notes>**
--------------------
===== Data =====
**Borrowed:**
**Owns:**
--------------------

File diff suppressed because one or more lines are too long

View File

@@ -10,3 +10,7 @@ endofline=unix
disable_trash=False
profile=
[JournalPlugin]
namespace=Journal
granularity=Day