Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a working THREE.js API documentation?

Tags:

three.js

webgl

I am trying to learn the basics of THREE.js. I have read a couple of tutorial, and I would like to start experimenting. My problem is that I am not able to find any documentation

This is supposed to be an API browser, but I was not able to find the very basic objects, like PlaneGeometry or SphereGeometry. Is there any other place where to find an API?

like image 751
Andrea Avatar asked Oct 26 '11 10:10

Andrea


People also ask

Is Three js an API?

js is a cross-browser JavaScript library and application programming interface (API) used to create and display animated 3D computer graphics in a web browser using WebGL. The source code is hosted in a repository on GitHub.

Is Babylon js better than three js?

Three. js tends to have better performance compared to Babylon out of the box, but with lower quality.

Can three js do 2D?

The way that Three. js structures its rendering means that the learning curve won't be too steep. It organizes all of the renders you'll do, whether 3D or 2D, under a “Scene” container.

Does Three js use OpenGL?

Three. js uses the WebGL engine in the browser for rendering scenes. The API is based on OpenGL (GL stands for graphics library), a desktop graphics API.


2 Answers

Another place to browse the API is here. I think both this and the one you referenced were generated before the recent name change for geometry objects. You could ask staunsholm to regenerate the API docs that he posted. Another, more official-looking place is here, but it still has quite a few "to-do's" in it.

I feel the same way about the lack of up-to-date documentation for THREE.js. If you want to apply some influence toward prioritizing this, you could reopen this bugtracker issue and comment on it. Or you could take it upon yourself :-) to maintain a frequently-updated THREE.js API reference, generated with jsdoc. Alternatively, you can dig through the source code and examples to find answers to your questions, and then update the apparently official wiki pages with your discoveries.

Sorry this is not the ideal solution you were hoping for, but maybe it's the best available solution for now. The author of three.js seems to feel that the API needs to stabilize more before a documentation effort would be worthwhile for him.

like image 197
LarsH Avatar answered Sep 18 '22 13:09

LarsH


Latest official API is currently here http://mrdoob.github.com/three.js/docs/

like image 23
Codler Avatar answered Sep 22 '22 13:09

Codler