Skip to content

Commit 11afde2

Browse files
FlayaNFlayaN
authored
refactor: rename Constants to Math with namespace (#689)
1 parent 65ce7ea commit 11afde2

32 files changed

+120
-108
lines changed

‎features/Dynamic Cubemaps/Shaders/DynamicCubemaps/SpecularIrradianceCS.hlsl

+4-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55
// Part of specular IBL split-sum approximation.
66

77
#include "Common/Color.hlsli"
8+
#include "Common/Math.hlsli"
89

9-
static const float PI = 3.141592;
10-
static const float TwoPI = 2 * PI;
1110
static const float Epsilon = 0.00001;
1211

1312
static const uint NumSamples = 16;
@@ -50,7 +49,7 @@ float3 sampleGGX(float u1, float u2, float roughness)
5049

5150
float cosTheta = sqrt((1.0 - u2) / (1.0 + (alpha * alpha - 1.0) * u2));
5251
float sinTheta = sqrt(1.0 - cosTheta * cosTheta); // Trig. identity
53-
float phi = TwoPI * u1;
52+
float phi = Math::TAU * u1;
5453

5554
// Convert to Cartesian upon return.
5655
return float3(sinTheta * cos(phi), sinTheta * sin(phi), cosTheta);
@@ -64,7 +63,7 @@ float ndfGGX(float cosLh, float roughness)
6463
float alphaSq = alpha * alpha;
6564

6665
float denom = (cosLh * cosLh) * (alphaSq - 1.0) + 1.0;
67-
return alphaSq / (PI * denom * denom);
66+
return alphaSq / (Math::PI * denom * denom);
6867
}
6968

