Skip to content

Update ParticleRendererRegistry test to use a fully custom Particle #4885

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

Draft
Grauly wants to merge 3 commits into
base: 1.21.9
Choose a base branch
from
Draft

Update ParticleRendererRegistry test to use a fully custom Particle #4885

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1b1b1e
fix: fix ParticleRendererRegistryTests
Grauly Sep 25, 2025
e7b4517
chore: cleanup checkstyle issues
Grauly Sep 25, 2025
8a94571
refactor: remove unused sprite variable
Grauly Sep 25, 2025
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
139 changes: 125 additions & 14 deletions ...odClient/java/net/fabricmc/fabric/test/particle/client/ParticleRendererRegistryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,32 @@

package net.fabricmc.fabric.test.particle.client;

import java.util.Arrays;

import net.minecraft.client.MinecraftClient;
import net.minecraft.client.network.ClientPlayerEntity;
import net.minecraft.client.particle.BillboardParticle;
import net.minecraft.client.particle.BillboardParticleSubmittable;
import net.minecraft.client.particle.Particle;
import net.minecraft.client.particle.ParticleFactory;
import net.minecraft.client.particle.ParticleManager;
import net.minecraft.client.particle.ParticleRenderer;
import net.minecraft.client.particle.ParticleTextureSheet;
import net.minecraft.client.render.Camera;
import net.minecraft.client.render.Frustum;
import net.minecraft.client.render.LightmapTextureManager;
import net.minecraft.client.render.OverlayTexture;
import net.minecraft.client.render.RenderLayer;
import net.minecraft.client.render.Submittable;
import net.minecraft.client.texture.Sprite;
import net.minecraft.client.render.command.OrderedRenderCommandQueue;
import net.minecraft.client.render.state.CameraRenderState;
import net.minecraft.client.texture.SpriteAtlasTexture;
import net.minecraft.client.util.math.MatrixStack;
import net.minecraft.client.world.ClientWorld;
import net.minecraft.particle.SimpleParticleType;
import net.minecraft.registry.Registries;
import net.minecraft.registry.Registry;
import net.minecraft.util.Identifier;
import net.minecraft.util.math.MathHelper;
import net.minecraft.util.math.Vec3d;
import net.minecraft.util.math.random.Random;

import net.fabricmc.api.ClientModInitializer;
Expand Down Expand Up @@ -78,21 +85,17 @@ public void onInitializeClient() {
})));
}

