Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grid Script fixes #7295

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Grid Script fixes #7295

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f5df46d
Refactor grid shader code
marklundin Jan 17, 2025
06529ea
Remove unused CULLFACE_NONE constant and disable shadow casting for G…
marklundin Jan 20, 2025
f493acc
Set depthWrite to false for grid material
marklundin Jan 20, 2025
c76b3de
Remove unused uniforms and functions in grid shader
marklundin Jan 20, 2025
6a41063
Merge branch 'main' into fix-grid-update
marklundin Jan 20, 2025
112007d
Merge branch 'main' into fix-grid-update
marklundin Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 46 additions & 88 deletions scripts/esm/grid.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,37 @@ import {
SEMANTIC_POSITION,
SEMANTIC_TEXCOORD0,
BLEND_NORMAL,
CULLFACE_NONE,
PlaneGeometry,
Mesh,
MeshInstance,
Color,
Script,
Vec2
Script
} from 'playcanvas';

/** @import { AppBase, Entity } from 'playcanvas' */

const tmpVa = new Vec2();

const EPISILON = 1e-3;

const vertexCode = /* glsl */ `
attribute vec3 vertex_position;
attribute vec2 aUv0;

uniform mat4 matrix_model;
uniform mat4 matrix_viewProjection;

varying vec2 uv0;
varying vec3 vPosition;

void main(void) {
gl_Position = matrix_viewProjection * matrix_model * vec4(vertex_position, 1.0);
uv0 = aUv0;
vec4 worldPosition = matrix_model * vec4(vertex_position, 1.0);
vPosition = worldPosition.xyz;
gl_Position = matrix_viewProjection * worldPosition;
}
`;

const fragmentCode = /* glsl */ `
uniform vec2 uHalfExtents;
uniform vec3 uColorX;
uniform vec3 uColorZ;
uniform int uResolution;
uniform sampler2D blueNoiseTex32;

varying vec2 uv0;
uniform vec3 view_position;
uniform mat4 matrix_viewProjection;

varying vec3 vPosition;

// https://bgolus.medium.com/the-best-darn-grid-shader-yet-727f9278b9d8#1e7c
float pristineGrid(in vec2 uv, in vec2 ddx, in vec2 ddy, vec2 lineWidth) {
Expand All @@ -64,58 +58,77 @@ const fragmentCode = /* glsl */ `
return mix(grid2.x, 1.0, grid2.y);
}

