Browse Source

Clarify what CanvasRenderer is and what it's not

Sylvain Beucler 12 years ago
parent
commit
f61f3ef17a
1 changed files with 13 additions and 1 deletions
  1. 13 1
      docs/api/renderers/CanvasRenderer.html

+ 13 - 1
docs/api/renderers/CanvasRenderer.html

@@ -9,7 +9,19 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">The Canvas renderer displays your beautifully crafted scenes <em>not</em> using WebGL, but with a software renderer.</div>
+		<div class="desc">This renderer can be a nice fallback from [page:WebGLRenderer] for simple scenes:</div>
+		<code>
+		if (window.WebGLRenderingContext)
+			renderer = new THREE.WebGLRenderer();
+		else
+			renderer = new THREE.CanvasRenderer();
+		</code>
+		<div class="desc">
+			Note: both WebGLRenderer and CanvasRenderer are embedded in the web page using an HTML5 &lt;canvas&gt; tag.
+			The "Canvas" in CanvasRenderer means it uses Canvas2D instead of WebGL.<br />
+			Don't confuse either CanvasRenderer with the SoftwareRenderer example, which simulates a screen buffer in a Javascript array.
+		</div>
 
 
 		<h2>Constructor</h2>