@babylonjs/core 5.23.0 → 5.25.0

package/Materials/PBR/pbrBaseMaterial.d.ts

@@ -26,7 +26,7 @@ import { PBRSubSurfaceConfiguration } from "./pbrSubSurfaceConfiguration";
 import { DetailMapConfiguration } from "../material.detailMapConfiguration";
 /**
  * Manages the defines for the PBR Material.
- * @hidden
+ * @internal
  */
 export declare class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
     PBR: boolean;
@@ -256,25 +256,25 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
     /**
      * Intensity of the direct lights e.g. the four lights available in your scene.
      * This impacts both the direct diffuse and specular highlights.
-     * @hidden
+     * @internal
      */
     _directIntensity: number;
     /**
      * Intensity of the emissive part of the material.
      * This helps controlling the emissive effect without modifying the emissive color.
-     * @hidden
+     * @internal
      */
     _emissiveIntensity: number;
     /**
      * Intensity of the environment e.g. how much the environment will light the object
      * either through harmonics for rough material or through the reflection for shiny ones.
-     * @hidden
+     * @internal
      */
     _environmentIntensity: number;
     /**
      * This is a special control allowing the reduction of the specular highlights coming from the
      * four lights of the scene. Those highlights may not be needed in full environment lighting.
-     * @hidden
+     * @internal
      */
     _specularIntensity: number;
     /**
@@ -283,66 +283,66 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
     private _lightingInfos;
     /**
      * Debug Control allowing disabling the bump map on this material.
-     * @hidden
+     * @internal
      */
     _disableBumpMap: boolean;
     /**
      * AKA Diffuse Texture in standard nomenclature.
-     * @hidden
+     * @internal
      */
     _albedoTexture: Nullable<BaseTexture>;
     /**
      * AKA Occlusion Texture in other nomenclature.
-     * @hidden
+     * @internal
      */
     _ambientTexture: Nullable<BaseTexture>;
     /**
      * AKA Occlusion Texture Intensity in other nomenclature.
-     * @hidden
+     * @internal
      */
     _ambientTextureStrength: number;
     /**
      * Defines how much the AO map is occluding the analytical lights (point spot...).
      * 1 means it completely occludes it
      * 0 mean it has no impact
-     * @hidden
+     * @internal
      */
     _ambientTextureImpactOnAnalyticalLights: number;
     /**
      * Stores the alpha values in a texture.
-     * @hidden
+     * @internal
      */
     _opacityTexture: Nullable<BaseTexture>;
     /**
      * Stores the reflection values in a texture.
-     * @hidden
+     * @internal
      */
     _reflectionTexture: Nullable<BaseTexture>;
     /**
      * Stores the emissive values in a texture.
-     * @hidden
+     * @internal
      */
     _emissiveTexture: Nullable<BaseTexture>;
     /**
      * AKA Specular texture in other nomenclature.
-     * @hidden
+     * @internal
      */
     _reflectivityTexture: Nullable<BaseTexture>;
     /**
      * Used to switch from specular/glossiness to metallic/roughness workflow.
-     * @hidden
+     * @internal
      */
     _metallicTexture: Nullable<BaseTexture>;
     /**
      * Specifies the metallic scalar of the metallic/roughness workflow.
      * Can also be used to scale the metalness values of the metallic texture.
-     * @hidden
+     * @internal
      */
     _metallic: Nullable<number>;
     /**
      * Specifies the roughness scalar of the metallic/roughness workflow.
      * Can also be used to scale the roughness values of the metallic texture.
-     * @hidden
+     * @internal
      */
     _roughness: Nullable<number>;
     /**
@@ -353,7 +353,7 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
      *
      * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
      * F90 = metallicReflectanceColor;
-     * @hidden
+     * @internal
      */
     _metallicF0Factor: number;
     /**
@@ -364,19 +364,19 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
      *
      * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
      * F90 = metallicReflectanceColor;
-     * @hidden
+     * @internal
      */
     _metallicReflectanceColor: Color3;
     /**
      * Specifies that only the A channel from _metallicReflectanceTexture should be used.
      * If false, both RGB and A channels will be used
-     * @hidden
+     * @internal
      */
     _useOnlyMetallicFromMetallicReflectanceTexture: boolean;
     /**
      * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
      * This is multiply against the scalar values defined in the material.
-     * @hidden
+     * @internal
      */
     _metallicReflectanceTexture: Nullable<BaseTexture>;
     /**
@@ -384,208 +384,208 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
      * This is multiplied against the scalar values defined in the material.
      * If both _reflectanceTexture and _metallicReflectanceTexture textures are provided and _useOnlyMetallicFromMetallicReflectanceTexture
      * is false, _metallicReflectanceTexture takes precedence and _reflectanceTexture is not used
-     * @hidden
+     * @internal
      */
     _reflectanceTexture: Nullable<BaseTexture>;
     /**
      * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
      * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
-     * @hidden
+     * @internal
      */
     _microSurfaceTexture: Nullable<BaseTexture>;
     /**
      * Stores surface normal data used to displace a mesh in a texture.
-     * @hidden
+     * @internal
      */
     _bumpTexture: Nullable<BaseTexture>;
     /**
      * Stores the pre-calculated light information of a mesh in a texture.
-     * @hidden
+     * @internal
      */
     _lightmapTexture: Nullable<BaseTexture>;
     /**
      * The color of a material in ambient lighting.
-     * @hidden
+     * @internal
      */
     _ambientColor: Color3;
     /**
      * AKA Diffuse Color in other nomenclature.
-     * @hidden
+     * @internal
      */
     _albedoColor: Color3;
     /**
      * AKA Specular Color in other nomenclature.
-     * @hidden
+     * @internal
      */
     _reflectivityColor: Color3;
     /**
      * The color applied when light is reflected from a material.
-     * @hidden
+     * @internal
      */
     _reflectionColor: Color3;
     /**
      * The color applied when light is emitted from a material.
-     * @hidden
+     * @internal
      */
     _emissiveColor: Color3;
     /**
      * AKA Glossiness in other nomenclature.
-     * @hidden
+     * @internal
      */
     _microSurface: number;
     /**
      * Specifies that the material will use the light map as a show map.
-     * @hidden
+     * @internal
      */
     _useLightmapAsShadowmap: boolean;
     /**
      * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
      * makes the reflect vector face the model (under horizon).
-     * @hidden
+     * @internal
      */
     _useHorizonOcclusion: boolean;
     /**
      * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
      * too much the area relying on ambient texture to define their ambient occlusion.
-     * @hidden
+     * @internal
      */
     _useRadianceOcclusion: boolean;
     /**
      * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
-     * @hidden
+     * @internal
      */
     _useAlphaFromAlbedoTexture: boolean;
     /**
      * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
      * A car glass is a good example of that. When sun reflects on it you can not see what is behind.
-     * @hidden
+     * @internal
      */
     _useSpecularOverAlpha: boolean;
     /**
      * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
-     * @hidden
+     * @internal
      */
     _useMicroSurfaceFromReflectivityMapAlpha: boolean;
     /**
      * Specifies if the metallic texture contains the roughness information in its alpha channel.
-     * @hidden
+     * @internal
      */
     _useRoughnessFromMetallicTextureAlpha: boolean;
     /**
      * Specifies if the metallic texture contains the roughness information in its green channel.
-     * @hidden
+     * @internal
      */
     _useRoughnessFromMetallicTextureGreen: boolean;
     /**
      * Specifies if the metallic texture contains the metallness information in its blue channel.
-     * @hidden
+     * @internal
      */
     _useMetallnessFromMetallicTextureBlue: boolean;
     /**
      * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
-     * @hidden
+     * @internal
      */
     _useAmbientOcclusionFromMetallicTextureRed: boolean;
     /**
      * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
-     * @hidden
+     * @internal
      */
     _useAmbientInGrayScale: boolean;
     /**
      * In case the reflectivity map does not contain the microsurface information in its alpha channel,
      * The material will try to infer what glossiness each pixel should be.
-     * @hidden
+     * @internal
      */
     _useAutoMicroSurfaceFromReflectivityMap: boolean;
     /**
      * Defines the  falloff type used in this material.
      * It by default is Physical.
-     * @hidden
+     * @internal
      */
     _lightFalloff: number;
     /**
      * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
      * A car glass is a good example of that. When the street lights reflects on it you can not see what is behind.
-     * @hidden
+     * @internal
      */
     _useRadianceOverAlpha: boolean;
     /**
      * Allows using an object space normal map (instead of tangent space).
-     * @hidden
+     * @internal
      */
     _useObjectSpaceNormalMap: boolean;
     /**
      * Allows using the bump map in parallax mode.
-     * @hidden
+     * @internal
      */
     _useParallax: boolean;
     /**
      * Allows using the bump map in parallax occlusion mode.
-     * @hidden
+     * @internal
      */
     _useParallaxOcclusion: boolean;
     /**
      * Controls the scale bias of the parallax mode.
-     * @hidden
+     * @internal
      */
     _parallaxScaleBias: number;
     /**
      * If sets to true, disables all the lights affecting the material.
-     * @hidden
+     * @internal
      */
     _disableLighting: boolean;
     /**
      * Number of Simultaneous lights allowed on the material.
-     * @hidden
+     * @internal
      */
     _maxSimultaneousLights: number;
     /**
      * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
-     * @hidden
+     * @internal
      */
     _invertNormalMapX: boolean;
     /**
      * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
-     * @hidden
+     * @internal
      */
     _invertNormalMapY: boolean;
     /**
      * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
-     * @hidden
+     * @internal
      */
     _twoSidedLighting: boolean;
     /**
      * Defines the alpha limits in alpha test mode.
-     * @hidden
+     * @internal
      */
     _alphaCutOff: number;
     /**
      * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
-     * @hidden
+     * @internal
      */
     _forceAlphaTest: boolean;
     /**
      * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
      * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
-     * @hidden
+     * @internal
      */
     _useAlphaFresnel: boolean;
     /**
      * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
      * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
-     * @hidden
+     * @internal
      */
     _useLinearAlphaFresnel: boolean;
     /**
      * Specifies the environment BRDF texture used to compute the scale and offset roughness values
      * from cos theta and roughness:
      * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
-     * @hidden
+     * @internal
      */
     _environmentBRDFTexture: Nullable<BaseTexture>;
     /**
      * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
-     * @hidden
+     * @internal
      */
     _forceIrradianceInFragment: boolean;
     private _realTimeFiltering;
