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

fix documentation typos

Browse Source
This commit is contained in:
Mathias Agopian
2019-03-11 15:51:11 -07:00
committed by Mathias Agopian
parent b44717ae54
commit fb4e498bc1
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
filament/include/filament/Box.h
View File

@@ -95,7 +95,7 @@ public:
}
/**
* Computes the smalest bounding sphere of the box.
* Computes the smallest bounding sphere of the box.
* @return The smallest sphere defined by its center (.xyz) and radius (.w) that contains *this
*/
filament::math::float4 getBoundingSphere() const noexcept {

10
filament/include/filament/Frustum.h
View File

@@ -54,33 +54,33 @@ public:
Frustum& operator=(Frustum&& rhs) noexcept = default;
/**
* Create a frustum from a projection matrix (usually the projection * view matrix)
* Creates a frustum from a projection matrix (usually the projection * view matrix)
* @param pv a 4x4 projection matrix
*/
explicit Frustum(const filament::math::mat4f& pv);
/**
* Set the frustum from the given projection matrix
* Sets the frustum from the given projection matrix
* @param pv a 4x4 projection matrix
*/
void setProjection(const filament::math::mat4f& pv);
/**
* Return the plane equation parameters with normalized normals
* Returns the plane equation parameters with normalized normals
* @param plane Identifier of the plane to retrieve the equation of
* @return A plane equation encoded a float4 R such as R.x*x + R.y*y + R.z*z = R.w
*/
filament::math::float4 getNormalizedPlane(Plane plane) const noexcept;
/**
* Return a copy of all six frustum planes in left, right, bottom, top, far, near order
* Returns a copy of all six frustum planes in left, right, bottom, top, far, near order
* @param planes six plane equations encoded as in getNormalizedPlane() in
* left, right, bottom, top, far, near order
*/
void getNormalizedPlanes(filament::math::float4 planes[6]) const noexcept;
/**
* Return all six frustum planes in left, right, bottom, top, far, near order
* Returns all six frustum planes in left, right, bottom, top, far, near order
* @return six plane equations encoded as in getNormalizedPlane() in
* left, right, bottom, top, far, near order
*/