Scarfski/filament
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docs typos

Browse Source
This commit is contained in:
Romain Guy
2021-02-20 16:43:12 -08:00
parent 22d16c1910
commit 5d9384fca7
2 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
android/filament-android/src/main/java/com/google/android/filament/Camera.java
View File

@@ -27,16 +27,12 @@ import androidx.annotation.Size;
*
* <h1><u>Creation and destruction</u></h1>
*
* Unlike most Filament objects, Camera doesn't require a builder and can be constructed directly
* using {@link Engine#createCamera}. At the very least, a projection must be defined
* using {@link #setProjection}. In most case, the camera position also needs to be set.
* <p>
* A Camera object is destroyed using {@link Engine#destroyCamera}.
* In Filament, Camera is a component that must be associated with an entity. To do so,
* use {@link Engine#createCamera(int)}. A Camera component is destroyed using
* {@link Engine#destroyCamera(Camera)}.
*
* <pre>
* Engine engine = Engine.create();
*
* Camera myCamera = engine.createCamera();
* Camera myCamera = engine.createCamera(myCameraEntity);
* myCamera.setProjection(45, 16.0/9.0, 0.1, 1.0);
* myCamera.lookAt(0, 1.60, 1,
* 0, 0, 0,

14
filament/include/filament/Camera.h
View File

@@ -39,20 +39,18 @@ namespace filament {
* Creation and destruction
* ========================
*
* Like all Filament objects, Camera can only be constructed on the heap, however, unlike most
* Filament objects it doesn't require a builder and can be constructed directly
* using Engine::createCamera(). At the very least, a projection must be defined
* using setProjection(). In most case, the camera position also needs to be set.
*
* A Camera object is destroyed using Engine::destroy(const Camera*).
* In Filament, Camera is a component that must be associated with an entity. To do so,
* use Engine::createCamera(Entity). A Camera component is destroyed using
* Engine::destroyCameraComponent(Entity).
*
* ~~~~~~~~~~~{.cpp}
* filament::Engine* engine = filament::Engine::create();
*
* filament::Camera* myCamera = engine->createCamera();
* utils::Entity myCameraEntity = utils::EntityManager::get().create();
* filament::Camera* myCamera = engine->createCamera(myCameraEntity);
* myCamera->setProjection(45, 16.0/9.0, 0.1, 1.0);
* myCamera->lookAt({0, 1.60, 1}, {0, 0, 0});
* engine->destroy(myCamera);
* engine->destroyCameraComponent(myCamera);
* ~~~~~~~~~~~
*
*