private record TestParticleFactory(FabricSpriteProvider spriteProvider) implements ParticleFactory<SimpleParticleType> {
private record TestParticleFactory(
FabricSpriteProvider spriteProvider) implements ParticleFactory<SimpleParticleType> {
@Override
public Particle createParticle(SimpleParticleType parameters, ClientWorld world, double x, double y, double z, double velocityX, double velocityY, double velocityZ, Random random) {
return new TestParticle(world, x, y, z, velocityX, velocityY, velocityZ, spriteProvider.getSprite(random));
return new TestParticle(world, x, y, z, velocityX, velocityY, velocityZ);
}
}

private static class TestParticle extends BillboardParticle {
TestParticle(ClientWorld world, double x, double y, double z, double velocityX, double velocityY, double velocityZ, Sprite sprite) {
super(world, x, y, z, velocityX, velocityY, velocityZ, sprite);
}

@Override
protected RenderType getRenderType() {
return RenderType.field_62640;
private static class TestParticle extends Particle {
TestParticle(ClientWorld world, double x, double y, double z, double velocityX, double velocityY, double velocityZ) {
super(world, x, y, z, velocityX, velocityY, velocityZ);
}

@Override
Expand All @@ -103,10 +106,17 @@ public ParticleTextureSheet textureSheet() {
private boolean intersectPoint(Frustum frustum) {
return frustum.intersectPoint(x, y, z);
}

public void render(TestParticleSubmittable submittable, Camera camera, float tickProgress) {
double frameX = MathHelper.lerp(tickProgress, lastX, x) - camera.getPos().x;
double frameY = MathHelper.lerp(tickProgress, lastY, y) - camera.getPos().y;
double frameZ = MathHelper.lerp(tickProgress, lastZ, z) - camera.getPos().z;
submittable.addParticle(frameX, frameY, frameZ);
}
}

private static class TestParticleRenderer extends ParticleRenderer<TestParticle> {
final BillboardParticleSubmittable submittable = new BillboardParticleSubmittable();
final TestParticleSubmittable submittable = new TestParticleSubmittable();

TestParticleRenderer(ParticleManager particleManager) {
super(particleManager);
Expand All @@ -125,4 +135,105 @@ public Submittable render(Frustum frustum, Camera camera, float tickProgress) {
return submittable;
}
}

private static class TestParticleSubmittable implements Submittable {
private final TestParticlePositions positions = new TestParticlePositions();

@Override
public void submit(OrderedRenderCommandQueue queue, CameraRenderState cameraRenderState) {
MatrixStack matrices = new MatrixStack();

for (int i = 0; i < positions.getStoredPoints(); i++) {
matrices.push();
Vec3d position = positions.getPoint(i);

matrices.translate(position);

queue.submitCustom(
matrices,
//help: find a better way to do this
RenderLayer.getEntityCutout(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE),
(matrixEntry, vertexConsumer) -> {
//yes, this will render the entire atlas
//also is in the shape of a rectangle, a shape impossible to create with a BillboardParticle
vertexConsumer.vertex(matrixEntry, 0.5f, 0.0f, -1.0f)
.texture(1f, 1f)
.light(LightmapTextureManager.MAX_LIGHT_COORDINATE)
.overlay(OverlayTexture.DEFAULT_UV)
.color(-1)
.normal(matrixEntry, 0f, 1f, 0f);
vertexConsumer.vertex(matrixEntry, 0.5f, 0.0f, 1.0f)
.texture(0f, 1f)
.light(LightmapTextureManager.MAX_LIGHT_COORDINATE)
.overlay(OverlayTexture.DEFAULT_UV)
.color(-1)
.normal(matrixEntry, 0f, 1f, 0f);
vertexConsumer.vertex(matrixEntry, -0.5f, 0.0f, 1.0f)
.texture(0f, 0f)
.light(LightmapTextureManager.MAX_LIGHT_COORDINATE)
.overlay(OverlayTexture.DEFAULT_UV)
.color(-1)
.normal(matrixEntry, 0f, 1f, 0f);
vertexConsumer.vertex(matrixEntry, -0.5f, 0.0f, -1.0f)
.texture(1f, 0f)
.light(LightmapTextureManager.MAX_LIGHT_COORDINATE)
.overlay(OverlayTexture.DEFAULT_UV)
.color(-1)
.normal(matrixEntry, 0f, 1f, 0f);
}
);
matrices.pop();
}
}

@Override
public void onFrameEnd() {
positions.reset();
}

public void addParticle(double x, double y, double z) {
positions.addPoint(x, y, z);
}
}

private static class TestParticlePositions {
//note: this could be any kind of data, see BillboardParticleSubmittable for a more involved example
private int maxPoints = 128;
private double[] positionData = new double[maxPoints * 3];
private int nextVertexIndex = 0;

public void addPoint(double x, double y, double z) {
if (nextVertexIndex >= maxPoints) {
increaseCapacity();
}

int currentIndex = nextVertexIndex * 3;
positionData[currentIndex++] = x;
positionData[currentIndex++] = y;
positionData[currentIndex] = z;
++nextVertexIndex;
}

public Vec3d getPoint(int index) {
int lookupIndex = index * 3;
return new Vec3d(
positionData[lookupIndex++],
positionData[lookupIndex++],
positionData[lookupIndex]
);
}

public int getStoredPoints() {
return nextVertexIndex + 1;
}

public void reset() {
nextVertexIndex = 0;
}

private void increaseCapacity() {
maxPoints *= 2;
positionData = Arrays.copyOf(positionData, maxPoints * 3);
}
}
}
Loading