Add document for browser support #12796

keqingrong · 2017-12-04T06:24:16Z

looeee · 2017-12-04T07:07:31Z

Live version:
https://rawgit.com/keqingrong/three.js/dec941e99efaa2ccee9bae793876e4f970d3831e/docs/#manual/introduction/Browser-support

looeee · 2017-12-04T07:18:38Z

docs/manual/introduction/Browser-support.html

+	<h2>Overview</h2>
+	<div>
+		<p>
+			<strong>TL;DR</strong> three.js supports most modern browsers, including Internet Explorer 11 and above.</p>


I think you can leave out the "TL;DR".

I think you can just say "Three.js supports all modern browsers" and leave it at that.

Actually I would word this a bit differently - the introduction doesn't make it that clear what this document is for.

Something like:

"Three.js can use WebGL to render you scenes on all modern browsers. For older browsers, especially Internet Explorer version 10 and below, you may have to fallback to one of the other renderers (CSS2DRenderer, CSS3DRenderer, SVGRenderer, CanvasRenderer). Additionally, you may have include some polyfills, especially if you are using files from the /examples folder."

Note: if you don't need to support these old browsers, then it is not recommended to use the other renderers as they are slower and support less features than the WebGLRenderer.

Browsers that support WebGL:

Google Chrome 9+, Firefox 4+, Opera 15+, Safari 5.1+, Internet Explorer 11 and Microsoft Edge (link to caniuse)

looeee · 2017-12-04T07:18:42Z

docs/manual/introduction/Browser-support.html

+		<p>
+			<strong>TL;DR</strong> three.js supports most modern browsers, including Internet Explorer 11 and above.</p>
+		<p>
+			three.js provides WebGL, Canvas, SVG and CSS renderers. Different renderers may have different requirements of compatibility.


Three.js at the start of a sentence should be capitalised.

I disagree, and always write it as three.js, even at the start of a sentence. See the wikipedia article for eBay, for example -- or iPad.

If that is bothersome to you, you can rewrite the sentence and avoid three.js as the first word.

We did discuss this before and the consensus then was to capitalize it at the start of sentences.

@looeee Where was this discussed?

If three.js is correct, this wikipedia article needs a revision 😁

BTW: I always write it as three.js, too.

We did discuss this before and the consensus then was to capitalize it at the start of sentences.

Can't remember. A link to this discussion would be helpful.

I personally don't mind. Three.js or three.js are fine. I have more of a problem with ThreeJS, threeJS, THREEjs and other variations...

looeee · 2017-12-04T07:19:27Z

docs/manual/introduction/Browser-support.html

+			instead. Note that CanvasRenderer only supports a small subset of WebGLRenderer's features.
+		</p>
+		<p>
+			For Internet Explorer, the table below lists avaiable renderers.


avaiable -> available

looeee · 2017-12-04T07:22:07Z

docs/manual/introduction/Browser-support.html

+		</table>
+	</div>
+
+	<h2>Part of ECMAScript Language Features or Web APIs Used in three.js</h2>


Drop the "Part of" -> ECMAScript Language Features or Web APIs Used in three.js.

Also, do we need to call it ECMAScript? This should be as beginner friendly as possible, not everyone knows that JavaScript and ECMAScript are the same.

looeee · 2017-12-04T07:41:07Z

docs/manual/introduction/Browser-support.html

+					<td>FileLoader, etc.</td>
+				</tr>
+				<tr>
+					<td>performance</td>


Clock already defaults back to Date.now if Performance.now is not found, so you can leave this one out.

looeee · 2017-12-04T07:48:15Z

docs/manual/introduction/Browser-support.html

+				<tr>
+					<td>Web Workers</td>
+					<td>Examples</td>
+					<td>WWOBJLoader2, etc.</td>


I think WWOBJLoader2 is now OBJLoader2 and uses workers only if they are available, so you can leave this on out.

looeee · 2017-12-04T07:52:50Z

docs/manual/introduction/Browser-support.html

+				<tr>
+					<td>Pointer Lock API</td>
+					<td>Examples</td>
+					<td>PointerLockControls, etc.</td>


no need for 'etc' here.

looeee · 2017-12-04T07:53:46Z

docs/manual/introduction/Browser-support.html

+				<a href="https://github.com/eligrey/Blob.js" target="_blank">Blob.js</a>
+			</li>
+			<li>
+				<a href="https://gist.github.com/paulirish/5438650" target="_blank">performance</a>


Again, no need for a Performance polyfill as the Clock already has a fallback.

looeee · 2017-12-04T07:57:41Z

docs/manual/introduction/Browser-support.html

+			<li>Typed Arrays</li>
+			<li>Blob</li>
+			<li>performance</li>
+			<li>requestAnimationFrame</li>


Actually you don't need to polyfill this - it's used in the WebGLRenderer (only for VR I think?), but you can't use that anyway with IE9.

looeee · 2017-12-04T07:57:59Z

docs/manual/introduction/Browser-support.html

+		<ul>
+			<li>Typed Arrays</li>
+			<li>Blob</li>
+			<li>performance</li>


Not needed - see my comment on Clock above.

looeee · 2017-12-04T07:58:58Z

