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

Jump to bottom

feat: allow for custom batchers #10885

Merged
merged 13 commits into from
Sep 11, 2024
Merged

feat: allow for custom batchers #10885

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1d48941
make batcher generic
GoodBoyDigital Aug 23, 2024
95444db
fix up batchers to be installable from extensions
GoodBoyDigital Sep 3, 2024
97df2b2
fix imports
GoodBoyDigital Sep 3, 2024
badae91
Merge branch 'dev' into chore/remove-pack-attributes
GoodBoyDigital Sep 3, 2024
bbf2d7f
include hidden files
Zyie Sep 4, 2024
dfa6977
fix batch bounds
GoodBoyDigital Sep 4, 2024
82f772e
add a final color for consistency
GoodBoyDigital Sep 4, 2024
093d7ff
chore: fix up batch property names (#10909)
GoodBoyDigital Sep 9, 2024
cf1f80c
feedback
GoodBoyDigital Sep 9, 2024
358df3a
fix test typos
GoodBoyDigital Sep 9, 2024
1c8ff27
fix test
GoodBoyDigital Sep 9, 2024
748ad1d
Update src/scene/graphics/shared/GraphicsContextSystem.ts
Zyie Sep 10, 2024
9210fd9
update docs
Zyie Sep 11, 2024
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
Next Next commit
make batcher generic
  • Loading branch information
@GoodBoyDigital
GoodBoyDigital committed Aug 23, 2024
commit 1d48941cb00bd0a8183c59943a14dbc71d58ce59
172 changes: 138 additions & 34 deletions src/rendering/batcher/shared/Batcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import { type BLEND_MODES } from '../../renderers/shared/state/const';
import { getAdjustedBlendModeBlend } from '../../renderers/shared/state/getAdjustedBlendModeBlend';
import { getMaxTexturesPerBatch } from '../gl/utils/maxRecommendedTextures';
import { BatchTextureArray } from './BatchTextureArray';
import { DefaultBatcher } from './DefaultBatcher';

import type { Matrix } from '../../../maths/matrix/Matrix';
import type { ViewContainer } from '../../../scene/view/View';
import type { BindGroup } from '../../renderers/gpu/shader/BindGroup';
import type { IndexBufferArray } from '../../renderers/shared/geometry/Geometry';
import type { Instruction } from '../../renderers/shared/instructions/Instruction';
Expand Down Expand Up @@ -73,30 +76,54 @@ function returnBatchToPool(batch: Batch)
{
batchPool[batchPoolIndex++] = batch;
}
export interface BatchableObject

export interface BatchableElement
GoodBoyDigital marked this conversation as resolved.
Show resolved Hide resolved
{
indexStart: number;
// what batcher to use, must be registered.
batcherName: string;

packAttributes: (
float32View: Float32Array,
uint32View: Uint32Array,
index: number,
textureId: number,
) => void;
packIndex: (indexBuffer: IndexBufferArray, index: number, indicesOffset: number) => void;
color: number;

texture: Texture;
blendMode: BLEND_MODES;
vertexSize: number;

indexSize: number;

attributeOffset: number;
attributeSize: number;

// used internally by batcher specific..
location: number;
indexStart: number;

// stored for efficient updating..
textureId: number;
location: number; // location in the buffer
roundPixels: 0 | 1;
attributeStart: number; // location in the buffer
batcher: Batcher;
batch: Batch;

roundPixels: 0 | 1;
// sprite specific optimizations
// packing a quad will give better perf!
packAsQuad: boolean;

}

export interface BatchableQuadElement extends BatchableElement
{
renderable: ViewContainer; // TODO only used with sprite batch..
}

export interface BatchableMeshElement extends BatchableElement
{
groupTransform: Matrix;

// buffer data..
uvs: number[] | Float32Array;
positions: number[] | Float32Array;
indices: number[] | Uint16Array | Uint32Array;

indexOffset: number;
}

let BATCH_TICK = 0;
Expand Down Expand Up @@ -133,19 +160,19 @@ export class Batcher
public indexBuffer: IndexBufferArray;

public attributeSize: number;
public attributeStart: number;
public indexSize: number;
public elementSize: number;
public elementStart: number;

public dirty = true;

public activeBatcher = new DefaultBatcher();

public batchIndex = 0;
public batches: Batch[] = [];

// specifics.
private readonly _vertexSize: number = 6;

private _elements: BatchableObject[] = [];
private _elements: BatchableElement[] = [];

private _batchIndexStart: number;
private _batchIndexSize: number;
Expand All @@ -160,7 +187,7 @@ export class Batcher

const { vertexSize, indexSize, maxTextures } = options;

this.attributeBuffer = new ViewableBuffer(vertexSize * this._vertexSize * 4);
this.attributeBuffer = new ViewableBuffer(vertexSize * 6 * 4);

this.indexBuffer = new Uint16Array(indexSize);

Expand All @@ -173,6 +200,7 @@ export class Batcher
this.elementStart = 0;
this.indexSize = 0;
this.attributeSize = 0;
this.attributeStart = 0;

for (let i = 0; i < this.batchIndex; i++)
{
Expand All @@ -186,19 +214,21 @@ export class Batcher
this.dirty = true;
}

public add(batchableObject: BatchableObject)
public add(batchableObject: BatchableElement)
{
this._elements[this.elementSize++] = batchableObject;

batchableObject.indexStart = this.indexSize;
batchableObject.location = this.attributeSize;
batchableObject.attributeStart = this.attributeSize;
batchableObject.batcher = this;
batchableObject.location = this.attributeStart;

this.indexSize += batchableObject.indexSize;
this.attributeSize += ((batchableObject.vertexSize) * this._vertexSize);
this.attributeStart += batchableObject.attributeSize;
this.attributeSize += ((batchableObject.attributeSize) * this.activeBatcher.attributeSize);
}

public checkAndUpdateTexture(batchableObject: BatchableObject, texture: Texture): boolean
public checkAndUpdateTexture(batchableObject: BatchableElement, texture: Texture): boolean
{
const textureId = batchableObject.batch.textures.ids[texture._source.uid];

Expand All @@ -212,14 +242,26 @@ export class Batcher
return true;
}

public updateElement(batchableObject: BatchableObject)
public updateElement(batchableObject: BatchableElement)
{
this.dirty = true;

batchableObject.packAttributes(
this.attributeBuffer.float32View,
this.attributeBuffer.uint32View,
batchableObject.location, batchableObject.textureId);
if (batchableObject.packAsQuad)
{
this.activeBatcher.packQuadAttributes(
batchableObject as BatchableQuadElement,
this.attributeBuffer.float32View,
this.attributeBuffer.uint32View,
batchableObject.attributeStart, batchableObject.textureId);
}
else
{
this.activeBatcher.packAttributes(
batchableObject as BatchableMeshElement,
this.attributeBuffer.float32View,
this.attributeBuffer.uint32View,
batchableObject.attributeStart, batchableObject.textureId);
}
}

/**
Expand All @@ -229,7 +271,6 @@ export class Batcher
*/
public break(instructionSet: InstructionSet)
{
// ++BATCH_TICK;
const elements = this._elements;

// length 0??!! (we broke without adding anything)
Expand All @@ -242,6 +283,7 @@ export class Batcher

const firstElement = elements[this.elementStart];
let blendMode = getAdjustedBlendModeBlend(firstElement.blendMode, firstElement.texture._source);
let batcherName = firstElement.batcherName;

if (this.attributeSize * 4 > this.attributeBuffer.size)
{
Expand All @@ -264,6 +306,8 @@ export class Batcher

const maxTextures = this.maxTextures;

const activeBatcher = this.activeBatcher;

for (let i = this.elementStart; i < this.elementSize; ++i)
{
const element = elements[i];
Expand All @@ -275,15 +319,33 @@ export class Batcher

const adjustedBlendMode = getAdjustedBlendModeBlend(element.blendMode, source);

const blendModeChange = blendMode !== adjustedBlendMode;
const breakRequired = blendMode !== adjustedBlendMode || batcherName !== element.batcherName;

if (source._batchTick === BATCH_TICK && !blendModeChange)
if (source._batchTick === BATCH_TICK && !breakRequired)
{
element.textureId = source._textureBindLocation;

size += element.indexSize;
element.packAttributes(f32, u32, element.location, element.textureId);
element.packIndex(iBuffer, element.indexStart, element.location / this._vertexSize);

if (element.packAsQuad)
{
activeBatcher.packQuadAttributes(
element as BatchableQuadElement,
f32, u32,
element.attributeStart, element.textureId
);
this.packQuadIndex(iBuffer, element.indexStart, element.location);
}
else
{
activeBatcher.packAttributes(
element as BatchableMeshElement,
f32, u32,
element.attributeStart,
element.textureId
);
this.packIndex(element as BatchableMeshElement, iBuffer, element.indexStart, element.location);
}

element.batch = batch;

Expand All @@ -292,7 +354,7 @@ export class Batcher

source._batchTick = BATCH_TICK;

if (textureBatch.count >= maxTextures || blendModeChange)
if (textureBatch.count >= maxTextures || breakRequired)
{
this._finishBatch(
batch,
Expand All @@ -308,6 +370,7 @@ export class Batcher
start = size;
// create a batch...
blendMode = adjustedBlendMode;
batcherName = element.batcherName;

batch = getBatchFromPool();
textureBatch = batch.textures;
Expand All @@ -322,8 +385,25 @@ export class Batcher
element.batch = batch;

size += element.indexSize;
element.packAttributes(f32, u32, element.location, element.textureId);
element.packIndex(iBuffer, element.indexStart, element.location / this._vertexSize);

if (element.packAsQuad)
{
activeBatcher.packQuadAttributes(
element as BatchableQuadElement,
f32, u32,
element.attributeStart, element.textureId
);
this.packQuadIndex(iBuffer, element.indexStart, element.location);
}
else
{
activeBatcher.packAttributes(element as BatchableMeshElement,
f32, u32,
element.attributeStart, element.textureId
);

this.packIndex(element as BatchableMeshElement, iBuffer, element.indexStart, element.location);
}
}

if (textureBatch.count > 0)
Expand Down Expand Up @@ -443,6 +523,30 @@ export class Batcher
this.indexBuffer = newIndexBuffer;
}

public packQuadIndex(indexBuffer: IndexBufferArray, index: number, indicesOffset: number)
{
indexBuffer[index] = indicesOffset + 0;
indexBuffer[index + 1] = indicesOffset + 1;
indexBuffer[index + 2] = indicesOffset + 2;

indexBuffer[index + 3] = indicesOffset + 0;
indexBuffer[index + 4] = indicesOffset + 2;
indexBuffer[index + 5] = indicesOffset + 3;
}

public packIndex(element: BatchableMeshElement, indexBuffer: IndexBufferArray, index: number, indicesOffset: number)
{
const indices = element.indices;
const size = element.indexSize;
const indexOffset = element.indexOffset;
const attributeOffset = element.attributeOffset;

for (let i = 0; i < size; i++)
{
indexBuffer[index++] = indicesOffset + indices[i + indexOffset] - attributeOffset;
}
}

public destroy()
{
for (let i = 0; i < this.batches.length; i++)
Expand Down
4 changes: 2 additions & 2 deletions src/rendering/batcher/shared/BatcherPipe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { Geometry } from '../../renderers/shared/geometry/Geometry';
import type { InstructionSet } from '../../renderers/shared/instructions/InstructionSet';
import type { BatchPipe, InstructionPipe } from '../../renderers/shared/instructions/RenderPipe';
import type { Renderer } from '../../renderers/types';
import type { Batch, BatchableObject } from './Batcher';
import type { Batch, BatchableElement } from './Batcher';

export interface BatcherAdaptor
{
Expand Down Expand Up @@ -65,7 +65,7 @@ export class BatcherPipe implements InstructionPipe<Batch>, BatchPipe
this._activeBatch.begin();
}

public addToBatch(batchableObject: BatchableObject)
public addToBatch(batchableObject: BatchableElement)
{
this._activeBatch.add(batchableObject);
}
Expand Down
Loading
Loading