Browse Source

Docs master

github-actions[bot] 4 days ago
parent
commit
6504aa2eef

BIN
html/master/_images/materials.png


File diff suppressed because it is too large
+ 45 - 0
html/master/_images/mesh_renderer_material.svg


BIN
html/master/_images/shading_environment.png


+ 2 - 0
html/master/_sources/rendering/index.rst.txt

@@ -6,3 +6,5 @@ Rendering
     :maxdepth: 2
 
     lighting
+    materials
+    shading_environment

+ 1 - 1
html/master/_sources/rendering/lighting.rst.txt

@@ -83,4 +83,4 @@ Crown automatically adds an implicit skydome Unit to every new Level created
 with the :ref:`Level Editor <level_editor>`. It is rendered on the current
 camera's far plane and is always centered to it, so it appears infinitely
 distant and does not shift as the camera moves. Its texture and intensity are
-configured via the :ref:`Shading Environment`.
+configured via the :ref:`Shading Environment <Global Lighting>`.

+ 59 - 0
html/master/_sources/rendering/materials.rst.txt

@@ -0,0 +1,59 @@
+=========
+Materials
+=========
+
+Materials in Crown are resources with the ``.material`` extension. They define
+the shading (i.e. the visual appearance) of objects in the scene.
+
+.. figure:: images/materials.png
+   :align: center
+
+   Some materials displayed in the Project Browser.
+
+At the technical level, a material binds a shader together with its options
+and parameters (uniforms and samplers). For example, the built-in
+``core/units/primitive`` material uses the shader named ``mesh`` and assigns
+values appropriate to primitive objects to all uniforms that shader exposes.
+
+Creating Materials
+==================
+
+Materials are normally created indirectly by the :ref:`importers
+<importing_resources>` when you bring in external resources.
+
+For instance:
+
+* Importing a 3D scene automatically generates the required ``.material``
+  resources
+* Importing sprites also produces associated material resources
+
+You can also create standalone materials directly in the :ref:`Level Editor
+<level_editor>`:
+
+1. Open the :ref:`Project Browser`
+2. Right-click inside the target folder
+3. Choose ``New Material...``
+4. Give it a unique name and confirm
+
+Assigning Materials to Units
+============================
+
+Materials are assigned to units through their rendering components. The ``Mesh
+Renderer`` component for example exposes a ``Material`` property.
+
+.. figure:: images/mesh_renderer_material.svg
+   :align: center
+
+   The Material selector in the Mesh Renderer component.
+
+Click the folder icon next to the material's name to open the Material Chooser
+and pick the desired material from the list.
+
+You can also assign materials programmatically at runtime via
+the :ref:`RenderWorld` Lua API.
+
+Modifying Material properties
+=============================
+
+Once a material is assigned, you can modify its properties dynamically from
+Lua scripts using the :ref:`Material` API.

+ 77 - 0
html/master/_sources/rendering/shading_environment.rst.txt