docs/manual/introduction/Browser-support.html

+	<h2>Overview</h2>
+	<div>
+		<p>
+			<strong>TL;DR</strong> three.js supports most modern browsers, including Internet Explorer 11 and above.</p>


Actually I would word this a bit differently - the introduction doesn't make it that clear what this document is for.

Something like:

"Three.js can use WebGL to render you scenes on all modern browsers. For older browsers, especially Internet Explorer version 10 and below, you may have to fallback to one of the other renderers (CSS2DRenderer, CSS3DRenderer, SVGRenderer, CanvasRenderer). Additionally, you may have include some polyfills, especially if you are using files from the /examples folder."

Note: if you don't need to support these old browsers, then it is not recommended to use the other renderers as they are slower and support less features than the WebGLRenderer.

Browsers that support WebGL:

Google Chrome 9+, Firefox 4+, Opera 15+, Safari 5.1+, Internet Explorer 11 and Microsoft Edge (link to caniuse)

mrdoob · 2017-12-05T05:21:20Z

Thanks for reviewing @looeee 🙏

looeee · 2017-12-06T00:21:18Z

@keqingrong it's looking good now! Just a couple of minor issues, and sorry for the delay in getting back to you 😄

looeee · 2017-12-06T00:17:32Z

docs/manual/introduction/Browser-support.html

+	<h2>Browsers that support WebGL</h2>
+	<div>
+		<p>
+			Google Chrome 9+, Firefox 4+, Opera 15+, Safari 5.1+, Internet Explorer 11 and Microsoft Edge. You can find which browsers support WebGL at <a href="https://caniuse.com/#feat=webgl" target="_blank">Can I use WebGL?</a>.


Links can be done like this BTW:

[link:https://caniuse.com/#feat=webgl Can I use WebGL?]

...although some characters cause issues (you'll have to check if the # is OK.

looeee · 2017-12-06T00:19:28Z

docs/manual/introduction/Browser-support.html

+	<h2>Overview</h2>
+	<div>
+		<p>
+			Three.js can use WebGL to render your scenes on all modern browsers. For older browsers, especially Internet Explorer 10 and below, you may have to fallback to one of the other renderers (CSS2DRenderer, CSS3DRenderer, SVGRenderer, CanvasRenderer). Additionally, you may have to include some polyfills, especially if you are using files from the /examples folder.


Can you add a link to the folder with the other renderers?

...to one of the other [link:https://github.com/mrdoob/three.js/tree/master/examples/js/renderers renderers]

And also to the /examples folder:

...you are using files from the [link:https://github.com/mrdoob/three.js/tree/master/examples /examples] folder

looeee · 2017-12-06T00:20:30Z

docs/manual/introduction/Browser-support.html

+
+	<h2>Polyfills</h2>
+	<div>
+		<p>Just import polyfills base on your requirements. Taking IE9 as an example, you need to polyfill at least these features:</p>


base -> based

keqingrong · 2017-12-06T01:39:59Z

@looeee I've updated the links, thank you for reviewing! 😁

WestLangley · 2017-12-06T02:30:00Z

docs/manual/introduction/Browser-support.html

+		</p>
+	</div>
+
+	<h2>JavaScript Language Features or Web APIs Used in three.js</h2>


Sorry, I do not think this section provides sufficiently-valuable information, and it can be removed.

I don't think I agree. I think it's a good start and we can complete it over time. I think this is good information for new people to start grasping how the library works.

mrdoob · 2017-12-06T04:26:32Z

Thanks!

looeee requested changes Dec 4, 2017

View reviewed changes

keqingrong added 2 commits December 5, 2017 22:04

Add document for browser support

3675404

Update the document content

e2fe7c4

looeee requested changes Dec 6, 2017

View reviewed changes

Update links

3d54e6c

looeee approved these changes Dec 6, 2017

View reviewed changes

WestLangley reviewed Dec 6, 2017

View reviewed changes

mrdoob merged commit 0615d7f into mrdoob:dev Dec 6, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add document for browser support #12796

Add document for browser support #12796

keqingrong commented Dec 4, 2017

looeee commented Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

WestLangley Dec 4, 2017

looeee Dec 4, 2017

WestLangley Dec 4, 2017

Mugen87 Dec 4, 2017 •

edited

Loading

mrdoob Dec 5, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

looeee Dec 4, 2017

mrdoob commented Dec 5, 2017

looeee commented Dec 6, 2017

looeee Dec 6, 2017

looeee Dec 6, 2017

looeee Dec 6, 2017

keqingrong commented Dec 6, 2017

WestLangley Dec 6, 2017 •

edited

Loading

mrdoob Dec 6, 2017

mrdoob commented Dec 6, 2017

Add document for browser support #12796

Add document for browser support #12796

Conversation

keqingrong commented Dec 4, 2017

looeee commented Dec 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Browsers that support WebGL:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mugen87 Dec 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Browsers that support WebGL:

mrdoob commented Dec 5, 2017

looeee commented Dec 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keqingrong commented Dec 6, 2017

WestLangley Dec 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrdoob commented Dec 6, 2017

Mugen87 Dec 4, 2017 •

edited

Loading

WestLangley Dec 6, 2017 •

edited

Loading