Merge pull request #9710 from jasonsturges/doc/layers

Layers documentation

src/Layers/effectLayer.ts

@@ -63,7 +63,7 @@ export interface IEffectLayerOptions {
 /**
  * The effect layer Helps adding post process effect blended with the main pass.
  *
- * This can be for instance use to generate glow or higlight effects on the scene.
+ * This can be for instance use to generate glow or highlight effects on the scene.
  *
  * The effect layer class can not be used directly and is intented to inherited from to be
  * customized per effects.
@@ -161,7 +161,7 @@ export abstract class EffectLayer {
     public onAfterComposeObservable = new Observable<EffectLayer>();
 
     /**
-     * An event triggered when the efffect layer changes its size.
+     * An event triggered when the effect layer changes its size.
      */
     public onSizeChangedObservable = new Observable<EffectLayer>();
 
@@ -208,7 +208,7 @@ export abstract class EffectLayer {
     public abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
 
     /**
-     * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
+     * Returns whether or not the layer needs stencil enabled during the mesh rendering.
      * @returns true if the effect requires stencil during the main canvas render pass.
      */
     public abstract needStencil(): boolean;

src/Layers/effectLayerSceneComponent.ts

@@ -64,7 +64,7 @@ AbstractScene.prototype.addEffectLayer = function(newEffectLayer: EffectLayer):
  */
 export class EffectLayerSceneComponent implements ISceneSerializableComponent {
     /**
-     * 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_EFFECTLAYER;
 
@@ -162,7 +162,7 @@ export class EffectLayerSceneComponent implements ISceneSerializableComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources.
+     * Disposes the component and the associated resources.
      */
     public dispose(): void {
         let layers = this.scene.effectLayers;

src/Layers/glowLayer.ts

@@ -57,7 +57,7 @@ export interface IGlowLayerOptions {
     mainTextureRatio: number;
 
     /**
-     * Enforces a fixed size texture to ensure resize independant blur.
+     * Enforces a fixed size texture to ensure resize independent blur.
      */
     mainTextureFixedSize?: number;
 
@@ -72,7 +72,7 @@ export interface IGlowLayerOptions {
     camera: Nullable<Camera>;
 
     /**
-     * Enable MSAA by chosing the number of samples.
+     * Enable MSAA by choosing the number of samples.
      */
     mainTextureSamples?: number;
 
@@ -334,7 +334,7 @@ export class GlowLayer extends EffectLayer {
     /**
      * Checks for the readiness of the element composing the layer.
      * @param subMesh the mesh to check for
-     * @param useInstances specify wether or not to use instances to render the mesh
+     * @param useInstances specify whether or not to use instances to render the mesh
      * @param emissiveTexture the associated emissive texture used to generate the glow
      * @return true if ready otherwise, false
      */
@@ -351,7 +351,7 @@ export class GlowLayer extends EffectLayer {
     }
 
     /**
-     * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
+     * Returns whether or not the layer needs stencil enabled during the mesh rendering.
      */
     public needStencil(): boolean {
         return false;

src/Layers/highlightLayer.ts

@@ -76,7 +76,7 @@ export interface IHighlightLayerOptions {
     mainTextureRatio: number;
 
     /**
-     * Enforces a fixed size texture to ensure resize independant blur.
+     * Enforces a fixed size texture to ensure resize independent blur.
      */
     mainTextureFixedSize?: number;
 
@@ -415,7 +415,7 @@ export class HighlightLayer extends EffectLayer {
     }
 
     /**
-     * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
+     * Returns whether or not the layer needs stencil enabled during the mesh rendering.
      */
     public needStencil(): boolean {
         return true;

src/Layers/layer.ts

@@ -274,7 +274,7 @@ export class Layer {
     }
 
     /**
-     * Disposes and releases the associated ressources.
+     * Disposes and releases the associated resources.
      */
     public dispose(): void {
         var vertexBuffer = this._vertexBuffers[VertexBuffer.PositionKind];

src/Layers/layerSceneComponent.ts

@@ -21,7 +21,7 @@ declare module "../abstractScene" {
  */
 export class LayerSceneComponent 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_LAYER;
 
@@ -66,7 +66,7 @@ export class LayerSceneComponent implements ISceneComponent {
     }
 
     /**
-     * Disposes the component and the associated ressources.
+     * Disposes the component and the associated resources.
      */
     public dispose(): void {
         let layers = this.scene.layers;