@@ -0,0 +1,77 @@
+===================
+Shading Environment
+===================
+
+The shading environment is a regular :ref:`unit <Units>` that groups
+components controlling global rendering features. Crown uses the properties
+defined in this unit to drive many aspects of scene rendering.
+
+.. figure:: images/shading_environment.png
+   :align: center
+
+   The Shading Environment unit with some of its components shown in the Inspector.
+
+Custom Shading Environment
+==========================
+
+Every level must contain exactly one shading environment unit named
+``shading_environment``. When you create a new level with the :ref:`Level
+Editor`, Crown inserts a default shading environment unit for that level.
+
+Because the shading environment is a Unit, you can edit its components in the
+Inspector and :ref:`save the unit as a prefab<From the Level Editor>` for
+reuse in other levels.
+
+Default components
+==================
+
+Crown provides a set of components commonly attached to the shading
+environment. These components establish the scene base look and control
+post-processing effects.
+
+Global Lighting
+---------------
+
+The Global Lighting component controls the :ref:`Skydome` and ambient light
+contribution:
+
+* ``Skydome Map``: equirectangular projection texture used to render the skydome
+* ``Skydome Intensity``: multiplier applied to the skydome texture to boost or
+  soften its contribution
+* ``Ambient Color``: base color added to objects when direct lighting is
+  absent
+
+Fog
+---
+
+The Fog component simulates atmospheric scattering between the camera and
+shaded objects:
+
+* ``Color``: fog base color
+* ``Density``: overall fog strength; higher values make distant objects appear
+  foggier
+* ``Range Min`` / ``Range Max``: distances from the camera where fog starts
+  and ends
+* ``Sun Blend``: mixes the :ref:`sun <Directional light>` color into the fog
+  (0 = no sun influence, 1 = fog color replaced by sun color)
+* ``Enabled``: toggle the fog simulation
+
+Bloom
+-----
+
+The Bloom component adds glow around very bright parts of the image.
+
+* ``Weight``: blending weight of the bloom contribution (0 = no bloom contribution, 1 = image is replaced by bloom)
+* ``Intensity``: bloom brightness
+* ``Enabled``: toggle the effect
+
+Tonemap
+-------
+
+The Tonemap component maps the renderer's HDR output to the displayable color
+range of the monitor.
+
+* ``Gamma``: no complex tonemapping, only gamma correction
+* ``Reinhard``
+* ``Filmic``
+* ``ACES``

+ 2 - 2
html/master/gameplay/index.html

@@ -30,7 +30,7 @@
     <link rel="search" title="Search" href="../search.html" />
     <link rel="copyright" title="Copyright" href="../copyright.html" />
     <link rel="next" title="Scripting in Lua" href="lua_scripting.html" />
-    <link rel="prev" title="Lighting" href="../rendering/lighting.html" /> 
+    <link rel="prev" title="Shading Environment" href="../rendering/shading_environment.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -134,7 +134,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../rendering/lighting.html" class="btn btn-neutral float-left" title="Lighting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../rendering/shading_environment.html" class="btn btn-neutral float-left" title="Shading Environment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="lua_scripting.html" class="btn btn-neutral float-right" title="Scripting in Lua" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

+ 2 - 0
html/master/index.html

@@ -172,6 +172,8 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="rendering/index.html">Rendering</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="rendering/lighting.html">Lighting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rendering/materials.html">Materials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rendering/shading_environment.html">Shading Environment</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="gameplay/index.html">Writing Gameplay</a><ul>

BIN
html/master/objects.inv


+ 16 - 3
html/master/rendering/index.html

@@ -3,12 +3,12 @@
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <meta property="article:modified_time" content="2026-02-20T16:01:57+00:00" /><meta property="og:title" content="Rendering" />
+    <meta property="article:modified_time" content="2026-02-20T16:57:39+00:00" /><meta property="og:title" content="Rendering" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://docs.crownengine.org/html/latest/rendering/index.html" />
 <meta property="og:site_name" content="Crown 0.60.0 Manual" />
-<meta property="og:description" content="Lighting- Directional light, Local lights, Shadows, Skydome.." />
-<meta name="description" content="Lighting- Directional light, Local lights, Shadows, Skydome.." />
+<meta property="og:description" content="Lighting- Directional light, Local lights, Shadows, Skydome., Materials- Creating Materials, Assigning Materials to Units, Modifying Material properties., Shading Environment- Custom Shading Environment, Default components.." />
+<meta name="description" content="Lighting- Directional light, Local lights, Shadows, Skydome., Materials- Creating Materials, Assigning Materials to Units, Modifying Material properties., Shading Environment- Custom Shading Environment, Default components.." />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Rendering &mdash; Crown 0.60.0 Manual 0.61.0 documentation</title>
@@ -62,6 +62,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../units/index.html">Units</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Rendering</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="lighting.html">Lighting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="materials.html">Materials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="shading_environment.html">Shading Environment</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
@@ -108,6 +110,17 @@
 <li class="toctree-l2"><a class="reference internal" href="lighting.html#skydome">Skydome</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="materials.html">Materials</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="materials.html#creating-materials">Creating Materials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="materials.html#assigning-materials-to-units">Assigning Materials to Units</a></li>
