| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190 |
- <!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="material, texture, MatDefs, light, culling, RenderStates, documentation"><title>Material Definition Properties</title><link rel="stylesheet" href="./asciidoctor.css">
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
- <link rel="stylesheet" href="./coderay-asciidoctor.css"><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="/home/travis/build/jMonkeyEngine/wiki/build/asciidoc/html5/jme3/advanced/twemoji-awesome.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/jme3/advanced/materials_overview.adoc"><i class="fa fa-pencil-square" aria-hidden="true"></i></a><a href="https://github.com/jMonkeyEngine/wiki/new/master/src/docs/asciidoc/jme3/advanced/"><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>Material Definition Properties</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="#all-materials-definition-properties">All Materials Definition Properties</a><ul class="sectlevel2"><li><a href="#unshaded-coloring-and-textures">Unshaded Coloring and Textures</a></li><li><a href="#phong-illuminated">Phong Illuminated</a></li><li><a href="#other-test-and-debug">Other: Test and Debug</a></li></ul></li><li><a href="#renderstates">RenderStates</a></li></ul></div></div><div id="content"><div id="preamble"><div class="sectionbody"><div class="paragraph"><p>In jMonkeyEngine 3, colors and textures are represented as Material objects.</p></div>
- <div class="ulist"><ul><li><p>All Geometries must have Materials. To improve performance, reuse Materials for similar models, don’t create a new Material object for every Geometry. (E.g. use one bark Material for several tree models.)</p></li><li><p>Each Material is based on one of jme3’s default Material Definitions (.j3md files) that are included in the engine. Advanced users can create additional custom Material Definitions (see how it’s done in the <a href="../../jme3/build_from_sources.html">jme3 sources</a>).</p></li></ul></div>
- <div class="admonitionblock tip"><table><tr><td class="icon"><i class="fa icon-tip" title="Tip"></i></td><td class="content"><div class="paragraph"><p>Find out quickly <a href="../../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>, including the most commonly used code samples and RenderStates.<br>
- Or find more background info on <a href="../../jme3/advanced/material_definitions.html">How to use Material Definitions</a>.</p></div></td></tr></table></div></div></div>
- <div class="sect2"><h3 id="all-materials-definition-properties">All Materials Definition Properties</h3><div class="paragraph"><p>The following Materials table shows the Material Definitions that jMonkeyEngine 3 supports.</p></div>
- <div class="admonitionblock tip"><table><tr><td class="icon"><i class="fa icon-tip" title="Tip"></i></td><td class="content"><div class="paragraph"><p>Looks confusing?<br>
- 1) Start learning about <code>Unshaded.j3md</code> and <code>Lighting.j3md</code>, they cover 90% of the cases.<br>
- 2) Use <a href="../../sdk/material_editing.html">the SDK’s visual material editor</a> to try out and save material settings easily.<br>
- 3) The <a href="../../sdk/code_editor.html">SDK’s Palette</a> contains drag&drop code snippets for loading materials.</p></div></td></tr></table></div>
- <div class="paragraph"><p>Most Material parameters are optional. For example, it is okay to specify solely the <code>DiffuseMap</code> and <code>NormalMap</code> when using <code>Lighting.j3md</code>, and leave the other texture maps empty. In this case, you are only using a subset of the possible features, but that’s fine if it already makes in the material look the way that you want. You can always add more texture maps later.</p></div>
- <div class="sect2"><h3 id="unshaded-coloring-and-textures">Unshaded Coloring and Textures</h3><div class="paragraph"><p>jMonkeyEngine supports illuminated and unshaded Material Definitions.</p></div>
- <div class="ulist"><ul><li><p>Phong Illuminated materials look more naturalistic.</p></li><li><p>Unshaded materials look more abstract.</p></li></ul></div>
- <div class="paragraph"><p>“Unshaded” materials look somewhat abstract because they ignore lighting and shading. Unshaded Materials work even if the scene does not include a light source. These Materials can be single-colored or textured. For example, they are used for cards and tiles, for the sky, billboards and UI elements, for toon-style games, or for testing.</p></div>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 1. Standard Unshaded</caption><colgroup><col style="width: 20%;"><col style="width: 30%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Definition</th><th class="tableblock halign-left valign-top">Usage</th><th class="tableblock halign-left valign-top">Material Parameters</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Misc/<br>
- Unshaded.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Standard, non-illuminated Materials.</p></div>
- <div class="paragraph"><p>Use this for simple coloring, texturing, glow, and transparency.</p></div>
- <div class="paragraph"><p>See also: <a href="../../jme3/beginner/hello_material.html">Hello Material</a></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p><strong>Texture Maps</strong><br>
- setTexture(“ColorMap”, assetManager.loadTexture(“name”));<br>
- setBoolean(“SeparateTexCoord”,true);<br>
- setTexture(“LightMap”, assetManager.loadTexture(“name”));<br>
- <strong>Colors</strong><br>
- setColor(“Color”, ColorRGBA.White);<br>
- setBoolean(“VertexColor”,true);<br>
- <strong>Glow</strong><br>
- setTexture(“GlowMap”, assetManager.loadTexture(“name”));<br>
- setColor(“GlowColor”, ColorRGBA.White);</p></div></div></td></tr></tbody></table>
- <div class="paragraph"><p>Other useful, but less commonly used material definitions:</p></div>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 2. Special Unshaded</caption><colgroup><col style="width: 20%;"><col style="width: 25%;"><col style="width: 55%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Definition</th><th class="tableblock halign-left valign-top">Usage</th><th class="tableblock halign-left valign-top">Material Parameters</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Misc/<br>
- Sky.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>A solid sky blue, or use with a custom SkyDome texture.</p></div>
- <div class="paragraph"><p>See also: <a href="../../jme3/advanced/sky.html">Sky</a></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setTexture(“Texture”, assetManager.loadTexture(“name”));<br>
- setBoolean(“SphereMap”,true);<br>
- setVector3(“NormalScale”, new Vector3f(0,0,0));</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Terrain/<br>
- Terrain.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Splat textures for, e.g. terrains.</p></div>
- <div class="paragraph"><p>See also: <a href="../../jme3/beginner/hello_terrain.html">Hello Terrain</a></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setTexture(“Tex1”, assetManager.loadTexture(“name”));<br>
- (red)<br>
- setFloat(“Tex1Scale”,1f);<br>
- setTexture(“Tex2”, assetManager.loadTexture(“name”));<br>
- (green)<br>
- setFloat(“Tex2Scale”,1f);<br>
- setTexture(“Tex3”, assetManager.loadTexture(“name”));<br>
- (blue)<br>
- setFloat(“Tex3Scale”,1f);<br>
- setTexture(“Alpha”, assetManager.loadTexture(“name”));</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Terrain/<br>
- HeightBasedTerrain.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>A multi-layered texture for terrains.</p></div>
- <div class="paragraph"><p>Specify four textures and a Vector3f describing the region in which each texture should appear:</p></div>
- <div class="paragraph"><p>X = start height,<br>
- Y = end height,<br>
- Z = texture scale.</p></div>
- <div class="paragraph"><p>Texture regions can overlap.</p></div>
- <div class="paragraph"><p>For example:</p></div>
- <div class="paragraph"><p>Specify a seafloor texture for the lowest areas.</p></div>
- <div class="paragraph"><p>A sandy texture for the beaches.</p></div>
- <div class="paragraph"><p>A grassy texture for inland areas.</p></div>
- <div class="paragraph"><p>A rocky texture for mountain tops.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setFloat(“terrainSize”,512f);<br>
- setTexture(“region1ColorMap”, assetManager.loadTexture(“name”));<br>
- setTexture(“region2ColorMap”, assetManager.loadTexture(“name”));<br>
- setTexture(“region3ColorMap”, assetManager.loadTexture(“name”));<br>
- setTexture(“region4ColorMap”, assetManager.loadTexture(“name”));<br>
- setVector3(“region1”, new Vector3f(0,0,0));<br>
- setVector3(“region2”, new Vector3f(0,0,0));<br>
- setVector3(“region3”, new Vector3f(0,0,0));<br>
- setVector3(“region4”, new Vector3f(0,0,0));<br>
- <strong>Settings for steep areas:</strong><br>
- setTexture(“slopeColorMap”, assetManager.loadTexture(“name”));<br>
- setFloat(“slopeTileFactor”,1f);</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Misc/<br>
- Particle.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Used with texture masks for particle effects, or for point sprites.</p></div>
- <div class="paragraph"><p>The Quadratic value scales the particle for perspective view. (<a href="https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-core/src/main/java/com/jme3/effect/ParticleEmitter.java">formula</a>)</p></div>
- <div class="paragraph"><p>Does support an optional colored glow effect.</p></div>
- <div class="paragraph"><p>See also: <a href="../../jme3/beginner/hello_effects.html">Hello Effects</a></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setTexture(“Texture”, assetManager.loadTexture(“name”));<br>
- setTexture(“GlowMap”, assetManager.loadTexture(“name”));<br>
- setColor(“GlowColor”, ColorRGBA.White);<br>
- setFloat(“Quadratic”,1f);<br>
- setBoolean(“PointSprite”,true);</p></div></div></td></tr></tbody></table></div>
- <div class="sect2"><h3 id="phong-illuminated">Phong Illuminated</h3><div class="paragraph"><p>jMonkeyEngine supports illuminated and unshaded Material Definitions.</p></div>
- <div class="ulist"><ul><li><p>Phong Illuminated materials look more naturalistic.</p></li><li><p>Unshaded materials look more abstract.</p></li></ul></div>
- <div class="paragraph"><p>Illuminated materials require a <a href="../../jme3/advanced/light_and_shadow.html">light source</a> added to at least one of their parent nodes! (e.g. rootNode.) Illuminated materials are darker on the sides facing away from light sources. They use Phong illumination model (default), or the Ward isotropic gaussian specular shader (WardIso) which looks more like plastic. They do not cast <a href="../../jme3/advanced/light_and_shadow.html">drop shadows</a> unless you use a FilterPostProcessor.</p></div>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 3. Standard Illuminated</caption><colgroup><col style="width: 20%;"><col style="width: 30%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Definition</th><th class="tableblock halign-left valign-top">Usage</th><th class="tableblock halign-left valign-top">Material Parameters</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Light/<br>
- Lighting.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Commonly used Material with Phong illumination.</p></div>
- <div class="paragraph"><p>Use this material together with DiffuseMap, SpecularMap, BumpMap (NormalMaps, ParalaxMap) textures.</p></div>
- <div class="paragraph"><p>Supports shininess, transparency, and plain material colors (Diffuse, Ambient, Specular).</p></div>
- <div class="paragraph"><p>See also: <a href="../../jme3/beginner/hello_material.html">Hello Material</a></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p><strong>Texture Maps</strong><br>
- setTexture(“DiffuseMap”, assetManager.loadTexture(“name”));<br>
- setBoolean(“UseAlpha”,true); <span class="footnote">[<a class="footnote" id="_footnoteref_1" href="#_footnote_1" title="View footnote.">1</a>]</span> <br>
- setTexture(“NormalMap”, assetManager.loadTexture(“name”));<br>
- setBoolean(“LATC”,true); <span class="footnote">[<a class="footnote" id="_footnoteref_2" href="#_footnote_2" title="View footnote.">2</a>]</span> <br>
- setTexture(“SpecularMap”, assetManager.loadTexture(“name”));<br>
- setFloat(“Shininess”,64f);<br>
- setTexture(“ParallaxMap”, assetManager.loadTexture(“name”));<br>
- setTexture(“AlphaMap”, assetManager.loadTexture(“name”));<br>
- setFloat(“AlphaDiscardThreshold”,1f);<br>
- setTexture(“ColorRamp”, assetManager.loadTexture(“name”));<br>
- <strong>Glow</strong><br>
- setTexture(“GlowMap”, assetManager.loadTexture(“name”));<br>
- setColor(“GlowColor”, ColorRGBA.White);<br>
- <strong>Performance and quality</strong><br>
- setBoolean(“VertexLighting”,true);<br>
- setBoolean(“UseVertexColor”,true);<br>
- setBoolean(“LowQuality”,true);<br>
- setBoolean(“HighQuality”,true);<br>
- <strong>Material Colors</strong><br>
- setBoolean(“UseMaterialColors”,true);<br>
- setColor(“Diffuse”, ColorRGBA.White);<br>
- setColor(“Ambient”, ColorRGBA.White);<br>
- setColor(“Specular”, ColorRGBA.White);<br>
- <strong>Tangent shading:</strong><br>
- setBoolean(“VTangent”,true);<br>
- setBoolean(“Minnaert”,true); <span class="footnote">[<a class="footnote" id="_footnoteref_3" href="#_footnote_3" title="View footnote.">3</a>]</span><br>
- setBoolean(“WardIso”,true); <span class="footnote">[<a class="footnote" id="_footnoteref_4" href="#_footnote_4" title="View footnote.">4</a>]</span></p></div><div id="footnotes"><hr><div class="footnote" id="_footnote_1"><a href="#_footnoteref_1">1</a>. UseAlpha specifies whether DiffuseMap uses the alpha channel</div><div class="footnote" id="_footnote_2"><a href="#_footnoteref_2">2</a>. LATC Specifies whether NormalMap is BC5/ATI2n/LATC/3Dc-compressed</div><div class="footnote" id="_footnote_3"><a href="#_footnoteref_3">3</a>. Minnaert is a shader type.</div><div class="footnote" id="_footnote_4"><a href="#_footnoteref_4">4</a>. WardIso is a shader type.</div></div></div></td></tr></tbody></table>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 4. Special Illuminated</caption><colgroup><col style="width: 20%;"><col style="width: 30%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Definitions</th><th class="tableblock halign-left valign-top">Usage</th><th class="tableblock halign-left valign-top">Material Parameters</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Terrain/<br>
- TerrainLighting.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Same kind of multi-layered splat texture as Terrain.j3md, but with illumination and shading.</p></div>
- <div class="paragraph"><p>Typically used for terrains, but works on any mesh.</p></div>
- <div class="paragraph"><p>For every three splat textures, you need one alpha map.</p></div>
- <div class="paragraph"><p>You can use a total of 11 texture maps in the terrain’s splat texture:</p></div>
- <div class="paragraph"><p>Note that diffuse and normal maps all count against that.</p></div>
- <div class="paragraph"><p>For example:</p></div>
- <div class="paragraph"><p>You can use a maximum of nine diffuse textures, two of which can have normal maps; or, five textures with both diffuse and normal maps.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p><strong>Texture Splat Maps</strong><br>
- setTexture(“DiffuseMap”, assetManager.loadTexture(“name”));<br>
- setFloat(“DiffuseMap_0_scale”,1f);<br>
- setTexture(“NormalMap”, assetManager.loadTexture(“name”));<br>
- setTexture(“DiffuseMap_1”, assetManager.loadTexture(“name”));<br>
- setFloat(“DiffuseMap_1_scale”,1f);<br>
- setTexture(“NormalMap_1”, assetManager.loadTexture(“name”));<br>
- setTexture(“DiffuseMap_2”, assetManager.loadTexture(“name”));<br>
- setFloat(“DiffuseMap_2_scale”,1f);<br>
- setTexture(“NormalMap_2”, assetManager.loadTexture(“name”));<br>
- setTexture(“DiffuseMap_3”, assetManager.loadTexture(“name”));<br>
- setFloat(“DiffuseMap_3_scale”,1f);<br>
- setTexture(“NormalMap_3”, assetManager.loadTexture(“name”));<br>
- etc, up to 11.<br>
- <strong>Alpha Maps</strong><br>
- setTexture(“AlphaMap”, assetManager.loadTexture("name"));<br>
- setTexture(“AlphaMap_1”, assetManager.loadTexture(“name”));<br>
- setTexture(“AlphaMap_2”, assetManager.loadTexture(“name”));<br>
- <strong>Glowing</strong><br>
- setTexture(“GlowMap”, assetManager.loadTexture(“name”));<br>
- setColor(“GlowColor”, ColorRGBA.White);<br>
- <strong>Miscellaneous</strong><br>
- setColor(“Diffuse”, ColorRGBA.White);<br>
- setColor(“Ambient”, ColorRGBA.White);<br>
- setFloat(“Shininess”,64f);<br>
- setColor(“Specular”, ColorRGBA.White);<br>
- setTexture(“SpecularMap”, assetManager.loadTexture(“name”));<br>
- setBoolean(“WardIso”,true);<br>
- setBoolean(“useTriPlanarMapping”,true);<br>
- setBoolean(“isTerrainGrid”,true);</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Light/<br>
- reflect.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Reflective glass material with environment map (CubeMap/SphereMap).</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setTexture(“Texture”, assetManager.loadTexture(“name”));<br>
- setBoolean(“SphereMap”,true);</p></div></div></td></tr></tbody></table></div>
- <div class="sect2"><h3 id="other-test-and-debug">Other: Test and Debug</h3><table class="tableblock frame-all grid-all spread"><caption class="title">Table 5. Testing</caption><colgroup><col style="width: 20%;"><col style="width: 80%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Definition</th><th class="tableblock halign-left valign-top">Usage</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Common/MatDefs/Misc/<br>
- ShowNormals.j3md</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>A color gradient calculated from the model’s surface normal’s. You can use this built-in material to debug the generation of normal’s in meshes, to preview models that have no material and no lights, or as fall-back default material. This built-in material has no parameters.</p></div></div></td></tr></tbody></table></div></div>
- <div class="sect1"><h2 id="renderstates">RenderStates</h2><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><caption class="title">Table 6. Transparancy</caption><colgroup><col style="width: 33.3333%;"><col style="width: 33.3333%;"><col style="width: 33.3334%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Option</th><th class="tableblock halign-left valign-top">Description</th><th class="tableblock halign-left valign-top">Example</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState().<br>
- setBlendMode(BlendMode.Off);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>This is the default, no transparency.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use for all opaque objects like walls, floors, people…</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.Alpha);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Interpolates the background pixel with the current pixel by using the current pixel’s alpha.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use this for normal every-day translucency: Frosted window panes, ice, glass, alpha-blended vegetation textures…</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setDepthWrite(false);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Disables writing of the pixel’s depth value to the depth buffer.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use this on Materials if you have several transparent/translucent objects obscuring one another, but you want to see through both.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setAlphaFallOff(0.5f);</p></div>
- <div class="paragraph"><p>getAdditionalRenderState()<br>
- .setAlphaTest(true)</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Enables Alpha Testing with a “AlphaDiscardThreshold” in the AlphaMap.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Activate Alpha Testing for (partially) <strong>transparent</strong> objects such as foliage, hair, etc.</p></div>
- <div class="paragraph"><p>Deactivate Alpha Testing for gradually <strong>translucent</strong> objects, such as colored glass, smoked glass, ghosts.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.Additive);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Additive alpha blending adds colors in a commutative way, i.e. the result does not depend on the order of transparent layers since it adds the scene’s background pixel color to the current pixel color. This is useful if you have many transparent textures overlapping and don’t care about the order.</p></div>
- <div class="paragraph"><p><strong>Note:</strong> Viewed in front of a white background, Additive textures become fully transparent!</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>This is the default for Particle.j3md-based textures that have a black color background.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.AlphaAdditive);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Same as “Additive”, except first it multiplies the current pixel color by the pixel alpha.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>This can be used for particle effects that have alpha as background.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.Color);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Blends by color.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Generally useless.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.Modulate);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Multiplies the background pixel by the current pixel.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>?</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.ModulateX2);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Same as “Modulate”, except the result is doubled.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>?</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setBlendMode(BlendMode.PremultAlpha);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Pre-multiplied alpha blending. E.g. if the color of the object has already been multiplied by its alpha, this is used instead of “Alpha” blend mode.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>For use with Premult Alpha textures.</p></div></div></td></tr></tbody></table>
- <div class="paragraph"><p>If the DiffuseMap has an alpha channel, use:</p></div>
- <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">mat.setBoolean(<span class="string"><span class="delimiter">"</span><span class="content">UseAlpha</span><span class="delimiter">"</span></span>,<span class="predefined-constant">true</span>);</code></pre></div></div>
- <div class="paragraph"><p>Later, put the Geometry (not the Material!) in the appropriate render queue.</p></div>
- <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">geo.setQueueBucket(Bucket.Translucent);</code></pre></div></div>
- <div class="paragraph"><p>or</p></div>
- <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">geo.setQueueBucket(Bucket.Transparent);</code></pre></div></div>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 7. Culling</caption><colgroup><col style="width: 33.3333%;"><col style="width: 33.3333%;"><col style="width: 33.3334%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Option</th><th class="tableblock halign-left valign-top">Usage</th><th class="tableblock halign-left valign-top">Example</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setFaceCullMode(FaceCullMode.Back);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Activates back-face culling. Mesh faces that are facing away from the camera are not rendered, which saves time.</p></div>
- <div class="paragraph"><p><strong>Backface culling is activated by default as a major optimization.</strong></p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>The invisible backsides and insides of models are not calculated.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setFaceCullMode(FaceCullMode.Off);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>No meshes are culled. Both mesh faces are rendered, even if they face away from the camera. Slow.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Sometimes used to debug custom meshes if you messed up some of the polygon sides, or for special shadow effects.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setFaceCullMode(FaceCullMode.Front);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Activates front-face culling. Mesh faces facing the camera are not rendered.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>No example – Typically not used because you wouldn’t see anything meaningful.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setFaceCullMode(FaceCullMode.FrontAndBack)</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Culls both backfaces and frontfaces.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use this as an efficient way to make an object temporarily invisible, while keeping all its other in-game properties (such as node attachment, collision shapes, interactions, etc.) active.</p></div></div></td></tr></tbody></table>
- <table class="tableblock frame-all grid-all spread"><caption class="title">Table 8. Miscellaneous</caption><colgroup><col style="width: 33.3333%;"><col style="width: 33.3333%;"><col style="width: 33.3334%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Material Option</th><th class="tableblock halign-left valign-top">Useage</th><th class="tableblock halign-left valign-top">Example</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setColorWrite(false);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Disable writing the color of pixels.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use this together with setDepthWrite(true) to write pixels only to the depth buffer, for example.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setPointSprite(true);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Enables point-sprite mode, e.g. meshes with “Mode”.Points will be rendered as textured sprites.</p></div>
- <div class="paragraph"><p>Note that gl_PointCoord must be set in the shader.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Point sprites are used internally for hardware accelerated particle effects.</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>getAdditionalRenderState()<br>
- .setPolyOffset();</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Enable polygon offset.</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Use this when you have meshes that have triangles really close to each over (e.g. <a href="http://en.wikipedia.org/wiki/Coplanarity">Coplanar</a>), it will shift the depth values to prevent <a href="http://en.wikipedia.org/wiki/Z-fighting">Z-fighting</a>.</p></div></div></td></tr></tbody></table>
- <div class="paragraph"><p><strong>Related Links</strong></p></div>
- <div class="ulist"><ul><li><p><a href="../../jme3/advanced/material_specification.html">Developer specification of the jME3 material system (.j3md,.j3m)</a></p></li></ul></div></div></div></div><div id="footer"><div id="footer-text">Version <br>Last updated 2019-12-20 23:30:51 +00:00</div></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script>docsearch({
- apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
- indexName: 'jmonkeyengine',
- inputSelector: '#doc-search',
- debug: false // Set debug to true if you want to inspect the dropdown
- });</script></body></html>
|
