babylonjs-materials 9.10.0 → 9.10.1

package/babylonjs.materials.module.d.ts

@@ -1077,6 +1077,7 @@ export * from "babylonjs-materials/grid/gridMaterial";
 declare module "babylonjs-materials/grid/gridMaterial" {
 import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
 import { Color3 } from "babylonjs/Maths/math.color";
+import { Nullable } from "babylonjs/types";
 import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
 import { PushMaterial } from "babylonjs/Materials/pushMaterial";
 import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
@@ -1113,13 +1114,53 @@ export class GridMaterial extends PushMaterial {
      */
     minorUnitVisibility: number;
     /**
-     * The grid opacity outside of the lines.
+     * Overall mesh opacity. In linesOnly mode this also scales the maximum line alpha.
      */
     opacity: number;
     /**
      * Whether to antialias the grid
      */
     antialias: boolean;
+    /**
+     * Color of grid lines when the camera is below the surface.
+     * When set, lineColor acts as the above-surface color.
+     */
+    get belowLineColor(): Nullable<Color3>;
+    set belowLineColor(value: Nullable<Color3>);
+    private _belowLineColor;
+    /**
+     * Enable multi-scale logarithmic grid LOD. Number of octaves is controlled by gridOctaves.
+     */
+    useMultiScale: boolean;
+    /**
+     * World-unit spacing of the finest octave. Default 0.001.
+     */
+    minGridSpacing: number;
+    /**
+     * Number of logarithmic octaves rendered (1–8). Default 4.
+     */
+    gridOctaves: number;
+    /**
+     * Enable camera-distance-aware horizon (grazing-angle) fade.
+     */
+    useHorizonFade: boolean;
+    /**
+     * Render an ultra-fine crosshair at the world origin.
+     */
+    useOriginMarker: boolean;
+    /**
+     * When true, only grid lines are visible — non-grid pixels are discarded.
+     * Puts the material in the alpha-blend queue and enables a depth pre-pass so grid lines
+     * correctly occlude translucent objects (e.g. Gaussian splats). Set mesh.alphaIndex to a
+     * value lower than other transparent objects so the depth pre-pass fires first.
+     */
+    get linesOnly(): boolean;
+    set linesOnly(value: boolean);
+    private _linesOnly;
+    /**
+     * Scales grid line width. Values \> 1 produce thicker lines. Default 1.0.
+     */
+    gridThicknessModifier: number;
     /**
      * Determine RBG output is premultiplied by alpha value.
      */
@@ -1134,6 +1175,7 @@ export class GridMaterial extends PushMaterial {
      */
     opacityTexture: BaseTexture;
     private _gridControl;
+    private _viewportSize;
     /**
      * constructor
      * @param name The name given to the material in order to identify it afterwards.
@@ -1157,6 +1199,13 @@ export class GridMaterial extends PushMaterial {
     clone(name: string): GridMaterial;
     serialize(): any;
     getClassName(): string;
+    /**
+     * Parse a JSON input to create back a grid material.
+     * @param source the JSON data to parse
+     * @param scene defines the hosting scene
+     * @param rootUrl defines the root URL to use to load textures and relative dependencies
+     * @returns a new grid material
+     */
     static Parse(source: any, scene: Scene, rootUrl: string): GridMaterial;
 }
 
@@ -3038,13 +3087,53 @@ declare namespace BABYLON {
          */
         minorUnitVisibility: number;
         /**
-         * The grid opacity outside of the lines.
+         * Overall mesh opacity. In linesOnly mode this also scales the maximum line alpha.
          */
         opacity: number;
         /**
          * Whether to antialias the grid
          */
         antialias: boolean;
+        /**
+         * Color of grid lines when the camera is below the surface.
+         * When set, lineColor acts as the above-surface color.
+         */
+        get belowLineColor(): Nullable<Color3>;
+        set belowLineColor(value: Nullable<Color3>);
+        private _belowLineColor;
+        /**
+         * Enable multi-scale logarithmic grid LOD. Number of octaves is controlled by gridOctaves.
+         */
+        useMultiScale: boolean;
+        /**
+         * World-unit spacing of the finest octave. Default 0.001.
+         */
+        minGridSpacing: number;
+        /**
+         * Number of logarithmic octaves rendered (1–8). Default 4.
+         */
+        gridOctaves: number;
+        /**
+         * Enable camera-distance-aware horizon (grazing-angle) fade.
+         */
+        useHorizonFade: boolean;
+        /**
+         * Render an ultra-fine crosshair at the world origin.
+         */
+        useOriginMarker: boolean;
+        /**
+         * When true, only grid lines are visible — non-grid pixels are discarded.
+         * Puts the material in the alpha-blend queue and enables a depth pre-pass so grid lines
+         * correctly occlude translucent objects (e.g. Gaussian splats). Set mesh.alphaIndex to a
+         * value lower than other transparent objects so the depth pre-pass fires first.
+         */
+        get linesOnly(): boolean;
+        set linesOnly(value: boolean);
+        private _linesOnly;
+        /**
+         * Scales grid line width. Values \> 1 produce thicker lines. Default 1.0.
+         */
+        gridThicknessModifier: number;
         /**
          * Determine RBG output is premultiplied by alpha value.
          */
@@ -3059,6 +3148,7 @@ declare namespace BABYLON {
          */
         opacityTexture: BaseTexture;
         private _gridControl;
+        private _viewportSize;
         /**
          * constructor
          * @param name The name given to the material in order to identify it afterwards.
@@ -3082,6 +3172,13 @@ declare namespace BABYLON {
         clone(name: string): GridMaterial;
         serialize(): any;
         getClassName(): string;
+        /**
+         * Parse a JSON input to create back a grid material.
+         * @param source the JSON data to parse
+         * @param scene defines the hosting scene
+         * @param rootUrl defines the root URL to use to load textures and relative dependencies
+         * @returns a new grid material
+         */
         static Parse(source: any, scene: Scene, rootUrl: string): GridMaterial;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-materials",
-    "version": "9.10.0",
+    "version": "9.10.1",
     "main": "babylonjs.materials.min.js",
     "types": "babylonjs.materials.module.d.ts",
     "files": [
@@ -16,7 +16,7 @@
         "test:escheck": "es-check es6 ./babylonjs.materials.js"
     },
     "dependencies": {
-        "babylonjs": "9.10.0"
+        "babylonjs": "9.10.1"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",