+<li class="toctree-l2"><a class="reference internal" href="materials.html#modifying-material-properties">Modifying Material properties</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="shading_environment.html">Shading Environment</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="shading_environment.html#custom-shading-environment">Custom Shading Environment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="shading_environment.html#default-components">Default components</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>

+ 6 - 4
html/master/rendering/lighting.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <meta property="article:modified_time" content="2026-02-20T16:19:54+00:00" /><meta property="og:title" content="Lighting" />
+    <meta property="article:modified_time" content="2026-02-20T16:56:59+00:00" /><meta property="og:title" content="Lighting" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://docs.crownengine.org/html/latest/rendering/lighting.html" />
 <meta property="og:site_name" content="Crown 0.60.0 Manual" />
@@ -31,7 +31,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="copyright" title="Copyright" href="../copyright.html" />
-    <link rel="next" title="Writing Gameplay" href="../gameplay/index.html" />
+    <link rel="next" title="Materials" href="materials.html" />
     <link rel="prev" title="Rendering" href="index.html" /> 
 </head>
 
@@ -74,6 +74,8 @@
 <li class="toctree-l3"><a class="reference internal" href="#skydome">Skydome</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="materials.html">Materials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="shading_environment.html">Shading Environment</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
@@ -188,7 +190,7 @@ bias incrementally to find the best compromise for your Level.</p>
 with the <a class="reference internal" href="../level_editor/level_editor.html#level-editor"><span class="std std-ref">Level Editor</span></a>. It is rendered on the current
 camera’s far plane and is always centered to it, so it appears infinitely
 distant and does not shift as the camera moves. Its texture and intensity are
-configured via the <span class="xref std std-ref">Shading Environment</span>.</p>
+configured via the <a class="reference internal" href="shading_environment.html#global-lighting"><span class="std std-ref">Shading Environment</span></a>.</p>
 </section>
 </section>
 
@@ -197,7 +199,7 @@ configured via the <span class="xref std std-ref">Shading Environment</span>.</p
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="index.html" class="btn btn-neutral float-left" title="Rendering" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="../gameplay/index.html" class="btn btn-neutral float-right" title="Writing Gameplay" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="materials.html" class="btn btn-neutral float-right" title="Materials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

+ 206 - 0
html/master/rendering/materials.html

