Rendering documentation

src/Rendering/boundingBoxRenderer.ts

@@ -98,7 +98,7 @@ Object.defineProperty(AbstractMesh.prototype, "showBoundingBox", {
  */
 export class BoundingBoxRenderer implements ISceneComponent {
     /**
-     * The component name helpfull to identify the component in the list of scene components.
+     * The component name helpful to identify the component in the list of scene components.
      */
     public readonly name = SceneComponentConstants.NAME_BOUNDINGBOXRENDERER;
 

src/Rendering/depthRenderer.ts

@@ -37,7 +37,7 @@ export class DepthRenderer {
     public enabled = true;
 
     /**
-     * Specifiess that the depth renderer will only be used within
+     * Specifies that the depth renderer will only be used within
      * the camera it is created for.
      * This can help forcing its rendering during the camera processing.
      */

src/Rendering/depthRendererSceneComponent.ts

@@ -70,7 +70,7 @@ Scene.prototype.disableDepthRenderer = function(camera?: Nullable<Camera>): void
  */
 export class DepthRendererSceneComponent implements ISceneComponent {
     /**
-     * The component name helpfull to identify the component in the list of scene components.
+     * The component name helpful to identify the component in the list of scene components.
      */
     public readonly name = SceneComponentConstants.NAME_DEPTHRENDERER;
 
@@ -104,7 +104,7 @@ export class DepthRendererSceneComponent implements ISceneComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources
+     * Disposes the component and the associated resources
      */
     public dispose(): void {
         for (var key in this.scene._depthRenderer) {

src/Rendering/edgesRenderer.ts

@@ -120,7 +120,7 @@ export interface IEdgesRenderer extends IDisposable {
     render(): void;
 
     /**
-     * Checks wether or not the edges renderer is ready to render.
+     * Checks whether or not the edges renderer is ready to render.
      * @return true if ready, otherwise false.
      */
     isReady(): boolean;
@@ -150,7 +150,7 @@ export interface IEdgesRendererOptions {
     useFastVertexMerger?: boolean;
 
     /**
-     * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
+     * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit within which vertices are considered to be equal.
      * The default value is 1e-6
      * This option is used only if useAlternateEdgeFinder = true
      */
@@ -844,7 +844,7 @@ export class EdgesRenderer implements IEdgesRenderer {
     }
 
     /**
-     * Checks wether or not the edges renderer is ready to render.
+     * Checks whether or not the edges renderer is ready to render.
      * @return true if ready, otherwise false.
      */
     public isReady(): boolean {

src/Rendering/geometryBufferRenderer.ts

@@ -31,7 +31,7 @@ interface ISavedTransformationMatrix {
 }
 
 /**
- * This renderer is helpfull to fill one of the render target with a geometry buffer.
+ * This renderer is helpful to fill one of the render target with a geometry buffer.
  */
 export class GeometryBufferRenderer {
     /**
@@ -197,7 +197,7 @@ export class GeometryBufferRenderer {
     }
 
     /**
-     * Gets wether or not G buffer are supported by the running hardware.
+     * Gets whether or not G buffer are supported by the running hardware.
      * This requires draw buffer supports
      */
     public get isSupported(): boolean {
@@ -246,7 +246,7 @@ export class GeometryBufferRenderer {
     }
 
     /**
-     * Sets wether or not objects velocities are enabled for the G buffer.
+     * Sets whether or not objects velocities are enabled for the G buffer.
      */
     public set enableVelocity(enable: boolean) {
         this._enableVelocity = enable;
@@ -269,7 +269,7 @@ export class GeometryBufferRenderer {
     }
 
     /**
-     * Sets wether or not objects roughness are enabled for the G buffer.
+     * Sets whether or not objects roughness are enabled for the G buffer.
      */
     public set enableReflectivity(enable: boolean) {
         this._enableReflectivity = enable;
@@ -317,7 +317,7 @@ export class GeometryBufferRenderer {
     }
 
     /**
-     * Checks wether everything is ready to render a submesh to the G buffer.
+     * Checks whether everything is ready to render a submesh to the G buffer.
      * @param subMesh the submesh to check readiness for
      * @param useInstances is the mesh drawn using instance or not
      * @returns true if ready otherwise false

src/Rendering/geometryBufferRendererSceneComponent.ts

@@ -103,7 +103,7 @@ export class GeometryBufferRendererSceneComponent implements ISceneComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources
+     * Disposes the component and the associated resources
      */
     public dispose(): void {
         // Nothing to do for this component

src/Rendering/outlineRenderer.ts

@@ -86,7 +86,7 @@ Object.defineProperty(Mesh.prototype, "renderOverlay", {
 });
 
 /**
- * This class is responsible to draw bothe outline/overlay of meshes.
+ * This class is responsible to draw the outline/overlay of meshes.
  * It should not be used directly but through the available method on mesh.
  */
 export class OutlineRenderer implements ISceneComponent {
@@ -141,7 +141,7 @@ export class OutlineRenderer implements ISceneComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources.
+     * Disposes the component and the associated resources.
      */
     public dispose(): void {
         // Nothing to do here.
@@ -214,8 +214,8 @@ export class OutlineRenderer implements ISceneComponent {
     /**
      * Returns whether or not the outline renderer is ready for a given submesh.
      * All the dependencies e.g. submeshes, texture, effect... mus be ready
-     * @param subMesh Defines the submesh to check readyness for
-     * @param useInstances Defines wheter wee are trying to render instances or not
+     * @param subMesh Defines the submesh to check readiness for
+     * @param useInstances Defines whether wee are trying to render instances or not
      * @returns true if ready otherwise false
      */
     public isReady(subMesh: SubMesh, useInstances: boolean): boolean {

src/Rendering/prePassRendererSceneComponent.ts

@@ -195,7 +195,7 @@ export class PrePassRendererSceneComponent implements ISceneComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources
+     * Disposes the component and the associated resources
      */
     public dispose(): void {
         this.scene.disablePrePassRenderer();

src/Rendering/renderingManager.ts

@@ -107,7 +107,7 @@ export class RenderingManager {
     }
 
     /**
-     * Renders the entire managed groups. This is used by the scene or the different rennder targets.
+     * Renders the entire managed groups. This is used by the scene or the different render targets.
      * @hidden
      */
     public render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>,
@@ -252,8 +252,8 @@ export class RenderingManager {
     }
 
     /**
-     * Overrides the default sort function applied in the renderging group to prepare the meshes.
-     * This allowed control for front to back rendering or reversly depending of the special needs.
+     * Overrides the default sort function applied in the rendering group to prepare the meshes.
+     * This allowed control for front to back rendering or reversely depending of the special needs.
      *
      * @param renderingGroupId The rendering group id corresponding to its index
      * @param opaqueSortCompareFn The opaque queue comparison function use to sort.

src/Rendering/subSurfaceSceneComponent.ts

@@ -163,7 +163,7 @@ export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources
+     * Disposes the component and the associated resources
      */
     public dispose(): void {
         // Nothing to do for this component