feat(管道模式): begin

Author: yyc-git

packages/管道模式/article.md

@@ -1,13 +1,14 @@
 import { state as renderState } from "render/src/RenderStateType"
 import { pipeline } from "pipeline_manager/src/type/PipelineType"
 import { pipelineName, state } from "jia_renderInMobile_pipeline_state_type/src/StateType"
-import { exec as execInitWebGL1 } from "./jobs/render/InitWebGL1Job"
+// import { exec as execInitWebGL1 } from "./jobs/render/InitWebGL1Job"
+import * as InitWebGL1Job from "./jobs/render/InitWebGL1Job"
 
+//返回Job的exec函数
 let _getExec = (_pipelineName: string, jobName: string) => {
 	switch (jobName) {
 		case "init_webgl1_jia_renderInMobile":
-            //返回Job的exec函数
-			return execInitWebGL1
+			return InitWebGL1Job.exec
 		default:
 			return null
 	}
@@ -27,12 +28,12 @@ export let getPipeline = (): pipeline<renderState, state> => {
         //getExec关联了allPipelineData中的job名与管道的Job
 		getExec: _getExec,
         //allPipelineData是JSON配置数据，用来指定Job的执行顺序
-        //它可以包括多个管道的配置数据，但这里只有Render Pipeline管道的配置数据
+        //它包括所有管道的配置数据，目前只有Render Pipeline管道的配置数据
 		allPipelineData: [
 			{
                 //管道名
 				name: "render",
-                //groups包括所有的group，这里只有一个group
+                //groups包括所有的group，目前只有一个group
 				groups: [
 					{
                         //group名
@@ -44,7 +45,7 @@ export let getPipeline = (): pipeline<renderState, state> => {
 						link: "concat",
                         //elements是该group包含的所有element
                         //element的类型可以为job或者group
-                        //这里只有一个类型为job的element
+                        //目前只有一个类型为job的element
 						elements: [
 							{
 								"name": "init_webgl1_jia_renderInMobile",

管道模式代码/jia_renderInMobile_pipeline/src/Main.ts

@@ -8,6 +8,7 @@ export let exec: execType<renderState> = (renderState, { getStatesFunc, setState
     //从RenderState中获得所有的PipelineState
 	let states = getStatesFunc<renderState, states>(renderState)
 
+    //从全局变量中获得canvas
 	let canvas: HTMLCanvasElement = globalThis.canvas
 
     //调用most.js库，返回了一个流

管道模式代码/jia_renderInMobile_pipeline/src/jobs/render/InitWebGL1Job.ts

@@ -1,9 +1,12 @@
 export const pipelineName = "JiaRenderInMobile"
 
+//JiaRenderInMobilePipelineState的类型
 export type state = {
     gl: WebGLRenderingContext | null
 }
 
+//states定义了在JiaRenderInMobilePipeline的所有的Job中需要调用的所有的PipelineState的类型
+//因为目前只需要调用JiaRenderInMobilePipelineState，所以只定义了它的类型
 export type states = {
     [pipelineName]: state,
 }

管道模式代码/jia_renderInMobile_pipeline_state_type/src/StateType.ts

@@ -7,7 +7,7 @@ export type insertAction = "before" | "after"
 export type jobOrder = {
   //管道名
   pipelineName: pipelineName,
-  //将该管道的所有Job插入到的element的名称（element可以为job或者group）
+  //将该管道的所有Job插入到element中（element可以为job或者group），这是element的名称
   insertElementName: elementName,
   //值可以为before或者after，意思是插入到该element之前或者之后
   insertAction: insertAction,

管道模式代码/pipeline_manager/src/type/RegisterPipelineType.ts

@@ -1,9 +1,9 @@
 import { state } from "./RenderStateType"
 import { state as pipelineState } from "pipeline_manager/src/type/StateType"
 import { createState as createPipelineManagerState, registerPipeline, runPipeline, init } from "pipeline_manager"
-import { getPipeline as getRenderInPCPipeline } from "renderInPC_pipeline/src/Main"
-import { getPipeline as getJiaRenderInMobilePipeline } from "jia_renderInMobile_pipeline/src/Main"
-import { getPipeline as getYiRenderInMobilePipeline } from "yi_renderInMobile_pipeline/src/Main"
+import * as RenderInPCPipeline from "renderInPC_pipeline/src/Main"
+import * as JiaRenderInMobilePipeline from "jia_renderInMobile_pipeline/src/Main"
+import * as YiRenderInMobilePipeline from "yi_renderInMobile_pipeline/src/Main"
 import { service as mostService } from "most/src/MostService"
 import { getExnFromStrictNull } from "commonlib-ts/src/NullableUtils"
 import { unsafeGetState, setState } from "./RenderStateContainer"
@@ -24,7 +24,7 @@ export let registerAllPipelines = (state: state) => {
     if (_isPC()) {
         let pipelineManagerState = registerPipeline(
             state.pipelineManagerState,
-            getRenderInPCPipeline(),
+            RenderInPCPipeline.getPipeline(),
             []
         )
 
@@ -36,12 +36,12 @@ export let registerAllPipelines = (state: state) => {
     else {
         let pipelineManagerState = registerPipeline(
             state.pipelineManagerState,
-            getJiaRenderInMobilePipeline(),
+            JiaRenderInMobilePipeline.getPipeline(),
             []
         )
         pipelineManagerState = registerPipeline(
             pipelineManagerState,
-            getYiRenderInMobilePipeline(),
+            YiRenderInMobilePipeline.getPipeline(),
             [
                 {
                     pipelineName: "render",

管道模式代码/render/src/Render.ts

@@ -1,18 +1,18 @@
 import { state as renderState } from "render/src/RenderStateType"
 import { pipeline } from "pipeline_manager/src/type/PipelineType"
 import { pipelineName, state } from "renderInPC_pipeline_state_type/src/StateType"
-import { exec as execInitWebGL2 } from "./jobs/render/InitWebGL2Job"
-import { exec as execDeferRender } from "./jobs/render/DeferRenderJob"
-import { exec as execTonemap } from "./jobs/render/TonemapJob"
+import * as InitWebGL2Job from "./jobs/render/InitWebGL2Job"
+import * as DeferRenderJob from "./jobs/render/DeferRenderJob"
+import * as TonemapJob from "./jobs/render/TonemapJob"
 
 let _getExec = (_pipelineName: string, jobName: string) => {
 	switch (jobName) {
 		case "init_webgl2_renderInPC":
-			return execInitWebGL2
+			return InitWebGL2Job.exec
 		case "defer_render_renderInPC":
-			return execDeferRender
+			return DeferRenderJob.exec
 		case "tonemap_renderInPC":
-			return execTonemap
+			return TonemapJob.exec
 		default:
 			return null
 	}

管道模式代码/renderInPC_pipeline/src/Main.ts

@@ -1,14 +1,14 @@
 import { createState, render } from "./Render"
 
-//假canvas
+//构造假canvas
 let canvas = {
     getContext: (_) => 1 as any
 }
 
-//指定运行环境为PC端
+//此处设置运行环境为PC端
+//也可以通过设置为false来设置运行环境为移动端 
 globalThis.isPC = true
 
-
 let renderState = createState()
 
 renderState = render(renderState, canvas)

管道模式代码/story_after/src/Client.ts

@@ -1,14 +1,14 @@
 import { createState, render } from "./Render"
 
-//假canvas
+//构造假canvas
 let canvas = {
     getContext: (_) => 1 as any
 }
 
-//指定运行环境为PC端
+//此处设置运行环境为PC端
+//也可以通过设置为false来设置运行环境为移动端 
 globalThis.isPC = true
 
-
 let renderState = createState()
 
 renderState = render(renderState, canvas)

管道模式代码/story_before/src/Client.ts

@@ -1,14 +1,14 @@
 import { createState, registerAllPipelines, render } from "render/src/Render"
 
-//假canvas
+//构造假canvas
 let canvas = {
     getContext: (_) => 1 as any
 }
 
-//指定运行环境为PC端
+//此处设置运行环境为PC端
+//也可以通过设置为false来设置运行环境为移动端 
 globalThis.isPC = true
 
-
 let renderState = createState()
 
 renderState = registerAllPipelines(renderState)