342 lines
17 KiB
HTML
342 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>renderdiff - Filament</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../highlight.css">
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
<!-- MathJax -->
|
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "light" : "light";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div style="display:flex;align-items:center;justify-content:center">
|
|
<img class="flogo" src="../images/filament_logo_small.png"></img>
|
|
</div>
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<!-- Filament: disable themes because the markdeep part does not look good for dark themes -->
|
|
<!--
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
-->
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Filament</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="https://github.com/google/filament" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="rendering-difference-test"><a class="header" href="#rendering-difference-test">Rendering Difference Test</a></h1>
|
|
<p>This tool is a collections of scripts to run <code>gltf_viewer</code> and produce headless renderings.</p>
|
|
<p>This is mainly useful for continuous integration where GPUs are generally not available on cloud
|
|
machines. To perform software rasterization, these scripts are centered around <a href="https://docs.mesa3d.org">Mesa</a>'s
|
|
software rasterizers, but nothing bars us from using another rasterizer like <a href="https://github.com/google/swiftshader">SwiftShader</a>.
|
|
Additionally, we should be able to use GPUs where available (though this is more of a future
|
|
work).</p>
|
|
<p>The script <code>render.py</code> contains the core logic for taking input parameters (such as the test
|
|
description file) and then running <code>gltf_viewer</code> to produce the renderings.</p>
|
|
<p>In the <code>test</code> directory is a list of test descriptions that are specified in json. Please see
|
|
<code>sample.json</code> to glean the structure.</p>
|
|
<h2 id="setting-up-python"><a class="header" href="#setting-up-python">Setting up python</a></h2>
|
|
<p>The <code>renderdiff</code> project uses <code>python</code> extensively. To install the dependencies for producing
|
|
renderings, do the following step</p>
|
|
<ul>
|
|
<li>Set up a virtual environment (from the root directory)
|
|
<pre><code>python3 -m venv venv
|
|
. ./venv/bin/activate
|
|
</code></pre>
|
|
</li>
|
|
<li>Install the rendering dependencies
|
|
<pre><code>pip install -r test/renderdiff/src/rendering_requirements.txt
|
|
</code></pre>
|
|
</li>
|
|
<li>Install the viewer depdencies
|
|
<pre><code>pip install -r test/renderdiff/src/viewer_requirements.txt
|
|
</code></pre>
|
|
</li>
|
|
<li>For the commands in the following section, do not exit the virtual environment. Once you've
|
|
completed all your work, you can exit with
|
|
<pre><code>deactivate
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<h2 id="running-the-test-locally"><a class="header" href="#running-the-test-locally">Running the test locally</a></h2>
|
|
<ul>
|
|
<li>To run the same presbumit as <a href="presubmit-renderdiff"><code>test-renderdiff</code></a>, you can do
|
|
<pre><code>bash test/renderdiff/local_test.sh
|
|
</code></pre>
|
|
</li>
|
|
<li>This script will generate the renderings based on the current state of your repo.
|
|
Additionally, it will also compare the generated images with corresponding images in the
|
|
golden repo.</li>
|
|
<li>To just render without running the test, you could use the following script
|
|
<pre><code>bash test/renderdiff/generate.sh
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<h2 id="command-line-options"><a class="header" href="#command-line-options">Command-line Options</a></h2>
|
|
<p>You can control the behavior of the test scripts with the following flags passed to <code>local_test.sh</code>:</p>
|
|
<ul>
|
|
<li><code>--test_filter=<filter></code>: Run a subset of tests. The filter supports wildcards (<code>*</code>) to match test names.</li>
|
|
<li><code>--no_rebuild</code>: Skip rebuilding the <code>gltf_viewer</code> executable.</li>
|
|
<li><code>--num_threads=<number></code>: Set the number of threads for rendering. If not set, the system's default is used.</li>
|
|
</ul>
|
|
<p>For example, to run all <code>MSAA</code> tests without rebuilding and using 8 threads:</p>
|
|
<pre><code>bash test/renderdiff/local_test.sh --test_filter='MSAA.*.*' --no_rebuild --num_threads=8
|
|
</code></pre>
|
|
<h2 id="update-the-golden-images"><a class="header" href="#update-the-golden-images">Update the golden images</a></h2>
|
|
<p>The golden images are stored in a github repository:
|
|
https://github.com/google/filament-assets. Filament team members should have access to write
|
|
to the repository. A typical flow for updating the goldens is to upload your changed images
|
|
into <strong>branch</strong> of <code>filament-assets</code>. This branch is paired with a PR or commit on the
|
|
<code>filament</code> repo.</p>
|
|
<p>As an example, imagine I am working on a PR, and I've uploaded my change, which is in a
|
|
branch called <code>my-pr-branch</code>, to <code>filament</code>. This PR requires updating the golden. We would do
|
|
it in the following fashion</p>
|
|
<h3 id="using-a-script-to-update-the-golden-repo"><a class="header" href="#using-a-script-to-update-the-golden-repo">Using a script to update the golden repo</a></h3>
|
|
<ul>
|
|
<li>Run interactive mode in the <code>update_golden.py</code> script.
|
|
<pre><code>python3 test/renderdiff/src/update_golden.py
|
|
</code></pre>
|
|
</li>
|
|
<li>This will guide you through a series of steps to push the changes to a remote branch on
|
|
<code>filament-assets</code>.</li>
|
|
</ul>
|
|
<h3 id="manually-updating-the-golden-repo"><a class="header" href="#manually-updating-the-golden-repo">Manually updating the golden repo</a></h3>
|
|
<ul>
|
|
<li>Check out the golden repo
|
|
<pre><code>git clone git@github.com:google/filament-assets.git
|
|
</code></pre>
|
|
</li>
|
|
<li>Create a branch on the golden repo
|
|
<pre><code>cd filament-assets
|
|
git switch -c my-pr-branch-golden
|
|
</code></pre>
|
|
</li>
|
|
<li>Copy the new images to their appropriate place in <code>filament-assets</code></li>
|
|
<li>Push the <code>filament-assets</code> working branch to remote
|
|
<pre><code>git push origin my-pr-branch-golden
|
|
</code></pre>
|
|
</li>
|
|
<li>In the commit message of your working branch on <code>filament</code>, add the following line
|
|
<pre><code>RDIFF_BBRANCH=my-pr-branch-golden
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
<p>Doing the above has multiple effects:</p>
|
|
<ul>
|
|
<li>The presubmit test <a href="https://github.com/google/filament/blob/e85dfe75c86106a05019e13ccdbef67e030af675/.github/workflows/presubmit.yml#L118"><code>test-renderdiff</code></a> will test against the provided
|
|
branch of the golden repo (i.e. <code>my-pr-branch-golden</code>).</li>
|
|
<li>If the PR is merged, then there is another workflow that will merge <code>my-pr-branch-golden</code>
|
|
to the <code>main</code> branch of the golden repo.</li>
|
|
</ul>
|
|
<h2 id="viewing-test-results"><a class="header" href="#viewing-test-results">Viewing test results</a></h2>
|
|
<p>We provide a viewer for looking at the result of a test run. The viewer is a webapp that can
|
|
be used by pointing your browser to a localhost port. If you input the viewer with a PR or a
|
|
directory, it will parse the test result and show the results and the rendered and/or golden
|
|
images.</p>
|
|
<p><img src="../images/renderdiff_example.png" alt="Viewer" /></p>
|
|
<p>To run the viewer of a test output directory that has been generated locally, you would run
|
|
the following</p>
|
|
<pre><code>python3 test/renderdiff/src/viewer.py --diff=[test output]
|
|
</code></pre>
|
|
<p>where <code>[test output]</code> is a directory containing the <code>compare_results.json</code> of the test run.
|
|
For example, it could be <code>out/renderdiff/diffs/presubmit</code> for the standard path to the
|
|
<code>presubmit</code> test output.</p>
|
|
<p>To see the results of a Pull Request initiated test run, you would do the following</p>
|
|
<pre><code>python3 test/renderdiff/src/viewer.py --pr_number=[PR #] --github_token=[github token]
|
|
</code></pre>
|
|
<p>where <code>[PR #]</code> is the numeric ID of your pull request, and the <code>[github token]</code> is an acess
|
|
token that you (as a github user) needs to generate (<a href="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens">reference</a>).</p>
|
|
<p>To see the results of a specific run, you would do the following</p>
|
|
<pre><code>python3 test/renderdiff/src/viewer.py --run_number=[RUN #] --github_token=[github token]
|
|
</code></pre>
|
|
<p>where <code>[RUN #]</code> is the numeric ID of the run. You can find the run number in the URL of the
|
|
GitHub Actions page. For example, in the URL
|
|
<code>https://github.com/google/filament/actions/runs/18023632663/job/51286323708?pr=9264</code>,
|
|
the run number is <code>18023632663</code>.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../notes/tests.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../notes/libs.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../notes/tests.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../notes/libs.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|