-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdebugging.html
More file actions
225 lines (203 loc) · 12.1 KB
/
Copy pathdebugging.html
File metadata and controls
225 lines (203 loc) · 12.1 KB
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" ><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" >
<title>Debugging — Simul documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" >
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" >
<link rel="shortcut icon" href="../_static/favicon.ico">
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" >
<link rel="search" title="Search" href="../search.html" >
<link rel="next" title="trueSKY Deployment" href="deployment.html" >
<link rel="prev" title="Performance" href="profiling.html" >
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="" >
<span class="sidebartitle">
trueSKY 4.4
</span>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<label class="search-label" for="q">Search the documentation</label>
<input type="text" name="q" id="q" placeholder="Search..." aria-label="Search docs" >
<input type="hidden" name="check_keywords" value="yes" >
<input type="hidden" name="area" value="default" >
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation and Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../skysequencer.html">trueSKY Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorialsindex.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unreal.html">trueSKY for Unreal Engine</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../programming.html">Programming with the trueSKY SDK</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nativesdk.html">Native Development with the trueSKY SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="pluginrenderer.html">The TrueSkyPluginRender Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="rendering.html">Rendering Techniques in trueSKY</a></li>
<li class="toctree-l2"><a class="reference internal" href="profiling.html">Performance</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Debugging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#compositing">Compositing</a></li>
<li class="toctree-l3"><a class="reference internal" href="#celestial-display">Celestial Display</a></li>
<li class="toctree-l3"><a class="reference internal" href="#profiling">Profiling</a></li>
<li class="toctree-l3"><a class="reference internal" href="#atmospherics">Atmospherics</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cloud-cross-section">Cloud Cross Section</a></li>
<li class="toctree-l3"><a class="reference internal" href="#precipitation">Precipitation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#auxillary-textures">Auxillary Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="#queries">Queries</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="deployment.html">trueSKY Deployment</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../legalindex.html">trueSKY Licences</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../API/apiindex.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Reference/referenceindex.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelist.html">Changelist</a></li>
</ul>
</div>
</div>
</nav>
<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<h2 class="wy-nav-top">Navigation</h2><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Simul</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../programming.html">Programming with the trueSKY SDK</a></li>
<li class="breadcrumb-item active">Debugging</li>
<li class="wy-breadcrumbs-aside">
<div class="truesky-version-switch">
<button id="version-switch-button">Switch Version</button>
</div>
<script>
const switchButton = document.getElementById('version-switch-button');
// current URL
const currentURL = window.location.href;
const isVersion4_3 = currentURL.includes('/4.3');
const isVersion4_4 = currentURL.includes('/4.4');
if (isVersion4_3) {
switchButton.textContent = 'Switch to 4.4';
switchButton.addEventListener('click', () => {
window.location.href = '/4.4';
});
} else if (isVersion4_4) {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
} else {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
}
</script>
</li>
</ul>
<hr>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="debugging">
<h1>Debugging<a class="headerlink" href="#debugging" title="Permalink to this heading">¶</a></h1>
<p>Our goal is to have as much data publicly available to see as possible. If something is not working, you should know what isn’t and why.</p>
<p>We display all the information within the Debug Textures tab, which is split up into different pages.</p>
<section id="compositing">
<h2>Compositing<a class="headerlink" href="#compositing" title="Permalink to this heading">¶</a></h2>
<p>Here is an overview of many of the systems use, helpful for depth tests and general debugging.</p>
<img alt="../_images/Compositing.png" src="../_images/Compositing.png" />
</section>
<section id="celestial-display">
<h2>Celestial Display<a class="headerlink" href="#celestial-display" title="Permalink to this heading">¶</a></h2>
<p>Shows the current position and path of the Sun and Moon, along with information about their position.</p>
<img alt="../_images/CelestialDisplay.png" src="../_images/CelestialDisplay.png" />
<p>There is additional data displayed for both solar and lunar eclipses.</p>
<img alt="../_images/SolarEclipse.png" src="../_images/SolarEclipse.png" />
<img alt="../_images/LunarEclipse.png" src="../_images/LunarEclipse.png" />
</section>
<section id="profiling">
<h2>Profiling<a class="headerlink" href="#profiling" title="Permalink to this heading">¶</a></h2>
<p>Use profiling to aid performance measuring. This is a good way to determine what aspects of trueSKY are the most performance heavy. This has been moved into its own performance tab and is not located in the debug textures window.</p>
<img alt="../_images/Profiling.png" src="../_images/Profiling.png" />
</section>
<section id="atmospherics">
<h2>Atmospherics<a class="headerlink" href="#atmospherics" title="Permalink to this heading">¶</a></h2>
<p>Detailed numbers on lighting values as well as colours. Issues with lighting can be looked at here.</p>
<img alt="../_images/SkyFades.png" src="../_images/SkyFades.png" />
</section>
<section id="cloud-cross-section">
<h2>Cloud Cross Section<a class="headerlink" href="#cloud-cross-section" title="Permalink to this heading">¶</a></h2>
<p>An overview of the cloud textures while they are generated. You can also see the Signed Distance Field that 4.4 takes advantage of to improve performance.</p>
<img alt="../_images/CloudCrossSections.png" src="../_images/CloudCrossSections.png" />
</section>
<section id="precipitation">
<h2>Precipitation<a class="headerlink" href="#precipitation" title="Permalink to this heading">¶</a></h2>
<p>Here is an overlay of the rain map texture. If the precipitation volume is blank, then there will be no precipitation in your scene. Precipitation will only fall under a specified thickness of clouds, and precipitation regions will be specific to their point on the globe.</p>
<img alt="../_images/PrecipitationDebug.png" src="../_images/PrecipitationDebug.png" />
<p>Here is an example of full cloud coverage with an area of regional precipitation.</p>
<img alt="../_images/RegionalPrecipitation.png" src="../_images/RegionalPrecipitation.png" />
</section>
<section id="auxillary-textures">
<h2>Auxillary Textures<a class="headerlink" href="#auxillary-textures" title="Permalink to this heading">¶</a></h2>
<p>3D clouds textures including the shadow map texture. Helpful to see how much your Worley setting are affecting the clouds, as well as how large the Shadow Map is.</p>
<img alt="../_images/cloudtextures.png" src="../_images/cloudtextures.png" />
</section>
<section id="queries">
<h2>Queries<a class="headerlink" href="#queries" title="Permalink to this heading">¶</a></h2>
<p>Within our debug textures tab, we also have information about our queries.</p>
<p>Queries such as a point query can be used to determine the parameters at a specified point, for example you could determine the density of clouds at a certain point, and this could be used to limit visibility in your engine. Or you could query the rainfall over a certain area, and adjust how wet your objects appear in a scene.</p>
<p>We have point queries for specified points and line queries, which recieve the data from between two specified points. These all update in real time and can be very beneficial if used correctly. We have functions to specify your own queries within our SDK and in our plugins.</p>
<img alt="../_images/cloudqueries.png" src="../_images/cloudqueries.png" />
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="profiling.html" class="btn btn-neutral float-left" title="Performance" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="deployment.html" class="btn btn-neutral float-right" title="trueSKY Deployment" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr>
<div role="contentinfo">
<p>© Copyright 2007-2023, Simul Software Ltd.</p>
</div>
</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="overlay" style="display: none;">
<img class="fullsize" alt="fullscreen image overlay" src="data:,">
</div>
</body>
</html>