filters.html 5.4 KB

1234567891011121314151617181920
  1. <!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="Asciidoctor 1.5.4"><meta name="keywords" content="documentation, sdk, effect, file"><title>jMonkeyEngine SDK: Post-Processor Filters</title><link rel="stylesheet" href="./asciidoctor.css">
  2. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
  3. <link rel="stylesheet" href="./coderay-asciidoctor.css"><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"></head><body class="article toc2 toc-left"><div id="header"><div id="toolbar"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/src/docs/asciidoc/sdk/filters.adoc"><i class="fa fa-pencil-square" aria-hidden="true"></i></a><a href="https://github.com/jMonkeyEngine/wiki/new/master/src/docs/asciidoc/sdk/"><i class="fa fa-plus-square" aria-hidden="true"></i></a><input dir="auto" style="position: relative; vertical-align: top;" spellcheck="false" autocomplete="off" class="searchbox__input aa-input" id="doc-search" name="search" placeholder="Search in the doc" required="required" type="search"></div><h1>jMonkeyEngine SDK: Post-Processor Filters</h1><div class="details"><span class="author" id="author"></span><br><span id="revnumber">version ,</span> <span id="revdate">2016/03/17 20:48</span></div><div id="toc" class="toc2"><div id="toctitle">Table of Contents</div><ul class="sectlevel1"><li><a href="#creating-filters">Creating Filters</a></li><li><a href="#editing-filters">Editing Filters</a></li><li><a href="#viewing-filters">Viewing Filters</a></li><li><a href="#loading-filters-in-a-game">Loading filters in a game</a></li></ul></div></div><div id="content"><div id="preamble"><div class="sectionbody"><div class="paragraph"><p>Filters are used for scene-wide effects such as glow, fog, blur. The SDK lets you create a file storing combinations of filters. You can preview the filter settings on a loaded scene in the SDK. You can load them into your application (add them to the viewPort) to activate your preconfigured set of several filters in one step.</p></div></div></div>
  4. <div class="sect1"><h2 id="creating-filters">Creating Filters</h2><div class="sectionbody"><div class="imageblock right"><div class="content"><img src="../sdk/filterexplorer.png" alt="filterexplorer.png" width="" height=""></div></div>
  5. <div class="paragraph"><p>To create a new filter:</p></div>
  6. <div class="olist arabic"><ol class="arabic"><li><p>In the Projects window, right-click Assets→Effects.</p></li><li><p>Select File→New File…</p></li><li><p>Select Filter→Empty FilterPostProcessor File in the New File Wizard.</p><div class="ulist"><ul><li><p>An empty filter file appears in the Assets→Effects directory.</p></li></ul></div></li><li><p>Double-click the created file.</p><div class="ulist"><ul><li><p>The file opens in the FilterExplorer window.</p></li></ul></div></li></ol></div></div></div>
  7. <div class="sect1"><h2 id="editing-filters">Editing Filters</h2><div class="sectionbody"><div class="paragraph"><p>To add filters or modify existing filters</p></div>
  8. <div class="olist arabic"><ol class="arabic"><li><p>Double-click a j3f file to open it in the FilterExplorer window.</p></li><li><p>Right-click the j3f file&#8217;s root node to add a filter.</p><div class="ulist"><ul><li><p>Added filters are listed under the filter&#8217;s root node.</p></li></ul></div></li><li><p>Open the Properties window and select a filter in the FilterExplorer. Configure filter options like intensity etc.</p></li></ol></div>
  9. <div class="paragraph"><p>View the filter in the SceneComposer to see what you are doing:</p></div></div></div>
  10. <div class="sect1"><h2 id="viewing-filters">Viewing Filters</h2><div class="sectionbody"><div class="imageblock right"><div class="content"><img src="../sdk/p3wuv.png" alt="p3wuv.png" width="" height=""></div></div>
  11. <div class="paragraph"><p>To see a loaded filter</p></div>
  12. <div class="olist arabic"><ol class="arabic"><li><p>Open a model or scene in the SceneComposer.</p></li><li><p>Double-click a j3f file to open it in the FilterExplorer window.</p></li><li><p>Press the “show filter button in the OpenGL window.</p></li></ol></div></div></div>
  13. <div class="sect1"><h2 id="loading-filters-in-a-game">Loading filters in a game</h2><div class="sectionbody"><div class="paragraph"><p>To load a filter in a game (that is, to add it to your game&#8217;s viewport), add the following lines to your game&#8217;s simpleInit() method (or some other place):</p></div>
  14. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">FilterPostProcessor processor = (FilterPostProcessor) assetManager.loadAsset(<span class="string"><span class="delimiter">&quot;</span><span class="content">Filters/MyFilter.j3f</span><span class="delimiter">&quot;</span></span>);
  15. viewPort.addProcessor(processor);</code></pre></div></div></div></div></div><div id="footer"><div id="footer-text">Version <br>Last updated 2018-02-04 12:04:19 +00:00</div></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script>docsearch({
  16. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  17. indexName: 'jmonkeyengine',
  18. inputSelector: '#doc-search',
  19. debug: false // Set debug to true if you want to inspect the dropdown
  20. });</script></body></html>