Browse Source

Updated docs to include sections on shadowMap.autoUpdate and shadowMap.needsUpdate

Rohan Deshpande 7 years ago
parent
commit
f43cb6efc5
1 changed files with 8 additions and 0 deletions
  1. 8 0
      docs/api/renderers/WebGLRenderer.html

+ 8 - 0
docs/api/renderers/WebGLRenderer.html

@@ -225,6 +225,14 @@
 		<h3>[property:Boolean shadowMap.enabled]</h3>
 		<div>If set, use shadow maps in the scene. Default is *false*.</div>
 
+		<h3>[property:Boolean shadowMap.autoUpdate]</h3>
+		<div>Enables automatic updates to the shadows in the scene. Default is *true*.</div>
+		<div>If you do not require dynamic lighting / shadows, you may set this to false after the first *render* call.</div>
+
+		<h3>[property:Boolean shadowMap.needsUpdate]</h3>
+		<div>When set to *true*, shadow maps in the scene will updated in the next *render* call. Default is *false*. </div>
+		<div>If you have disabled automatic updates to shadow maps (*shadowMap.autoUpdate = false*), you will need to set this to *true* and then make a render call to update the shadows in your scene.</div>
+
 		<h3>[property:Integer shadowMap.type]</h3>
 		<div>Defines shadow map type (unfiltered, percentage close filtering, percentage close filtering with bilinear filtering in shader)</div>
 		<div>Options are THREE.BasicShadowMap, THREE.PCFShadowMap (default), THREE.PCFSoftShadowMap. See [page:WebGLRenderer WebGLRenderer constants] for details.</div>