@@ -0,0 +1,206 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+    <meta property="article:modified_time" content="2026-02-20T16:57:39+00:00" /><meta property="og:title" content="Materials" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="https://docs.crownengine.org/html/latest/rendering/materials.html" />
+<meta property="og:site_name" content="Crown 0.60.0 Manual" />
+<meta property="og:description" content="Materials in Crown are resources with the.material extension. They define the shading (i.e. the visual appearance) of objects in the scene. Some materials displayed in the Project Browser., At the technical level, a material binds a shader together with its options and paramet..." />
+<meta property="og:image" content="https://docs.crownengine.org/html/latest/_images/materials.png" />
+<meta property="og:image:alt" content="Crown 0.60.0 Manual" />
+<meta name="description" content="Materials in Crown are resources with the.material extension. They define the shading (i.e. the visual appearance) of objects in the scene. Some materials displayed in the Project Browser., At the technical level, a material binds a shader together with its options and paramet..." />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Materials &mdash; Crown 0.60.0 Manual 0.61.0 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="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
+    <link rel="canonical" href="https://docs.crownengine.org/html/latest/rendering/materials.html" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.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="copyright" title="Copyright" href="../copyright.html" />
+    <link rel="next" title="Shading Environment" href="shading_environment.html" />
+    <link rel="prev" title="Lighting" href="lighting.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">
+            <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                Crown 0.60.0 Manual
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="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">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../level_editor/index.html">Level Editor</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../units/index.html">Units</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Rendering</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="lighting.html">Lighting</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Materials</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#creating-materials">Creating Materials</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#assigning-materials-to-units">Assigning Materials to Units</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#modifying-material-properties">Modifying Material properties</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="shading_environment.html">Shading Environment</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Engine Hackers</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><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">Crown 0.60.0 Manual</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"></a> &raquo;</li>
+          <li><a href="index.html">Rendering</a> &raquo;</li>
+      <li>Materials</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/rendering/materials.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="materials">
+<h1>Materials<a class="headerlink" href="#materials" title="Permalink to this headline">¶</a></h1>
+<p>Materials in Crown are resources with the <code class="docutils literal notranslate"><span class="pre">.material</span></code> extension. They define
+the shading (i.e. the visual appearance) of objects in the scene.</p>
+<figure class="align-center" id="id1">
+<img alt="../_images/materials.png" src="../_images/materials.png" />
+<figcaption>
+<p><span class="caption-text">Some materials displayed in the Project Browser.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
+</figcaption>
+</figure>
+<p>At the technical level, a material binds a shader together with its options
+and parameters (uniforms and samplers). For example, the built-in
+<code class="docutils literal notranslate"><span class="pre">core/units/primitive</span></code> material uses the shader named <code class="docutils literal notranslate"><span class="pre">mesh</span></code> and assigns
+values appropriate to primitive objects to all uniforms that shader exposes.</p>
+<section id="creating-materials">
+<h2>Creating Materials<a class="headerlink" href="#creating-materials" title="Permalink to this headline">¶</a></h2>
+<p>Materials are normally created indirectly by the <a class="reference internal" href="../importing_resources/importing_resources.html#importing-resources"><span class="std std-ref">importers</span></a> when you bring in external resources.</p>
+<p>For instance:</p>
+<ul class="simple">
+<li><p>Importing a 3D scene automatically generates the required <code class="docutils literal notranslate"><span class="pre">.material</span></code>
+resources</p></li>
+<li><p>Importing sprites also produces associated material resources</p></li>
+</ul>
+<p>You can also create standalone materials directly in the <a class="reference internal" href="../level_editor/level_editor.html#level-editor"><span class="std std-ref">Level Editor</span></a>:</p>
+<ol class="arabic simple">
+<li><p>Open the <a class="reference internal" href="../level_editor/project_browser.html#project-browser"><span class="std std-ref">Project Browser</span></a></p></li>
+<li><p>Right-click inside the target folder</p></li>
+<li><p>Choose <code class="docutils literal notranslate"><span class="pre">New</span> <span class="pre">Material...</span></code></p></li>
+<li><p>Give it a unique name and confirm</p></li>
+</ol>
+</section>
+<section id="assigning-materials-to-units">
+<h2>Assigning Materials to Units<a class="headerlink" href="#assigning-materials-to-units" title="Permalink to this headline">¶</a></h2>
+<p>Materials are assigned to units through their rendering components. The <code class="docutils literal notranslate"><span class="pre">Mesh</span>
+<span class="pre">Renderer</span></code> component for example exposes a <code class="docutils literal notranslate"><span class="pre">Material</span></code> property.</p>
+<figure class="align-center" id="id2">
+<img alt="../_images/mesh_renderer_material.svg" src="../_images/mesh_renderer_material.svg" /><figcaption>
+<p><span class="caption-text">The Material selector in the Mesh Renderer component.</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
+</figcaption>
+</figure>
+<p>Click the folder icon next to the material’s name to open the Material Chooser
+and pick the desired material from the list.</p>
+<p>You can also assign materials programmatically at runtime via
+the <a class="reference internal" href="../lua_api.html#renderworld"><span class="std std-ref">RenderWorld</span></a> Lua API.</p>
+</section>
+<section id="modifying-material-properties">
+<h2>Modifying Material properties<a class="headerlink" href="#modifying-material-properties" title="Permalink to this headline">¶</a></h2>
+<p>Once a material is assigned, you can modify its properties dynamically from
+Lua scripts using the <a class="reference internal" href="../lua_api.html#material"><span class="std std-ref">Material</span></a> API.</p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="lighting.html" class="btn btn-neutral float-left" title="Lighting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="shading_environment.html" class="btn btn-neutral float-right" title="Shading Environment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; <a href="../copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.
+      <span class="lastupdated">Last updated on Feb 20, 2026.
+      </span></p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+    <!-- Theme Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'G-XNVGCMNDZH', {
+          'anonymize_ip': true,
+      });
+    </script> 
+
+</body>
+</html>