7069
// Calculate normalized sampling direction vector based on current fragment coordinates.
@@ -135,7 +134,7 @@ float3 tangentToWorld(const float3 v, const float3 N, const float3 S, const floa
135134

136135
// Solid angle associated with a single cubemap texel at zero mipmap level.
137136
// This will come in handy for importance sampling below.
138-
float wt = 4.0 * PI / (6 * inputWidth * inputHeight);
137+
float wt = 4.0 * Math::PI / (6 * inputWidth * inputHeight);
139138

140139
// Approximation: Assume zero viewing angle (isotropic reflections).
141140
float3 N = getSamplingVector(ThreadID);

‎features/Dynamic Cubemaps/Shaders/DynamicCubemaps/UpdateCubemapCS.hlsl

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#include "Common/Color.hlsli"
2-
#include "Common/Constants.hlsli"
32
#include "Common/FrameBuffer.hlsli"
43
#include "Common/SharedData.hlsli"
54
#include "Common/VR.hlsli"

‎features/Screen Space GI/Shaders/ScreenSpaceGI/blur.cs.hlsl

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#include "Common/FastMath.hlsli"
55
#include "Common/FrameBuffer.hlsli"
66
#include "Common/GBuffer.hlsli"
7+
#include "Common/Math.hlsli"
78
#include "Common/VR.hlsli"
89
#include "ScreenSpaceGI/common.hlsli"
910

@@ -102,7 +103,7 @@ float2x3 getKernelBasis(float3 D, float3 N, float roughness = 1.0, float anisoFa
102103
float halfAngle = specularLobeHalfAngle(roughness);
103104
#else
104105
float2x3 TvBv = getKernelBasis(normal, normal); // D = N
105-
float halfAngle = FastMath::fsl_HALF_PI * .5f;
106+
float halfAngle = Math::HALF_PI * .5f;
106107
#endif
107108
TvBv[0] *= worldRadius;
108109
TvBv[1] *= worldRadius;

‎features/Screen Space GI/Shaders/ScreenSpaceGI/common.hlsli

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
///////////////////////////////////////////////////////////////////////////////
2222

23+
#include "Common/Math.hlsli"
2324
#include "Common/SharedData.hlsli"
2425

2526
cbuffer SSGICB : register(b1)
@@ -166,7 +167,7 @@ float3x3 RotFromToMatrix(float3 from, float3 to)
166167
float specularLobeHalfAngle(float roughness)
167168
{
168169
float roughness2 = roughness * roughness;
169-
return clamp(4.1679 * roughness2 * roughness2 - 9.0127 * roughness2 * roughness + 4.6161 * roughness2 + 1.7048 * roughness + 0.1, 0, 1.57079632679);
170+
return clamp(4.1679 * roughness2 * roughness2 - 9.0127 * roughness2 * roughness + 4.6161 * roughness2 + 1.7048 * roughness + 0.1, 0, Math::HALF_PI);
170171
}
171172

172173
// https://www.gdcvault.com/play/1026701/Fast-Denoising-With-Self-Stabilizing

‎features/Screen Space GI/Shaders/ScreenSpaceGI/gi.cs.hlsl

+3-4
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,10 @@
2525
#include "Common/FastMath.hlsli"
2626
#include "Common/FrameBuffer.hlsli"
2727
#include "Common/GBuffer.hlsli"
28+
#include "Common/Math.hlsli"
2829
#include "Common/VR.hlsli"
2930
#include "ScreenSpaceGI/common.hlsli"
3031

31-
#define PI (3.1415926535897932384626433832795)
32-
#define HALF_PI (1.5707963267948966192313216916398)
3332
#define RCP_PI (0.31830988618)
3433

3534
Texture2D<float> srcWorkingDepth : register(t0);
@@ -65,7 +64,7 @@ float GetNormalDistributionFunctionGGX(float roughness, float NdotH)
6564
float a = roughness * roughness;
6665
float a2 = a * a;
6766
float d = max((NdotH * a2 - NdotH) * NdotH + 1, 1e-5);
68-
return a2 / (PI * d * d);
67+
return a2 / (Math::PI * d * d);
6968
}
7069

7170
// [Heitz 2014, "Understanding the Masking-Shadowing Function in Microfacet-Based BRDFs"]
@@ -123,7 +122,7 @@ void CalculateGI(
123122
#endif
124123

125124
for (uint slice = 0; slice < NumSlices; slice++) {
126-
float phi = (PI * rcpNumSlices) * (slice + noiseSlice);
125+
float phi = (Math::PI * rcpNumSlices) * (slice + noiseSlice);
127126
float3 directionVec = 0;
128127
sincos(phi, directionVec.y, directionVec.x);
129128

‎features/Screen-Space Shadows/Shaders/ScreenSpaceShadows/ScreenSpaceShadows.hlsli

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#include "Common/Math.hlsli"
2+
13
Texture2D<unorm half> ScreenSpaceShadowsTexture : register(t17);
24

35
namespace ScreenSpaceShadows
@@ -12,7 +14,7 @@ namespace ScreenSpaceShadows
1214

1315
float GetScreenSpaceShadow(float3 screenPosition, float2 uv, float noise, float3 viewPosition, uint eyeIndex)
1416
{
15-
noise *= 2.0 * M_PI;
17+
noise *= Math::TAU;
1618

1719
half2x2 rotationMatrix = half2x2(cos(noise), sin(noise), -sin(noise), cos(noise));
1820

‎features/Skylighting/Shaders/Skylighting/Skylighting.hlsli

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#include "Common/Math.hlsli"
12
#include "Common/Random.hlsli"
23
#include "Common/SharedData.hlsli"
34
#include "Common/Spherical Harmonics/SphericalHarmonics.hlsli"
@@ -32,7 +33,7 @@ namespace Skylighting
3233

3334
sh2 sample(SkylightingSettings params, Texture3D<sh2> probeArray, float3 positionMS, float3 normalWS)
3435
{
35-
const static sh2 unitSH = float4(sqrt(4 * shPI), 0, 0, 0);
36+
const static sh2 unitSH = float4(sqrt(4 * Math::PI), 0, 0, 0);
3637
sh2 scaledUnitSH = unitSH / 1e-10;
3738

3839
float3 positionMSAdjusted = positionMS - params.PosOffset.xyz;
@@ -120,10 +121,10 @@ namespace Skylighting
120121
// lobe half angle
121122
// credit: Olivier Therrien
122123
float roughness2 = roughness * roughness;
123-
float halfAngle = clamp(4.1679 * roughness2 * roughness2 - 9.0127 * roughness2 * roughness + 4.6161 * roughness2 + 1.7048 * roughness + 0.1, 0, 1.57079632679);
124-
float lerpFactor = halfAngle / 1.57079632679;
124+
float halfAngle = clamp(4.1679 * roughness2 * roughness2 - 9.0127 * roughness2 * roughness + 4.6161 * roughness2 + 1.7048 * roughness + 0.1, 0, Math::HALF_PI);
125+
float lerpFactor = halfAngle / Math::HALF_PI;
125126
sh2 directional = shEvaluate(dominantDir);
126-
sh2 cosineLobe = shEvaluateCosineLobe(dominantDir) / shPI;
127+
sh2 cosineLobe = shEvaluateCosineLobe(dominantDir) / Math::PI;
127128
sh2 result = shAdd(shScale(directional, lerpFactor), shScale(cosineLobe, 1 - lerpFactor));
128129

129130
return result;

‎features/Skylighting/Shaders/Skylighting/UpdateProbesCS.hlsl

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#include "Common/Math.hlsli"
12
#include "Skylighting/Skylighting.hlsli"
23

34
Texture2D<unorm float> srcOcclusionDepth : register(t0);
@@ -13,7 +14,7 @@ SamplerState samplerPointClamp : register(s0);
1314
[numthreads(8, 8, 1)] void main(uint3 dtid
1415
: SV_DispatchThreadID) {
1516
const float fadeInThreshold = 255;
16-
const static sh2 unitSH = float4(sqrt(4.0 * shPI), 0, 0, 0);
17+
const static sh2 unitSH = float4(sqrt(4.0 * Math::PI), 0, 0, 0);
1718
const SkylightingSettings settings = skylightingSettings;
1819

1920
uint3 cellID = (int3(dtid) - settings.ArrayOrigin.xyz) % ARRAY_DIM;
@@ -32,7 +33,7 @@ SamplerState samplerPointClamp : register(s0);
3233
float occlusionDepth = srcOcclusionDepth.SampleLevel(samplerPointClamp, occlusionUV, 0);
3334
float visibility = saturate((occlusionDepth + 0.0005 - cellCentreOS.z) * 1024);
3435

35-
sh2 occlusionSH = shScale(shEvaluate(settings.OcclusionDir.xyz), visibility * 4.0 * shPI); // 4 pi from monte carlo
36+
sh2 occlusionSH = shScale(shEvaluate(settings.OcclusionDir.xyz), visibility * 4.0 * Math::PI); // 4 pi from monte carlo
3637
if (isValid) {
3738
float lerpFactor = rcp(accumFrames);
3839
sh2 prevProbeSH = unitSH;

‎features/Subsurface Scattering/Shaders/SubsurfaceScattering/SeparableSSS.hlsli

+3-1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@
8989

9090
//-----------------------------------------------------------------------------
9191

92+
#include "Common/Math.hlsli"
93+
9294
float4 SSSSBlurCS(
9395
uint2 DTid,
9496
float2 texcoord,
@@ -138,7 +140,7 @@ float4 SSSSBlurCS(
138140
uint2 maxCoord = uint2(BufferDim.x, BufferDim.y);
139141
#endif
140142

141-
float jitter = Random::InterleavedGradientNoise(DTid.xy, FrameCount) * M_2PI;
143+
float jitter = Random::InterleavedGradientNoise(DTid.xy, FrameCount) * Math::TAU;
142144
float2x2 rotationMatrix = float2x2((jitter), sin(jitter), -sin(jitter), cos(jitter));
143145
float2x2 identityMatrix = float2x2(1.0, 0.0, 0.0, 1.0);
144146

‎features/Subsurface Scattering/Shaders/SubsurfaceScattering/SeparableSSSCS.hlsl

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ cbuffer PerFrameSSS : register(b1)
1515
};
1616

1717
#include "Common/Color.hlsli"
18-
#include "Common/Constants.hlsli"
1918
#include "Common/Random.hlsli"
2019
#include "Common/SharedData.hlsli"
2120

‎features/Wetness Effects/Shaders/WetnessEffects/optimized-ggx.hlsli

+6-8
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ OTHER DEALINGS IN THE SOFTWARE.
3232
For more information, please refer to <http://unlicense.org/>
3333
*/
3434

35+
#include "Common/Math.hlsli"
36+
3537
float G1V(float dotNV, float k)
3638
{
3739
return 1.0f / (dotNV * (1.0f - k) + k);
@@ -52,9 +54,8 @@ float LightingFuncGGX_REF(float3 N, float3 V, float3 L, float roughness, float F
5254

5355
// D
5456
float alphaSqr = alpha * alpha;
55-
float pi = 3.14159f;
5657
float denom = dotNH * dotNH * (alphaSqr - 1.0) + 1.0f;
57-
D = alphaSqr / (pi * denom * denom);
58+
D = alphaSqr / (Math::PI * denom * denom);
5859

5960
// F
6061
float dotLH5 = pow(1.0f - dotLH, 5);
@@ -82,9 +83,8 @@ float LightingFuncGGX_OPT1(float3 N, float3 V, float3 L, float roughness, float
8283

8384
// D
8485
float alphaSqr = alpha * alpha;
85-
float pi = 3.14159f;
8686
float denom = dotNH * dotNH * (alphaSqr - 1.0) + 1.0f;
87-
D = alphaSqr / (pi * denom * denom);
87+
D = alphaSqr / (Math::PI * denom * denom);
8888

8989
// F
9090
float dotLH5 = pow(1.0f - dotLH, 5);
@@ -113,9 +113,8 @@ float LightingFuncGGX_OPT2(float3 N, float3 V, float3 L, float roughness, float
113113

114114
// D
115115
float alphaSqr = alpha * alpha;
116-
float pi = 3.14159f;
117116
float denom = dotNH * dotNH * (alphaSqr - 1.0) + 1.0f;
118-
D = alphaSqr / (pi * denom * denom);
117+
D = alphaSqr / (Math::PI * denom * denom);
119118

120119
// F
121120
float dotLH5 = pow(1.0f - dotLH, 5);
@@ -155,10 +154,9 @@ float LightingFuncGGX_D(float dotNH, float roughness)
155154
{
156155
float alpha = roughness * roughness;
157156
float alphaSqr = alpha * alpha;
158-
float pi = 3.14159f;
159157
float denom = dotNH * dotNH * (alphaSqr - 1.0) + 1.0f;
160158

161-
float D = alphaSqr / (pi * denom * denom);
159+
float D = alphaSqr / (Math::PI * denom * denom);
162160
return D;
163161
}
164162

‎package/Shaders/AmbientCompositeCS.hlsl

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#include "Common/Color.hlsli"
22
#include "Common/FrameBuffer.hlsli"
33
#include "Common/GBuffer.hlsli"
4+
#include "Common/Math.hlsli"
45
#include "Common/SharedData.hlsli"
56
#include "Common/VR.hlsli"
67

@@ -61,7 +62,7 @@ RWTexture2D<half3> DiffuseAmbientRW : register(u1);
6162
# endif
6263

6364
sh2 skylighting = Skylighting::sample(skylightingSettings, SkylightingProbeArray, positionMS.xyz, normalWS);
64-
half skylightingDiffuse = shFuncProductIntegral(skylighting, shEvaluateCosineLobe(float3(normalWS.xy, normalWS.z * 0.5 + 0.5))) / shPI;
65+
half skylightingDiffuse = shFuncProductIntegral(skylighting, shEvaluateCosineLobe(float3(normalWS.xy, normalWS.z * 0.5 + 0.5))) / Math::PI;
6566
skylightingDiffuse = Skylighting::mixDiffuse(skylightingSettings, skylightingDiffuse);
6667

6768
visibility = skylightingDiffuse;

‎package/Shaders/Common/Color.hlsli

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
#ifndef __COLOR_DEPENDENCY_HLSL__
22
#define __COLOR_DEPENDENCY_HLSL__
33

4+
#include "Common/Math.hlsli"
5+
46
namespace Color
57
{
68
static float GammaCorrectionValue = 2.2;
@@ -20,8 +22,8 @@ namespace Color
2022
return dot(color, float3(0.299, 0.587, 0.114));
2123
}
2224

23-
const static float AlbedoPreMult = 1 / 1.7; // greater value -> brighter pbr
24-
const static float LightPreMult = 1 / (3.1415926 * AlbedoPreMult); // ensure 1/PI as product
25+
const static float AlbedoPreMult = 1 / 1.7; // greater value -> brighter pbr
26+
const static float LightPreMult = 1 / (Math::PI * AlbedoPreMult); // ensure 1/PI as product
2527

2628
float3 GammaToLinear(float3 color)
2729
{

‎package/Shaders/Common/Constants.hlsli

-14
This file was deleted.

‎package/Shaders/Common/FastMath.hlsli

+8-8
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@
4444
#ifndef SHADER_FAST_MATH_INC_FX
4545
#define SHADER_FAST_MATH_INC_FX
4646

47+
#include "Common/Math.hlsli"
48+
4749
// Define switch for PC compilation
4850
#ifdef _PC
4951
# define asint(_x) *reinterpret_cast<int*>(&_x);
@@ -249,8 +251,6 @@ namespace FastMath
249251
//
250252
// Trigonometric functions
251253
//
252-
static const float fsl_PI = 3.1415926535897932384626433f;
253-
static const float fsl_HALF_PI = 0.5f * fsl_PI;
254254

255255
// 4th order polynomial approximation
256256
// 4 VGRP, 16 ALU Full Rate
@@ -270,7 +270,7 @@ namespace FastMath
270270

271271
// acos function mirroring
272272
// check per platform if compiles to a selector - no branch neeeded
273-
return inX >= 0.0f ? s : fsl_PI - s;
273+
return inX >= 0.0f ? s : Math::PI - s;
274274
}
275275

276276
// 4th order polynomial approximation
@@ -281,7 +281,7 @@ namespace FastMath
281281
float x = inX;
282282

283283
// asin is offset of acos
284-
return fsl_HALF_PI - acosFast4(x);
284+
return Math::HALF_PI - acosFast4(x);
285285
}
286286

287287
// 4th order hyperbolical approximation
@@ -305,17 +305,17 @@ namespace FastMath
305305
float ACos(float inX)
306306
{
307307
float x = abs(inX);
308-
float res = -0.156583f * x + fsl_HALF_PI;
308+
float res = -0.156583f * x + Math::HALF_PI;
309309
res *= fastSqrtNR0(1.0f - x);
310-
return (inX >= 0) ? res : fsl_PI - res;
310+
return (inX >= 0) ? res : Math::PI - res;
311311
}
312312

313313
// Same cost as Acos + 1 FR
314314
// Same error
315315
// input [-1, 1] and output [-PI/2, PI/2]
316316
float ASin(float x)
317317
{
318-
return fsl_HALF_PI - ACos(x);
318+
return Math::HALF_PI - ACos(x);
319319
}
320320

321321
// max absolute error 1.3x10^-3
@@ -330,7 +330,7 @@ namespace FastMath
330330
poly = -0.301895f + poly * t1;
331331
poly = 1.0f + poly * t1;
332332
poly = poly * t0;
333-
return (x < 1.0f) ? poly : fsl_HALF_PI - poly;
333+
return (x < 1.0f) ? poly : Math::HALF_PI - poly;
334334
}
335335

336336
// 4 VGPR, 16 FR (12 FR, 1 QR), 2 scalar

0 commit comments

Comments
 (0)