void main(void) {
vec2 uv = uv0;
float calcDepth(vec3 p) {
vec4 v = matrix_viewProjection * vec4(p, 1.0);
return (v.z / v.w) * 0.5 + 0.5;
}

vec2 pos = (uv * 2.0 - 1.0) * uHalfExtents;
vec2 ddx = dFdx(pos);
vec2 ddy = dFdy(pos);
bool writeDepth(float alpha) {
vec2 uv = fract(gl_FragCoord.xy / 32.0);
float noise = texture2DLod(blueNoiseTex32, uv, 0.0).y;
return alpha > noise;
}

void main(void) {
vec3 pos = vPosition;
vec2 ddx = dFdx(pos.xz);
vec2 ddy = dFdy(pos.xz);

float epsilon = 1.0 / 255.0;

vec2 levelPos;
// calculate fade
float fade = 1.0 - smoothstep(400.0, 1000.0, length(pos - view_position));
if (fade < epsilon) {
discard;
}

vec3 levelPos;
float levelSize;
float levelAlpha;

levelPos = pos * 0.1;
levelSize = 2.0 / 1000.0;
levelAlpha = pristineGrid(levelPos, ddx * 0.1, ddy * 0.1, vec2(levelSize));
levelAlpha = pristineGrid(levelPos.xz, ddx * 0.1, ddy * 0.1, vec2(levelSize)) * fade;
if (levelAlpha > epsilon) {
vec3 color;
if (abs(levelPos.x) < levelSize) {
if (abs(levelPos.y) < levelSize) {
vec2 loc = max(vec2(0.0), abs(levelPos.xz) - abs(ddx * 0.1) - abs(ddy * 0.1));
if (loc.x < levelSize) {
if (loc.y < levelSize) {
color = vec3(1.0);
} else {
color = uColorZ;
}
} else if (abs(levelPos.y) < levelSize) {
} else if (loc.y < levelSize) {
color = uColorX;
} else {
color = vec3(0.9);
}
gl_FragColor = vec4(color, levelAlpha);
gl_FragDepth = writeDepth(levelAlpha) ? calcDepth(pos) : 1.0;
return;
}

levelPos = pos;
levelSize = 1.0 / 100.0;
levelAlpha = pristineGrid(levelPos, ddx, ddy, vec2(levelSize));
levelAlpha = pristineGrid(levelPos.xz, ddx, ddy, vec2(levelSize)) * fade;
if (levelAlpha > epsilon) {
if (uResolution < 1) {
discard;
}
gl_FragColor = vec4(vec3(0.7), levelAlpha);
gl_FragDepth = writeDepth(levelAlpha) ? calcDepth(pos) : 1.0;
return;
}

levelPos = pos * 10.0;
levelSize = 1.0 / 100.0;
levelAlpha = pristineGrid(levelPos, ddx * 10.0, ddy * 10.0, vec2(levelSize));
levelAlpha = pristineGrid(levelPos.xz, ddx * 10.0, ddy * 10.0, vec2(levelSize)) * fade;
if (levelAlpha > epsilon) {
if (uResolution < 2) {
discard;
}
gl_FragColor = vec4(vec3(0.7), levelAlpha);
gl_FragDepth = writeDepth(levelAlpha) ? calcDepth(pos) : 1.0;
return;
}

Expand Down Expand Up @@ -145,18 +158,6 @@ class Grid extends Script {
*/
_material;

/**
* @type {MeshInstance}
* @private
*/
_meshInstance;

/**
* @type {Vec2}
* @private
*/
_halfExtents = new Vec2();

/**
* @type {Color}
* @private
Expand All @@ -176,10 +177,9 @@ class Grid extends Script {
_resolution = Grid.RESOLUTION_HIGH;

initialize() {

// ensure the entity has a render component
if (!this.entity.render) {
this.entity.addComponent('render');
this.entity.addComponent('render', { type: 'plane' });
}

// create shader material
Expand All @@ -193,55 +193,21 @@ class Grid extends Script {
}
});
this._material.blendType = BLEND_NORMAL;
this._material.cull = CULLFACE_NONE;
this._material.depthWrite = false;
this._material.update();

// create mesh
const mesh = Mesh.fromGeometry(this.app.graphicsDevice, new PlaneGeometry());
this._meshInstance = new MeshInstance(mesh, this._material);
this.entity.render.meshInstances = [this._meshInstance];
this.entity.render.material = this._material;
this.entity.render.castShadows = false;

// set the initial values
this.colorX = this._colorX;
this.colorZ = this._colorZ;
this.resolution = this._resolution;

// calculate half extents
this._set('uHalfExtents', this._calcHalfExtents(tmpVa));

// update the half extents when the entity scale changes
this.app.on('prerender', () => {
if (!this.enabled) {
return;
}
const halfExtents = this._calcHalfExtents(tmpVa);
if (this._halfExtents.distance(halfExtents) > EPISILON) {
this._set('uHalfExtents', halfExtents);
}
});

// enable/disable the mesh instance
this.on('enable', () => {
this.entity.render.meshInstances = [this._meshInstance];
});
this.on('disable', () => {
this.entity.render.meshInstances = [];
});
}

/**
* @param {Vec2} vec - The vector to copy the half extents to.
* @returns {Vec2} - The half extents.
* @private
*/
_calcHalfExtents(vec) {
const scale = this.entity.getLocalScale();
return vec.set(scale.x / 2, scale.z / 2);
}

/**
* @param {string} name - The name of the parameter.
* @param {Color|Vec2|number} value - The value of the parameter.
* @param {Color|number} value - The value of the parameter.
* @private
*/
_set(name, value) {
Expand All @@ -254,17 +220,9 @@ class Grid extends Script {
this._material.setParameter(name, [value.r, value.g, value.b]);
}

if (value instanceof Vec2) {
this._material.setParameter(name, [value.x, value.y]);
}

if (typeof value === 'number') {
this._material.setParameter(name, value);
}

this._material.update();
marklundin marked this conversation as resolved.
Show resolved Hide resolved

this._meshInstance.material = this._material;
}

/**
Expand Down
Loading