+ 233 - 0
html/master/rendering/shading_environment.html

@@ -0,0 +1,233 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+    <meta property="article:modified_time" content="2026-02-20T16:56:59+00:00" /><meta property="og:title" content="Shading Environment" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="https://docs.crownengine.org/html/latest/rendering/shading_environment.html" />
+<meta property="og:site_name" content="Crown 0.60.0 Manual" />
+<meta property="og:description" content="The shading environment is a regular unit that groups components controlling global rendering features. Crown uses the properties defined in this unit to drive many aspects of scene rendering. The Shading Environment unit with some of its components shown in the Inspector., Cu..." />
+<meta property="og:image" content="https://docs.crownengine.org/html/latest/_images/shading_environment.png" />
+<meta property="og:image:alt" content="Crown 0.60.0 Manual" />
+<meta name="description" content="The shading environment is a regular unit that groups components controlling global rendering features. Crown uses the properties defined in this unit to drive many aspects of scene rendering. The Shading Environment unit with some of its components shown in the Inspector., Cu..." />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Shading Environment &mdash; Crown 0.60.0 Manual 0.61.0 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="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
+    <link rel="canonical" href="https://docs.crownengine.org/html/latest/rendering/shading_environment.html" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.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="copyright" title="Copyright" href="../copyright.html" />
+    <link rel="next" title="Writing Gameplay" href="../gameplay/index.html" />
+    <link rel="prev" title="Materials" href="materials.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">
+            <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                Crown 0.60.0 Manual
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="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">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../level_editor/index.html">Level Editor</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../units/index.html">Units</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Rendering</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="lighting.html">Lighting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="materials.html">Materials</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Shading Environment</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#custom-shading-environment">Custom Shading Environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#default-components">Default components</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#global-lighting">Global Lighting</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#fog">Fog</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#bloom">Bloom</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#tonemap">Tonemap</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Engine Hackers</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><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">Crown 0.60.0 Manual</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"></a> &raquo;</li>
+          <li><a href="index.html">Rendering</a> &raquo;</li>
+      <li>Shading Environment</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/rendering/shading_environment.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="shading-environment">
+<h1>Shading Environment<a class="headerlink" href="#shading-environment" title="Permalink to this headline">¶</a></h1>
+<p>The shading environment is a regular <a class="reference internal" href="../units/introduction.html#units"><span class="std std-ref">unit</span></a> that groups
+components controlling global rendering features. Crown uses the properties
+defined in this unit to drive many aspects of scene rendering.</p>
+<figure class="align-center" id="id1">
+<img alt="../_images/shading_environment.png" src="../_images/shading_environment.png" />
+<figcaption>
+<p><span class="caption-text">The Shading Environment unit with some of its components shown in the Inspector.</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
+</figcaption>
+</figure>
+<section id="custom-shading-environment">
+<h2>Custom Shading Environment<a class="headerlink" href="#custom-shading-environment" title="Permalink to this headline">¶</a></h2>
+<p>Every level must contain exactly one shading environment unit named
+<code class="docutils literal notranslate"><span class="pre">shading_environment</span></code>. When you create a new level with the <a class="reference internal" href="../level_editor/index.html#level-editor"><span class="std std-ref">Level Editor</span></a>, Crown inserts a default shading environment unit for that level.</p>
+<p>Because the shading environment is a Unit, you can edit its components in the
+Inspector and <a class="reference internal" href="../units/creating_units.html#from-the-level-editor"><span class="std std-ref">save the unit as a prefab</span></a> for
+reuse in other levels.</p>
+</section>
+<section id="default-components">
+<h2>Default components<a class="headerlink" href="#default-components" title="Permalink to this headline">¶</a></h2>
+<p>Crown provides a set of components commonly attached to the shading
+environment. These components establish the scene base look and control
+post-processing effects.</p>
+<section id="global-lighting">
+<h3>Global Lighting<a class="headerlink" href="#global-lighting" title="Permalink to this headline">¶</a></h3>
+<p>The Global Lighting component controls the <a class="reference internal" href="lighting.html#skydome"><span class="std std-ref">Skydome</span></a> and ambient light
+contribution:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">Skydome</span> <span class="pre">Map</span></code>: equirectangular projection texture used to render the skydome</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Skydome</span> <span class="pre">Intensity</span></code>: multiplier applied to the skydome texture to boost or
+soften its contribution</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Ambient</span> <span class="pre">Color</span></code>: base color added to objects when direct lighting is
+absent</p></li>
+</ul>
+</section>
+<section id="fog">
+<h3>Fog<a class="headerlink" href="#fog" title="Permalink to this headline">¶</a></h3>
+<p>The Fog component simulates atmospheric scattering between the camera and
+shaded objects:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">Color</span></code>: fog base color</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Density</span></code>: overall fog strength; higher values make distant objects appear
+foggier</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Range</span> <span class="pre">Min</span></code> / <code class="docutils literal notranslate"><span class="pre">Range</span> <span class="pre">Max</span></code>: distances from the camera where fog starts
+and ends</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Sun</span> <span class="pre">Blend</span></code>: mixes the <a class="reference internal" href="lighting.html#directional-light"><span class="std std-ref">sun</span></a> color into the fog
+(0 = no sun influence, 1 = fog color replaced by sun color)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Enabled</span></code>: toggle the fog simulation</p></li>
+</ul>
+</section>
+<section id="bloom">
+<h3>Bloom<a class="headerlink" href="#bloom" title="Permalink to this headline">¶</a></h3>
+<p>The Bloom component adds glow around very bright parts of the image.</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">Weight</span></code>: blending weight of the bloom contribution (0 = no bloom contribution, 1 = image is replaced by bloom)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Intensity</span></code>: bloom brightness</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Enabled</span></code>: toggle the effect</p></li>
+</ul>
+</section>
+<section id="tonemap">
+<h3>Tonemap<a class="headerlink" href="#tonemap" title="Permalink to this headline">¶</a></h3>
+<p>The Tonemap component maps the renderer’s HDR output to the displayable color
+range of the monitor.</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">Gamma</span></code>: no complex tonemapping, only gamma correction</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Reinhard</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Filmic</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">ACES</span></code></p></li>
+</ul>
+</section>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="materials.html" class="btn btn-neutral float-left" title="Materials" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../gameplay/index.html" class="btn btn-neutral float-right" title="Writing Gameplay" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; <a href="../copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.
+      <span class="lastupdated">Last updated on Feb 20, 2026.
+      </span></p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+    <!-- Theme Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'G-XNVGCMNDZH', {
+          'anonymize_ip': true,
+      });
+    </script> 
+
+</body>
+</html>

File diff suppressed because it is too large
+ 0 - 0
html/master/searchindex.js


File diff suppressed because it is too large
+ 0 - 0
html/master/sitemap.xml


Some files were not shown because too many files changed in this diff