wgsldoc 1.0.0-alpha

Documentation generator for WGSL shaders
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

{% extends "base.html.tera" %}
{% import "macros.tera" as macros %}
{% block content %}
   <h1>Module <code>{{ module.name }}</code></h1>
   <hr>
   {{ module.summary }}
   {% if imports %}
      <h2>Imports</h2>
      <hr>
      {% for imp in imports %}
         <li>
            <i>{{ imp.path }}</i> as <code>
               {% if imp.registered %}
                  <a href="{{ assets_subpath }}/modules/{{ imp.module_name }}/index.html">{{ imp.name }}</a>
               {% else %}
                  {{ imp.name }}
               {% endif %}
            </code>
            {% if imp.docs %}
               <br>
               {{ imp.docs }}
            {% endif %}
         </li>
      {% endfor %}
   {% endif %}
   {% if bindings %}
      <h2>Bindings</h2>
      <hr>
      <table>
         <thead>
            <tr>
               <th>Group</th>
               <th>Binding</th>
               <th>Name</th>
               <th>Type</th>
            </tr>
         </thead>
         <tbody>
            {% for binding in bindings %}
               <tr>
                  <td>
                     <strong>{{ binding.attr_group }}</strong>
                  </td>
                  <td>
                     <strong>{{ binding.attr_binding }}</strong>
                  </td>
                  <td>
                     <strong>{{ binding.name }}</strong>
                     {% if binding.docs %}
                        <br>
                        <small>{{ binding.docs }}</small>
                     {% endif %}
                  </td>
                  <td>
                     {{ macros::render_type(type=binding.ty) }}
                  </td>
               </tr>
            {% endfor %}
         </tbody>
      </table>
   {% endif %}
   {% if constants %}
      <h2>Constants</h2>
      <hr>
      <table>
         <thead>
            <tr>
               <th>Name</th>
               <th>Type</th>
               <th>Value</th>
            </tr>
         </thead>
         <tbody>
            {% for const in constants %}
               <tr>
                  <td>
                     <strong>{{ const.name }}</strong>
                     {% if const.docs %}
                        <br>
                        <small>{{ const.docs }}</small>
                     {% endif %}
                  </td>
                  <td>
                     {% if const.ty %}
                        {{ macros::render_type(type=const.ty) }}
                     {% else %}
                        (infer)
                     {% endif %}
                  </td>
                  <td>{{ const.value }}</td>
               </tr>
            {% endfor %}
         </tbody>
      </table>
   {% endif %}
   {% if functions %}
      <h2>Functions</h2>
      <hr>
      {% for function in functions %}
         {% if function.summary %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/fn.{{ function.name }}.html">{{ function.name }}</a></code> - {{ function.summary }}</li>
         {% else %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/fn.{{ function.name }}.html">{{ function.name }}</a></code></li>
         {% endif %}
      {% endfor %}
   {% endif %}
   {% if structures %}
      <h2>Structures</h2>
      <hr>
      {% for structure in structures %}
         {% if structure.summary %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/struct.{{ structure.name }}.html">{{ structure.name }}</a></code> - {{ structure.summary }}</li>
         {% else %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/struct.{{ structure.name }}.html">{{ structure.name }}</a></code></li>
         {% endif %}
      {% endfor %}
   {% endif %}
{% endblock content %}