chore: clear shader docs

Orillusion · Jul 27, 2024 · fc74fa1 · fc74fa1
1 parent cc90b82
commit fc74fa1
Show file tree

Hide file tree

Showing 139 changed files with 445 additions and 562 deletions.
diff --git a/packages/debug/GUIHelp.ts b/packages/debug/GUIHelp.ts
@@ -181,6 +181,7 @@ class _GUIHelp {
         }
     }
 }
+
 /**
  * @internal
  */

diff --git a/packages/effect/grass/shader/GrassBaseShader.ts b/packages/effect/grass/shader/GrassBaseShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GrassBaseShader = /*wgsl*/ `
     #include "GlobalUniform"
     #include "FragmentOutput"

diff --git a/packages/effect/grass/shader/GrassCastShadowShader.ts b/packages/effect/grass/shader/GrassCastShadowShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GrassCastShadowShader = /* wgsl */`
     #include "WorldMatrixUniform"
     #include "GrassVertexAttributeShader"

diff --git a/packages/effect/grass/shader/GrassShader.ts b/packages/effect/grass/shader/GrassShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GrassShader = /* wgsl */`
     #include "WorldMatrixUniform"
     #include "GrassVertexAttributeShader"

diff --git a/packages/effect/grass/shader/GrassVertexAttributeShader.ts b/packages/effect/grass/shader/GrassVertexAttributeShader.ts
@@ -1,4 +1,7 @@
 
+/**
+ * @internal
+ */
 export let GrassVertexAttributeShader: string = /*wgsl*/ `
     #include "WorldMatrixUniform"
     struct VertexAttributes{

diff --git a/packages/graphic/compute/graphic3d/Graphic3DShader.ts b/packages/graphic/compute/graphic3d/Graphic3DShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let Graphic3DShader: string = /*wgsl*/ `
     #include "WorldMatrixUniform"
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicDecCompute.ts b/packages/graphic/compute/graphic3d/GraphicDecCompute.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let graphicDecCompute = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicDynamicCompute.ts b/packages/graphic/compute/graphic3d/GraphicDynamicCompute.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let graphicDynamicCompute = (subCode: string) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicFaceComput2.ts b/packages/graphic/compute/graphic3d/GraphicFaceComput2.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let graphicFaceCompute2 = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicFaceCompute.ts b/packages/graphic/compute/graphic3d/GraphicFaceCompute.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let graphicFaceCompute = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicFaceCompute3.ts b/packages/graphic/compute/graphic3d/GraphicFaceCompute3.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GraphicFaceCompute3 = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicLineCompute.ts b/packages/graphic/compute/graphic3d/GraphicLineCompute.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GraphicLineCompute = () => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicTrailCompute.ts b/packages/graphic/compute/graphic3d/GraphicTrailCompute.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let graphicTrailCompute = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/graphic3d/GraphicTrailCompute2.ts b/packages/graphic/compute/graphic3d/GraphicTrailCompute2.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GraphicTrailCompute2 = (segmentCode: number) => {
     let code = /*wgsl*/`
     #include "GlobalUniform"

diff --git a/packages/graphic/compute/grass/GrassAnimCompute_cs.ts b/packages/graphic/compute/grass/GrassAnimCompute_cs.ts
@@ -1,2 +1,5 @@
+/**
+ * @internal
+ */
 export let GrassAnimCompute_cs = /*wgsl*/`
 `
diff --git a/packages/graphic/compute/grass/GrassGeometryCompute_cs.ts b/packages/graphic/compute/grass/GrassGeometryCompute_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let GrassGeometryCompute_cs = /*wgsl*/`
    struct GrassNode {
       grassCount: f32,

diff --git a/packages/graphic/compute/shape3d/CircleShape3DCode_cs.ts b/packages/graphic/compute/shape3d/CircleShape3DCode_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let CircleShape3DCode_cs = /*wgsl*/`
 
 struct CircleShape3D {

diff --git a/packages/graphic/compute/shape3d/EllipseShape3DCode_cs.ts b/packages/graphic/compute/shape3d/EllipseShape3DCode_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let EllipseShape3DCode_cs = /*wgsl*/`
 
 struct EllipseShape3D {

diff --git a/packages/graphic/compute/shape3d/Path2DShape3DCode_cs.ts b/packages/graphic/compute/shape3d/Path2DShape3DCode_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let Path2DShape3DCode_cs = /*wgsl*/`
 
 struct Path2DShape3D {

diff --git a/packages/graphic/compute/shape3d/Path3DShape3DCode_cs.ts b/packages/graphic/compute/shape3d/Path3DShape3DCode_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let Path3DShape3DCode_cs = /*wgsl*/`
 
 struct Path3DShape3D {

diff --git a/packages/graphic/compute/shape3d/RoundRectShape3DCode_cs.ts b/packages/graphic/compute/shape3d/RoundRectShape3DCode_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let RoundRectShape3DCode_cs = /*wgsl*/`
 
 struct RoundRectShape3D {

diff --git a/packages/graphic/compute/shape3d/Shape3DCommonCode_cs.ts b/packages/graphic/compute/shape3d/Shape3DCommonCode_cs.ts
@@ -4,6 +4,9 @@ import { Path2DShape3DCode_cs } from "./Path2DShape3DCode_cs";
 import { Path3DShape3DCode_cs } from "./Path3DShape3DCode_cs";
 import { RoundRectShape3DCode_cs } from "./RoundRectShape3DCode_cs";
 
+/**
+ * @internal
+ */
 export let Shape3DCommonCode_cs = /*wgsl*/`
 
 ${CircleShape3DCode_cs}

diff --git a/packages/graphic/compute/shape3d/Shape3DKeyPointCompute_cs.ts b/packages/graphic/compute/shape3d/Shape3DKeyPointCompute_cs.ts
@@ -1,5 +1,8 @@
 import { Shape3DCommonCode_cs } from "./Shape3DCommonCode_cs";
 
+/**
+ * @internal
+ */
 export let Shape3DKeyPointCompute_cs = /*wgsl*/`
    ${Shape3DCommonCode_cs}
    

diff --git a/packages/graphic/compute/shape3d/Shape3DVertexCompute_cs.ts b/packages/graphic/compute/shape3d/Shape3DVertexCompute_cs.ts
@@ -1,5 +1,8 @@
 import { Shape3DCommonCode_cs } from "./Shape3DCommonCode_cs";
 
+/**
+ * @internal
+ */
 export let Shape3DVertexCompute_cs = /*wgsl*/`
    ${Shape3DCommonCode_cs}
 

diff --git a/packages/graphic/compute/shape3d/Shape3DVertexFillZero_cs.ts b/packages/graphic/compute/shape3d/Shape3DVertexFillZero_cs.ts
@@ -1,5 +1,8 @@
 import { Shape3DCommonCode_cs } from "./Shape3DCommonCode_cs";
 
+/**
+ * @internal
+ */
 export let Shape3DVertexFillZero_cs = /*wgsl*/`
    ${Shape3DCommonCode_cs}
 

diff --git a/packages/media-extention/ChromaKeyShader.ts b/packages/media-extention/ChromaKeyShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let ChromaKeyShader = /*wgsl*/`
 #include "Common_vert"
 #include "Common_frag"

diff --git a/packages/media-extention/VideoShader.ts b/packages/media-extention/VideoShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let VideoShader = /*wgsl*/`
     #include "Common_vert"
     #include "Common_frag"

diff --git a/packages/particle/shader/ParticleRenderShader.ts b/packages/particle/shader/ParticleRenderShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let ParticleRenderShader = /* wgsl */ `
     #include "Common_vert"
     #include "Common_frag"

diff --git a/packages/particle/shader/Particle_Mass_UnLight_shader.ts b/packages/particle/shader/Particle_Mass_UnLight_shader.ts
@@ -101,6 +101,7 @@ fn main(
     return VertexOutput(Vertex_Uv ,vWorldPos.xyz,vWorldNormal, position );
 }
 `;
+
 /**
  * @internal
  */

diff --git a/packages/particle/shader/compute_density_pressure_compute.ts b/packages/particle/shader/compute_density_pressure_compute.ts
@@ -1,4 +1,5 @@
 import { FastMath_shader } from './FastMath';
+
 /**
  * @internal
  */

diff --git a/packages/physics/Physics.ts b/packages/physics/Physics.ts
@@ -169,5 +169,8 @@ class _Physics {
  * ```
  * @group Plugin
  */
+/**
+ * @internal
+ */
 export let Physics = new _Physics();
 export {Ammo}
diff --git a/src/assets/shader/anim/SkeletonAnimation_shader.ts b/src/assets/shader/anim/SkeletonAnimation_shader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export class SkeletonAnimation_shader {
     public static groupBindingAndFunctions(beginGroup: number, beginBinding: number) {
         return /* wgsl */ `

diff --git a/src/assets/shader/cluster/ClusterBoundsSource_cs.ts b/src/assets/shader/cluster/ClusterBoundsSource_cs.ts
@@ -1,5 +1,8 @@
 import { ClusterConfig } from "../../../gfx/renderJob/passRenderer/cluster/ClusterConfig";
 
+/**
+ * @internal
+ */
 export let ClusterBoundsSource_cs: string = /* wgsl */`
   #include "GlobalUniform"
 

diff --git a/src/assets/shader/cluster/ClusterLighting_cs.ts b/src/assets/shader/cluster/ClusterLighting_cs.ts
@@ -1,5 +1,8 @@
 import { ClusterConfig } from "../../../gfx/renderJob/passRenderer/cluster/ClusterConfig";
 
+/**
+ * @internal
+ */
 export let ClusterLighting_cs: string = /*wgsl*/`
 #include "GlobalUniform"
 

diff --git a/src/assets/shader/compute/BLUR_CsShader.ts b/src/assets/shader/compute/BLUR_CsShader.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let BLUR_CsShader: string = /* wgsl */`
 #include "GlobalUniform"
 

diff --git a/src/assets/shader/compute/BRDFLUT.ts b/src/assets/shader/compute/BRDFLUT.ts
@@ -1,4 +1,6 @@
-
+/**
+ * @internal
+ */
 export let BRDFLUT: string = /*wgsl*/ `
 var<private>PI: f32 = 3.141592653589793;
 

diff --git a/src/assets/shader/compute/BloomEffect_cs.ts b/src/assets/shader/compute/BloomEffect_cs.ts
@@ -1,5 +1,7 @@
 import { ColorUtil } from "../utils/ColorUtil";
-
+/**
+ * @internal
+ */
 let BloomCfg =  /*wgsl*/ `
 struct BloomCfg{
   downSampleStep: f32,
@@ -25,7 +27,9 @@ let CalcUV_01 = /*wgsl*/ `
 `
 
 //_______________calc weight
-
+/**
+ * @internal
+ */
 let GaussWeight2D: string =  /*wgsl*/ `
 fn GaussWeight2D(x:f32, y:f32, sigma:f32) -> f32
   {
@@ -37,11 +41,12 @@ fn GaussWeight2D(x:f32, y:f32, sigma:f32) -> f32
       return pow(E, a) / (2.0 * PI * sigma_2);
   }
 `
-
+/**
+ * @internal
+ */
 let GaussBlur = function (GaussNxN: string, inTex: string, inTexSampler: string) {
   var code: string = /*wgsl*/ `
-  
-  
+
   fn ${GaussNxN}(uv:vec2<f32>, n:i32, stride:vec2<f32>, sigma:f32) -> vec3<f32>
   {
       var color = vec3<f32>(0.0);
@@ -69,7 +74,9 @@ let GaussBlur = function (GaussNxN: string, inTex: string, inTexSampler: string)
 
 
 //________________________pixel filter
-
+/**
+ * @internal
+ */
 export let threshold: string = /*wgsl*/ `
 ${ColorUtil}
 ${BloomCfg}
@@ -105,7 +112,9 @@ fn CsMain( @builtin(workgroup_id) workgroup_id : vec3<u32> , @builtin(global_inv
 `
 
 //________________________down sample
-
+/**
+ * @internal
+ */
 export let downSample: string = /*wgsl*/ `
 ${BloomCfg}
 
@@ -139,6 +148,9 @@ fn CsMain( @builtin(workgroup_id) workgroup_id : vec3<u32> , @builtin(global_inv
 
 
 //__________________________up sample
+/**
+ * @internal
+ */
 export let upSample = /*wgsl*/ `
 ${BloomCfg}
 
@@ -180,6 +192,9 @@ fn CsMain( @builtin(workgroup_id) workgroup_id : vec3<u32> , @builtin(global_inv
 
 
 //__________________________blend
+/**
+ * @internal
+ */
 export let post = /*wgsl*/ `
 ${ColorUtil}
 ${BloomCfg}

diff --git a/src/assets/shader/compute/BlurEffectCreator_cs.ts b/src/assets/shader/compute/BlurEffectCreator_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let BlurEffectCreatorSample_cs: string = /*wgsl*/ `
     struct ImageSize {
         srcWidth: i32,
@@ -20,6 +23,9 @@ export let BlurEffectCreatorSample_cs: string = /*wgsl*/ `
     }
 `
 
+/**
+ * @internal
+ */
 export let BlurEffectCreatorBlur_cs: string = /*wgsl*/ `
     struct ImageSize {
         srcWidth: i32,

diff --git a/src/assets/shader/compute/DDGIIrradiance_Cs.ts b/src/assets/shader/compute/DDGIIrradiance_Cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let DDGIIrradiance_shader = /*wgsl*/`
 #include "GenerayRandomDir"
 #include "MathShader"

diff --git a/src/assets/shader/compute/DDGILighting_CSShader.ts b/src/assets/shader/compute/DDGILighting_CSShader.ts
@@ -1,5 +1,8 @@
 import { CSM } from "../../../core/csm/CSM";
 
+/**
+ * @internal
+ */
 export let DDGILighting_shader = /*wgsl*/`
 var<private> PI: f32 = 3.14159265359;
 

diff --git a/src/assets/shader/compute/DepthOfView_cs.ts b/src/assets/shader/compute/DepthOfView_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let DepthOfView_cs: string = /*wgsl*/ `
 #include "GlobalUniform"
 #include "GBufferStand"

diff --git a/src/assets/shader/compute/ErpImage2CubeMapCreateCube_cs.ts b/src/assets/shader/compute/ErpImage2CubeMapCreateCube_cs.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export let ErpImage2CubeMapCreateCube_cs: string = /*wgsl*/ `
   struct ImageSize {
     srcWidth : i32,
-Original file line number
+Diff line change
@@ Expand Up / @@ -181,6 +181,7 @@ class _GUIHelp { @@
             }
         }
     }
     /**
      * @internal
      */
@@ Expand Down @@