Refactor 2d render pipeline #1708

singlecoder · 2023-08-22T07:10:20Z

galacean-refactor-2d-render-pipeline.zip

cptbtptpbcptdtptp · 2023-08-28T08:24:57Z

packages/core/src/2d/text/TextRenderer.ts

 for (let i = 0; i < charCount; ++i) {
 const charRenderData = charRenderDatas[i];
 const spriteRenderData = spriteRenderDataPool.getFromPool();
- spriteRenderData.set(this, material, charRenderData.renderData, charRenderData.texture, i);
- charsData[i] = spriteRenderData;
+ spriteRenderData.set(this, material, charRenderData.renderData, charRenderData.texture);


charRenderData.usage = RenderDataUsage.Sprite;

cptbtptpbcptdtptp · 2023-08-28T08:48:41Z

packages/core/src/Camera.ts

@@ -70,6 +71,9 @@ export class Camera extends Component {
 _renderPipeline: BasicRenderPipeline;
 /** @internal */
 @ignoreClone
+ _batcherManager: BatcherManager;


Why not in BasicRenderPipeline.

cptbtptpbcptdtptp · 2023-08-28T09:33:37Z

packages/core/src/RenderPipeline/batcher/BatcherManager.ts

+ }
+
+ commitRenderData(context: RenderContext, data: RenderData | Array<RenderData>): void {
+ if (!data) return;


This line can be deleted.

cptbtptpbcptdtptp · 2023-08-28T09:42:11Z

packages/core/src/RenderPipeline/batcher/Batcher2D.ts

+ /** @internal */
+ _meshCount: number = 1;
+ /** @internal */
+ _subMeshPool: ClassPool<SubMesh> = new ClassPool(SubMesh);


Can be a static variable.

Can be a static variable.

has deleted

cptbtptpbcptdtptp · 2023-08-28T09:54:09Z

packages/core/src/RenderPipeline/batcher/Batcher2D.ts

+
+ commitRenderData(context: RenderContext, data: SpriteRenderData): void {
+ if (this._preSpriteRenderData) {
+ if (this._vertexCount + data.verticesData.vertexCount > Batcher2D.MAX_VERTEX_COUNT) {


Need to judge index

cptbtptpbcptdtptp · 2023-08-28T11:41:29Z

There is a doubt that the current BatchManager is subordinate to the Camera. When the number of cameras increases, the memory occupied by Batch2D will also increase multiple times.

The same is true for SpriteMaskBatcher

cptbtptpbcptdtptp · 2023-08-28T11:52:05Z

packages/core/src/RenderPipeline/BasicRenderPipeline.ts

 this._cascadedShadowCaster = new CascadedShadowCasterPass(camera);
 this._depthOnlyPass = new DepthOnlyPass(engine);
+ this._spriteMaskManager = new SpriteMaskManager(camera.engine);


Is it better to put SpriteMaskManager in Scene? Because :

Mask does not depend on rendering timing.

More memory efficient.

GuoLei1990 · 2024-05-17T03:26:43Z

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

+ batcher.freeChunk(renderer._chunk);
+ renderer._chunk = batcher.allocateChunk(4);
+ } else {
+ renderer._chunk = batcher.allocateChunk(4);


GuoLei1990 · 2024-05-17T03:26:57Z

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

- positions[i] ||= new Vector3();
- uvs[i] ||= new Vector2();
+ const batcher =
+ renderer instanceof SpriteRenderer


instanceof is not good!

But this is not a high-frequency called function

GuoLei1990 · 2024-05-17T03:31:33Z

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

 }
- verticesData.triangles = SimpleSpriteAssembler._rectangleTriangles;
+ renderer._chunk._indices = this._rectangleTriangles;


Dirty code, opt like this!

static resetData(renderer: SpriteRenderer | SpriteMask): void { const batcher = renderer instanceof SpriteRenderer ? renderer.engine._batcherManager._batcher2D : renderer.engine._spriteMaskManager._batcher; const lastChunk = renderer._chunk; if (lastChunk) { batcher.freeChunk(lastChunk); } const chunk = batcher.allocateChunk(4); chunk._indices = this._rectangleTriangles; renderer._chunk = chunk; }

GuoLei1990 · 2024-05-17T03:34:55Z

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

 }

 static updatePositions(renderer: SpriteRenderer | SpriteMask): void {
 const { width, height, sprite } = renderer;
 const { x: pivotX, y: pivotY } = sprite.pivot;
 // Renderer's worldMatrix;
- const { _worldMatrix: worldMatrix } = SimpleSpriteAssembler;
+ const { _worldMatrix: worldMatrix } = this;


Clear comments, remove ; .

GuoLei1990 · 2024-05-17T03:47:06Z

packages/core/src/RenderPipeline/batcher/MeshBuffer.ts

+ * @internal
+ */
+export class MBChunk implements IPoolElement {
+ _mbId: number = -1;


A bunch of weird and wordy names！！！

GuoLei1990 · 2024-05-17T03:52:29Z

packages/core/src/2d/assembler/SimpleSpriteAssembler.ts

+ index += 9;
+ vertices[index] = right;
+ vertices[index + 1] = top;
+ }


Better per and less code

static updateUVs(renderer: SpriteRenderer | SpriteMask): void { const spriteUVs = renderer.sprite._getUVs(); const { x: left, y: bottom } = spriteUVs[0]; const { x: right, y: top } = spriteUVs[3]; const chunk = renderer._chunk; const vertices = chunk._meshBuffer._vertices; const index = chunk._vEntry.start + 3; vertices[index] = left; vertices[index + 1] = bottom; vertices[index + 10] = right; vertices[index + 11] = bottom; vertices[index + 20] = left; vertices[index + 21] = top; vertices[index + 30] = right; vertices[index + 31] = top; }

GuoLei1990 · 2024-05-17T06:09:49Z

packages/core/src/2d/assembler/SlicedSpriteAssembler.ts

 }
- verticesData.triangles = SlicedSpriteAssembler._rectangleTriangles;
+ renderer._chunk._indices = this._rectangleTriangles;


Same with SimpleSpriteAssembler

GuoLei1990 · 2024-05-17T06:18:33Z

packages/core/src/2d/assembler/SlicedSpriteAssembler.ts

+ index += 9;
+ }
+ }
+ }