@@ -606,14 +606,14 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
     get canRenderToMRT(): boolean;
     /**
      * Force normal to face away from face.
-     * @hidden
+     * @internal
      */
     _forceNormalForward: boolean;
     /**
      * Enables specular anti aliasing in the PBR shader.
      * It will both interacts on the Geometry for analytical and IBL lighting.
      * It also prefilter the roughness map based on the bump values.
-     * @hidden
+     * @internal
      */
     _enableSpecularAntiAliasing: boolean;
     /**
@@ -647,14 +647,14 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
     private _unlit;
     private _debugMode;
     /**
-     * @hidden
+     * @internal
      * This is reserved for the inspector.
      * Defines the material debug mode.
      * It helps seeing only some components of the material while troubleshooting.
      */
     debugMode: number;
     /**
-     * @hidden
+     * @internal
      * This is reserved for the inspector.
      * Specify from where on screen the debug mode should start.
      * The value goes from -1 (full screen) to 1 (not visible)
@@ -663,7 +663,7 @@ export declare abstract class PBRBaseMaterial extends PushMaterial {
      */
     private _debugLimit;
     /**
-     * @hidden
+     * @internal
      * This is reserved for the inspector.
      * As the default viewing range might not be enough (if the ambient is really small for instance)
      * You can use the factor to better multiply the final value.