Render State Data Extraction #5235
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * Copyright (c) 2016, 2017, 2018, 2019 FabricMC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package net.fabricmc.fabric.api.client.rendering.v1; | ||
|
|
||
| public interface FabricEntityRenderer { | ||
| default void addExtractor(RenderStateDataExtractor extractor) { | ||
| throw new UnsupportedOperationException("Implemented via mixin"); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Copyright (c) 2016, 2017, 2018, 2019 FabricMC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package net.fabricmc.fabric.api.client.rendering.v1; | ||
|
|
||
| import net.minecraft.client.renderer.entity.EntityRendererProvider; | ||
| import net.minecraft.client.renderer.entity.state.EntityRenderState; | ||
| import net.minecraft.world.entity.Entity; | ||
|
|
||
| public abstract class RenderStateDataExtractor { | ||
Ramixin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| public RenderStateDataExtractor(EntityRendererProvider.Context context) { | ||
|
Check failure on line 25 in fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/RenderStateDataExtractor.java
|
||
|
|
||
| } | ||
|
|
||
| public abstract void extract(Entity entity, EntityRenderState state); | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package net.fabricmc.fabric.api.client.rendering.v1; | ||
|
|
||
| import java.util.List; | ||
| import java.util.function.Function; | ||
|
|
||
| import org.jetbrains.annotations.ApiStatus; | ||
|
|
||
| import net.minecraft.client.renderer.entity.EntityRenderer; | ||
| import net.minecraft.client.renderer.entity.EntityRendererProvider; | ||
| import net.minecraft.world.entity.EntityType; | ||
|
|
||
| import net.fabricmc.fabric.api.event.Event; | ||
| import net.fabricmc.fabric.api.event.EventFactory; | ||
|
|
||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| public interface RenderStateExtractionCallback { | ||
Ramixin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Event<RenderStateExtractionCallback> EVENT = EventFactory.createArrayBacked( | ||
| RenderStateExtractionCallback.class, listeners -> ctx -> { | ||
| for (RenderStateExtractionCallback callback : listeners) { | ||
| callback.onRenderStateExtraction(ctx); | ||
| for (Function<EntityRendererProvider.Context, RenderStateDataExtractor> factory : ctx.factories()) { | ||
| ctx.renderer().addExtractor(factory.apply(ctx.rendererContext())); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| void onRenderStateExtraction(RenderStateExtractionCallback.Context ctx); | ||
|
|
||
| @ApiStatus.NonExtendable | ||
| interface Context { | ||
|
|
||
| @Nullable EntityType<?> type(); | ||
|
|
||
| EntityRenderer<?, ?> renderer(); | ||
|
|
||
| EntityRendererProvider.Context rendererContext(); | ||
|
|
||
| void add(Function<EntityRendererProvider.Context, RenderStateDataExtractor> extractorFactory); | ||
Ramixin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| List<Function<EntityRendererProvider.Context, RenderStateDataExtractor>> factories(); | ||
Ramixin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package net.fabricmc.fabric.impl.client.rendering; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.function.Function; | ||
|
|
||
| import net.minecraft.client.renderer.entity.EntityRenderer; | ||
| import net.minecraft.client.renderer.entity.EntityRendererProvider; | ||
| import net.minecraft.world.entity.EntityType; | ||
|
|
||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateDataExtractor; | ||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateExtractionCallback; | ||
|
|
||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| public record RenderStateExtractionCallbackContextImpl(@Nullable EntityType<?> type, EntityRenderer<?, ?> renderer, EntityRendererProvider.Context rendererContext, ArrayList<Function<EntityRendererProvider.Context, RenderStateDataExtractor>> factories) implements RenderStateExtractionCallback.Context { | ||
| @Override | ||
| public void add(Function<EntityRendererProvider.Context, RenderStateDataExtractor> extractorFactory) { | ||
| factories.add(extractorFactory); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| * Copyright (c) 2016, 2017, 2018, 2019 FabricMC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package net.fabricmc.fabric.mixin.client.rendering; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.spongepowered.asm.mixin.Mixin; | ||
| import org.spongepowered.asm.mixin.Unique; | ||
| import org.spongepowered.asm.mixin.injection.At; | ||
| import org.spongepowered.asm.mixin.injection.Inject; | ||
| import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; | ||
|
|
||
| import net.minecraft.client.renderer.entity.EntityRenderer; | ||
| import net.minecraft.client.renderer.entity.state.EntityRenderState; | ||
| import net.minecraft.world.entity.Entity; | ||
|
|
||
| import net.fabricmc.fabric.api.client.rendering.v1.FabricEntityRenderer; | ||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateDataExtractor; | ||
|
|
||
| @Mixin(EntityRenderer.class) | ||
| public abstract class EntityRendererMixin<T extends Entity, S extends EntityRenderState> implements FabricEntityRenderer { | ||
| @Unique | ||
| private final List<RenderStateDataExtractor> renderStateExtractors = new ArrayList<>(); | ||
|
|
||
| @Inject(method = "extractRenderState", at = @At("TAIL")) | ||
| private void runRenderStateExtractors(T entity, S state, float partialTicks, CallbackInfo ci) { | ||
| for (RenderStateDataExtractor extractor : renderStateExtractors) { | ||
| extractor.extract(entity, state); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void addExtractor(RenderStateDataExtractor extractor) { | ||
| renderStateExtractors.add(extractor); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * Copyright (c) 2016, 2017, 2018, 2019 FabricMC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package net.fabricmc.fabric.test.rendering.client; | ||
|
|
||
| import com.mojang.blaze3d.vertex.PoseStack; | ||
|
|
||
| import net.fabricmc.fabric.api.client.rendering.v1.LivingEntityRenderLayerRegistrationCallback; | ||
|
|
||
| import net.fabricmc.fabric.api.client.rendering.v1.ModelLayerRegistry; | ||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateDataExtractor; | ||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateDataKey; | ||
|
|
||
| import net.fabricmc.fabric.api.client.rendering.v1.RenderStateExtractionCallback; | ||
|
|
||
| import net.minecraft.client.renderer.entity.EntityRendererProvider; | ||
| import net.minecraft.client.renderer.entity.state.EntityRenderState; | ||
| import net.minecraft.world.entity.Entity; | ||
|
|
||
| import net.minecraft.world.entity.LivingEntity; | ||
|
|
||
| import org.jspecify.annotations.NonNull; | ||
|
|
||
| import net.minecraft.client.model.Model; | ||
| import net.minecraft.client.model.geom.EntityModelSet; | ||
| import net.minecraft.client.model.geom.ModelLayerLocation; | ||
| import net.minecraft.client.model.geom.ModelPart; | ||
| import net.minecraft.client.model.geom.PartPose; | ||
| import net.minecraft.client.model.geom.builders.CubeDeformation; | ||
| import net.minecraft.client.model.geom.builders.CubeListBuilder; | ||
| import net.minecraft.client.model.geom.builders.LayerDefinition; | ||
| import net.minecraft.client.model.geom.builders.MeshDefinition; | ||
| import net.minecraft.client.model.geom.builders.PartDefinition; | ||
| import net.minecraft.client.model.player.PlayerModel; | ||
| import net.minecraft.client.renderer.SubmitNodeCollector; | ||
| import net.minecraft.client.renderer.entity.LivingEntityRenderer; | ||
| import net.minecraft.client.renderer.entity.RenderLayerParent; | ||
| import net.minecraft.client.renderer.entity.layers.RenderLayer; | ||
| import net.minecraft.client.renderer.entity.player.AvatarRenderer; | ||
| import net.minecraft.client.renderer.entity.state.AvatarRenderState; | ||
| import net.minecraft.client.renderer.rendertype.RenderTypes; | ||
| import net.minecraft.resources.Identifier; | ||
|
|
||
| import net.fabricmc.api.ClientModInitializer; | ||
|
|
||
| /** | ||
| * Renders a small red cube in front of the player's chest when in f5. The cube's | ||
| * transparency is determined by the player's health percentage. | ||
| * | ||
| * <p> | ||
| * Tests: | ||
| * <ul> | ||
| * <li>{@link RenderStateExtractionCallback}</li> | ||
| * </ul> | ||
| * | ||
| * <p> | ||
| * Assumes the following work as intended: | ||
| * <ul> | ||
| * <li>{@link ModelLayerRegistry}</li> | ||
| * <li>{@link RenderStateDataKey}</li> | ||
| * <li>{@link LivingEntityRenderLayerRegistrationCallback}</li> | ||
| * </ul> | ||
| */ | ||
| public class RenderStateDataExtractionTest implements ClientModInitializer { | ||
| public static final ModelLayerLocation TEST_MODEL_LOCATION = new ModelLayerLocation(Identifier.fromNamespaceAndPath("fabric", "test_rse_model"), "test_rse_model"); | ||
|
|
||
| public static final RenderStateDataKey<Float> PLAYER_HEALTH_PERCENTAGE = RenderStateDataKey.create(() -> "Test RSE: Player Health Percentage"); | ||
|
|
||
| @Override | ||
| public void onInitializeClient() { | ||
| ModelLayerRegistry.registerModelLayer(TEST_MODEL_LOCATION, TestModel::createLayer); | ||
|
|
||
| LivingEntityRenderLayerRegistrationCallback.EVENT.register((_, entityRenderer, registrationHelper, context) -> { | ||
| if (entityRenderer instanceof AvatarRenderer<?> avatarRenderer) { | ||
| registrationHelper.register(new TestRenderLayer(avatarRenderer, context.getModelSet())); | ||
| } | ||
| }); | ||
|
|
||
| RenderStateExtractionCallback.EVENT.register(context -> { | ||
| if (context.renderer() instanceof AvatarRenderer<?>) { | ||
| context.add(TestExtractor::new); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| public static class TestRenderLayer extends RenderLayer<AvatarRenderState, PlayerModel> { | ||
| private final TestModel model; | ||
|
|
||
| public TestRenderLayer(RenderLayerParent<AvatarRenderState, PlayerModel> renderer, final EntityModelSet modelSet) { | ||
| super(renderer); | ||
| this.model = new TestModel(modelSet.bakeLayer(TEST_MODEL_LOCATION)); | ||
| } | ||
|
|
||
| @Override | ||
| public void submit(@NonNull PoseStack poseStack, @NonNull SubmitNodeCollector submitNodeCollector, int lightCoords, AvatarRenderState state, float yRot, float xRot) { | ||
| int overlayCoords = LivingEntityRenderer.getOverlayCoords(state, 0.0F); | ||
| float healthPercentage = state.getDataOrDefault(PLAYER_HEALTH_PERCENTAGE, 0f); | ||
| int tint = (int) (healthPercentage * 255) << 24 | 0x00FF0000; | ||
| submitNodeCollector.submitModel(model, state, poseStack, RenderTypes.entityTranslucent(Identifier.fromNamespaceAndPath("minecraft", "textures/block/diamond_block.png")), lightCoords, overlayCoords, tint, null, state.outlineColor, null); | ||
| } | ||
| } | ||
|
|
||
| public static class TestModel extends Model<AvatarRenderState> { | ||
| public TestModel(ModelPart root) { | ||
| super(root, RenderTypes::entityTranslucent); | ||
| } | ||
|
|
||
| public static LayerDefinition createLayer() { | ||
| MeshDefinition mesh = PlayerModel.createMesh(CubeDeformation.NONE, false); | ||
| PartDefinition root = mesh.getRoot().clearRecursively(); | ||
| PartDefinition head = root.getChild("body"); | ||
|
|
||
| CubeListBuilder cube = CubeListBuilder.create().addBox(-4, 2, -12, 8, 8, 8); | ||
| head.addOrReplaceChild("fabric:test_rse_model", cube, PartPose.ZERO); | ||
| return LayerDefinition.create(mesh, 16, 16); | ||
| } | ||
| } | ||
|
|
||
| public static class TestExtractor extends RenderStateDataExtractor { | ||
|
|
||
| public TestExtractor(EntityRendererProvider.Context context) { | ||
| super(context); | ||
| } | ||
|
|
||
| @Override | ||
| public void extract(Entity entity, EntityRenderState state) { | ||
| LivingEntity livingEntity = (LivingEntity) entity; | ||
| state.setData(PLAYER_HEALTH_PERCENTAGE, livingEntity.getHealth() / livingEntity.getMaxHealth()); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.