Before has BUG when set uv in updatePositions?

GuoLei1990 · 2024-05-17T06:21:44Z

packages/core/src/2d/assembler/SlicedSpriteAssembler.ts

+ vertices[index + 3] = a;
+ index += 9;
+ }
+ }


static updateColor(renderer: SpriteRenderer): void { const chunk = renderer._chunk; const vertices = chunk._meshBuffer._vertices; const color = renderer.color; let index = chunk._vEntry.start + 5; for (let i = 0; i < 16; ++i) { color.copyToArray(vertices, index); index += 9; } }

Adding one more API call compared to direct invocation

And r g b a should be get repeat in loop

GuoLei1990 · 2024-05-17T06:39:16Z

packages/core/src/2d/assembler/TiledSpriteAssembler.ts

+ indicesCount += 6;
+ }
+ }
+ this.resetData(renderer, vertexCount, indicesCount);


Code of this quality should not exist in the CR stage

GuoLei1990 · 2024-05-17T06:44:06Z

packages/core/src/2d/assembler/TiledSpriteAssembler.ts

+ const uvB = uvColumn.get(doubleJ);
+ const uvR = uvRow.get(2 * i + 1);
+ const uvT = uvColumn.get(doubleJ + 1);
+ if (isNaN(uvL) || isNaN(uvL) || isNaN(uvR) || isNaN(uvT)) {


isNaN(xxx) seems strange

This block, I just reused the existing code

GuoLei1990 · 2024-05-17T06:45:34Z

packages/core/src/2d/assembler/TiledSpriteAssembler.ts

+ vertices[index + 3] = a;
+ index += 9;
+ }
+ }


