wgsldoc 1.0.1

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

<!DOCTYPE html>
<html lang="en">
<head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta name="color-scheme" content="light dark">
   <link rel="stylesheet" href="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/css/pico.classless.min.css">
   <link rel="icon" href="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/favicon.png" type="image/png">
   <link rel="stylesheet" href="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/css/highlight.min.css">
   <title>test_shaders - WGSL documentation</title>
</head>
<body>
   <header>
      <hgroup>
         <h1>test_shaders</h1>
         <p>wgsldoc documentation</p>
      </hgroup>
      <nav>
         <ul>
            <li><a href="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/index.html">Main page</a></li>
            <li><a href="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/modules/index.html">Modules</a></li>
            <li><span>Source</span></li>
         </ul>
      </nav>
   </header>
   <main>
      
   
      <h1>WGSL Shader Documentation</h1>
<p>Welcome to the generated documentation for your WGSL shader modules!</p>
<p>This site provides a structured, searchable, and readable reference for all your WGSL code, including:</p>
<ul>
<li><strong>Modules</strong>: Each <code>.wgsl</code> file is documented as a module, with its own page.</li>
<li><strong>Structures</strong>: All structs, their fields, and documentation comments.</li>
<li><strong>Functions</strong>: All functions, arguments, return types, and inline documentation.</li>
<li><strong>Imports</strong>: Cross-module type and function references are resolved and linked.</li>
<li><strong>Type Information</strong>: All types, including primitives, vectors, and user-defined types, are clearly displayed.</li>
</ul>
<h2>How to Use</h2>
<ul>
<li><strong>Browse Modules</strong>: Use the navigation to explore different shader modules.</li>
<li><strong>Read Docs</strong>: Click on any structure or function to see its documentation, signature, and usage.</li>
<li><strong>Cross References</strong>: Jump between modules and types using links generated from imports.</li>
</ul>
<h2>About</h2>
<p>This documentation was generated automatically using <a href="https://github.com/konceptosociala/wgsldoc">wgsldoc</a>.</p>
<hr />
<p><em>Happy shading!</em></p>
   

   </main>

   <footer>
      <small>Built with <a href="https://github.com/konceptosociala/wgsldoc" target="_blank">wgsldoc</a></small>
   </footer>

   <script type="text/javascript" src="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/js/highlight.min.js"></script>
   <script type="text/javascript" src="/home/nutov2/doc/ks/proj/wgsldoc/test_shaders/docs/js/wgsl.min.js"></script>
   <script>hljs.highlightAll();</script>
</body>
</html>