Refer to previous suggestions

the same as my opinion

GuoLei1990 · 2024-05-17T06:52:11Z

packages/core/src/2d/sprite/SpriteMask.ts

+ // @ts-ignore
+ this._updateTransformShaderData(context, Matrix._identity);
+ }
+ }


Just don't want use worldMatrix?

_updateTransformShaderData consumes a lot of performance，for 2d with default material, just use renderer_MVPMat

GuoLei1990 · 2024-05-17T06:55:51Z

packages/core/src/2d/sprite/SpriteMask.ts

- renderData.set(this, material, this._verticesData);
+ engine._spriteMaskManager.addMask(this);
+ const renderData = engine._spriteRenderDataPool.getFromPool();
+ const { _chunk: chunk } = this;


It is not recommended to declare a single variable cache like this

can not understand

GuoLei1990 · 2024-05-17T07:02:08Z

packages/core/src/2d/sprite/SpriteRenderer.ts

@@ -284,13 +294,13 @@ export class SpriteRenderer extends Renderer {
 * @internal
 */
 override _updateShaderData(context: RenderContext, onlyMVP: boolean): void {
- if (onlyMVP) {
+ if (this.getMaterial() === this.engine._spriteDefaultMaterial || onlyMVP) {


Why add this.getMaterial() === this.engine._spriteDefaultMaterial this condition?

Custom material may be use other matrix

GuoLei1990 · 2024-05-17T07:11:26Z

packages/core/src/2d/text/TextRenderer.ts

+ this._resetSubFont();
+ }
+ return this._subFont;
+ }


为什么公开这个接口？作用是什么？你如何对用户描述？

should be internal, has change

GuoLei1990 · 2024-05-17T07:13:42Z

packages/core/src/2d/text/TextRenderer.ts

@@ -354,13 +370,13 @@ export class TextRenderer extends Renderer {
 * @internal
 */
 override _updateShaderData(context: RenderContext, onlyMVP: boolean): void {
- if (onlyMVP) {
+ if (this.getMaterial() === this.engine._spriteDefaultMaterial || onlyMVP) {


Same with before

Custom material may be use other matrix

GuoLei1990 · 2024-05-17T07:16:54Z

packages/core/src/2d/text/TextRenderer.ts

+ const worldPosition0 = TextRenderer._worldPositions[0];
+ const worldPosition1 = TextRenderer._worldPositions[1];
+ const worldPosition2 = TextRenderer._worldPositions[2];
+ const worldPosition3 = TextRenderer._worldPositions[3];


Don't make stupid mistakes

what do you mean ??

GuoLei1990 · 2024-05-17T07:22:20Z

packages/core/src/2d/text/TextRenderer.ts

+ vertices[index + 1] = position.y;
+ vertices[index + 2] = position.z;
+ index += 9;
+ }


const worldPositions = TextRenderer._worldPositions; ... const { chunk } = charRenderInfo; const vertices = chunk._meshBuffer._vertices; const index = chunk._vEntry.start; for (let i = 0; i < 4; ++i) { worldPositions[i].copyToArray(vertices, index + 9 * i); }

GuoLei1990 · 2024-05-17T07:27:50Z

packages/core/src/2d/text/TextRenderer.ts

+ vertices[index + 2] = r;
+ vertices[index + 3] = g;
+ vertices[index + 4] = b;
+ vertices[index + 5] = a;


GuoLei1990 · 2024-05-17T07:31:49Z

packages/core/src/2d/text/index.ts

@@ -1,4 +1,3 @@
 export { Font } from "./Font";
 export { TextRenderer } from "./TextRenderer";
-// Export for CanvasRenderer plugin.
 export { TextUtils } from "./TextUtils";


This can delete now?

of cause, CanvasRenderer has deleted

GuoLei1990 · 2024-05-17T07:38:29Z

packages/core/src/Engine.ts

@@ -268,6 +264,9 @@ export class Engine extends EventDispatcher {
 this._textDefaultFont = Font.createFromOS(this, "Arial");
 this._textDefaultFont.isGCIgnored = true;

+ this.inputManager = new InputManager(this);


merge error?

GuoLei1990 · 2024-05-17T07:45:18Z

packages/core/src/RenderPipeline/batcher/Batcher2D.ts

+ this._preElement = null;
+ }
+
+ batch(srcElements, dstElements): void {


This is still 2D specialization logic

RenderElement, sorry, i forget write, want batch logic write here, now, only 2D

GuoLei1990 · 2024-05-17T07:51:55Z

packages/core/src/RenderPipeline/RenderData.ts

+ /** @internal */
+ _componentInstanceId: number;
+ /** @internal */
+ _distanceForSort: number;


This is a internal class, why use internal property?

I will change

GuoLei1990 · 2024-05-17T07:53:52Z

packages/core/src/RenderPipeline/RenderQueue.ts


 /**
 * Render queue.
 */
 export class RenderQueue {
+ private static _textureProperty: ShaderProperty = ShaderProperty.getByName("renderer_SpriteTexture");
+


you define a render property in Renderqueue?

Just for text that with multi-texture, i do not have any good idea now

GuoLei1990 · 2024-05-17T08:11:09Z

packages/core/src/RenderPipeline/RenderQueue.ts

- } else {
- return distanceDiff;
- }
+ return dataA._distanceForSort - dataB._distanceForSort || instanceIdDiff;


This is not OK?

return ( dataA._priority - dataB._priority || dataA._distanceForSort - dataB._distanceForSort || dataA._componentInstanceId - dataB._componentInstanceId || dataA._materialPriority - dataB._materialPriority );

Yeah, in some case, the same renderer wo want control the sort just for material priority, link lottie or spine

GuoLei1990 · 2024-05-17T08:18:01Z

packages/core/src/RenderPipeline/RenderQueue.ts

+ // TextRenderer may be has multi-texture.
+ const isText = usage === RenderDataUsage.Text;
+ // @ts-ignore
+ isText && rendererData.setTexture(RenderQueue._textureProperty, data.texture);


No!!!!! This configuration should be done at the upper level

I don't has a good idea how to handle a text renderer with multi-texture right now

GuoLei1990 · 2024-05-17T08:22:07Z

packages/core/src/RenderPipeline/RenderQueue.ts

+ const { usage } = data;
+ const needMask = usage === RenderDataUsage.Sprite || usage === RenderDataUsage.Text;
+ const renderer = data.component;
+ needMask && spriteMaskManager.preRender(camera, <SpriteRenderer>renderer);


Type is not write

GuoLei1990 · 2024-05-17T08:33:09Z

packages/core/src/RenderPipeline/RenderQueue.ts

- compileMacros
- );
+ const { usage } = data;
+ const needMask = usage === RenderDataUsage.Sprite || usage === RenderDataUsage.Text;


SpriteMask is still very specialized!

GuoLei1990 · 2024-05-17T08:39:38Z

packages/core/src/RenderPipeline/SpriteMaskManager.ts

-import { SpriteMaskBatcher } from "./SpriteMaskBatcher";
-import { SpriteMaskRenderData } from "./SpriteMaskRenderData";
+import { StencilOperation } from "../shader";
+import { SpriteMaskBatcher } from "./batcher/SpriteMaskBatcher";


Need to discuss！！！

GuoLei1990 · 2024-05-17T08:46:31Z

packages/core/src/RenderPipeline/SpriteRenderData.ts

 }

- set(
+ override set(


Further abstraction is needed. In addition, this is a common class between text and elves. The current definition is unreasonable.

GuoLei1990 · 2024-05-17T09:04:06Z

packages/core/src/RenderPipeline/batcher/BatcherManager.ts

+import { RenderDataUsage } from "../enums/RenderDataUsage";
+import { Batcher2D } from "./Batcher2D";
+
+export class BatcherManager {


What is the value of this class?

future, i want handle all batch logic in batch function

GuoLei1990 · 2024-05-17T09:10:47Z

packages/core/src/RenderPipeline/batcher/MeshBuffer.ts

+/**
+ * @internal
+ */
+export class MeshBuffer {


Vague definition, and needs to be redesigned！！！！！！！！！

GuoLei1990 · 2024-05-17T09:13:00Z

packages/core/src/RenderPipeline/batcher/SpriteMaskBatcher.ts

+import { SpriteRenderData } from "../SpriteRenderData";
+import { Batcher2D } from "./Batcher2D";
+
+export class SpriteMaskBatcher extends Batcher2D {


Basically no design, may need to be rewritten

GuoLei1990 · 2024-05-17T09:42:56Z

packages/core/src/RenderPipeline/batcher/MeshBuffer.ts

+ */
+export class MeshBuffer {
+ /** @internal */
+ _mesh: BufferMesh;


Use Primitive

singlecoder added 4 commits August 21, 2023 20:12

refactor(renderpipeline): refactor framework

9c1b561

refactor(renderpipeline): opt code

a44de9e

refactor(renderpipeline): fix conflicts

d504369

refactor(renderpipeline): opt code

06c8e53

singlecoder added the engine label Aug 22, 2023

singlecoder requested review from GuoLei1990 and cptbtptpbcptdtptp August 22, 2023 07:10

singlecoder self-assigned this Aug 22, 2023

cptbtptpbcptdtptp reviewed Aug 28, 2023

View reviewed changes

singlecoder added 6 commits August 29, 2023 09:53

refactor(renderpipeline): opt code

60b240a

refactor(renderpipeline): fix conflicts

123dde4

refactor(renderpipeline): opt code

563bfbe

refactor(rederpipeline): opt code

a2a236b

refactor(renderpipeline): fix conflicts

bfd7435

refactor(renderpipeline): fix conflicts

51de522

singlecoder changed the base branch from dev/1.1 to main September 13, 2023 09:46

singlecoder added 8 commits September 13, 2023 17:51

refactor(renderpipeline): fix conflicts

88bb053

refactor(renderpipeline): fix conflicts

554b80a

refactor(renderpipeline): opt code

339f7eb

refactor(renderpipeline): merge code from main

c648e0c

refactor(renderpipeline): merge code from main

26308cf

refactor(2d): fix conflicts

28d9579

refactor(2d-render-pipeline): fix conflicts

139f247

Merge branch 'main' into refactor/2d-render-pipeline

a0ed23b

singlecoder added 3 commits May 9, 2024 19:01

refactor(2d-render-pipeline): opt code

999e348

Merge branch 'dev/1.3' into refactor/2d-render-pipeline

3710d41

refactor(2d-render-pipeline): fix shadow error

1714428

GuoLei1990 reviewed May 17, 2024

View reviewed changes

singlecoder added 8 commits May 21, 2024 09:36

refactor(2d-render-pipeline): opt code for simple assembler

09e975c

refactor(2d-render-pipeline): opt code for sprite assemble

bfb78bc

refactor(2d-render-pipeline): opt code

a35fc8f

refactor(2d-render-pipeline): opt code

169f3eb

refactor(2d-render-pipeline): opt code

436d4b1

refactor(2d-render-pipeline): opt code

ae911ae

refactor(2d-render-pipeline): opt code for batch

2621b7e

refactor(2d-render-pipeline): rename SpriteRenderData to RenderData2D

0b2b12d

Refactor 2d render pipeline #1708

Are you sure you want to change the base?

Refactor 2d render pipeline #1708

Conversation

singlecoder commented Aug 22, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cptbtptpbcptdtptp commented Aug 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuoLei1990 May 17, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

singlecoder commented Aug 22, 2023 •

edited

cptbtptpbcptdtptp commented Aug 28, 2023 •

edited

GuoLei1990 May 17, 2024 •

edited