Skip to content

Commit 5341049

Browse files
shedanielsfPlayer1
authored andcommitted
fabric-rendering-v1 module & added HudRenderCallback (#359)
1 parent 175d0eb commit 5341049

File tree

18 files changed

+263
-13
lines changed

18 files changed

+263
-13
lines changed

fabric-rendering-v0/build.gradle

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
archivesBaseName = "fabric-rendering-v0"
2-
version = getSubprojectVersion(project, "1.0.1")
2+
version = getSubprojectVersion(project, "1.1.0")
33

44
dependencies {
55
compile project(path: ':fabric-api-base', configuration: 'dev')
6+
compile project(path: ':fabric-rendering-v1', configuration: 'dev')
67
}

fabric-rendering-v0/src/main/java/net/fabricmc/fabric/api/client/render/ColorProviderRegistry.java

+26-4
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,34 @@
2121
import net.minecraft.client.color.item.ItemColorProvider;
2222
import net.minecraft.item.ItemConvertible;
2323

24-
import net.fabricmc.fabric.impl.client.rendering.ColorProviderRegistryImpl;
25-
24+
/**
25+
* @deprecated Replaced by {@link net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry}
26+
*/
27+
@Deprecated
2628
public interface ColorProviderRegistry<T, Provider> {
27-
ColorProviderRegistry<ItemConvertible, ItemColorProvider> ITEM = ColorProviderRegistryImpl.ITEM;
29+
ColorProviderRegistry<ItemConvertible, ItemColorProvider> ITEM = new ColorProviderRegistry<ItemConvertible, ItemColorProvider>() {
30+
@Override
31+
public void register(ItemColorProvider itemColorProvider, ItemConvertible... objects) {
32+
net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry.ITEM.register(itemColorProvider, objects);
33+
}
34+
35+
@Override
36+
public ItemColorProvider get(ItemConvertible object) {
37+
return net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry.ITEM.get(object);
38+
}
39+
};
40+
41+
ColorProviderRegistry<Block, BlockColorProvider> BLOCK = new ColorProviderRegistry<Block, BlockColorProvider>() {
42+
@Override
43+
public void register(BlockColorProvider blockColorProvider, Block... objects) {
44+
net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry.BLOCK.register(blockColorProvider, objects);
45+
}
2846

29-
ColorProviderRegistry<Block, BlockColorProvider> BLOCK = ColorProviderRegistryImpl.BLOCK;
47+
@Override
48+
public BlockColorProvider get(Block object) {
49+
return net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry.BLOCK.get(object);
50+
}
51+
};
3052

3153
/**
3254
* Register a color provider for one or more objects.

fabric-rendering-v0/src/main/java/net/fabricmc/fabric/api/client/render/InvalidateRenderStateCallback.java

+3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@
2727
* <p>Render chunks and other render-related object instances will be made null
2828
* or invalid after this event so do not use it to capture dependent state.
2929
* Instead, use it to invalidate state and reinitialize lazily.
30+
*
31+
* @deprecated Replaced by {@link net.fabricmc.fabric.api.client.rendering.v1.InvalidateRenderStateCallback}
3032
*/
33+
@Deprecated
3134
public interface InvalidateRenderStateCallback {
3235
Event<InvalidateRenderStateCallback> EVENT = EventFactory.createArrayBacked(InvalidateRenderStateCallback.class,
3336
(listeners) -> () -> {
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package net.fabricmc.fabric.impl.client.rendering;
18+
19+
import net.fabricmc.api.ClientModInitializer;
20+
import net.fabricmc.fabric.api.client.rendering.v1.InvalidateRenderStateCallback;
21+
22+
public class RenderingCallbackInvoker implements ClientModInitializer {
23+
@Override
24+
public void onInitializeClient() {
25+
InvalidateRenderStateCallback.EVENT.register(() -> net.fabricmc.fabric.api.client.render.InvalidateRenderStateCallback.EVENT.invoker().onInvalidate());
26+
}
27+
}

fabric-rendering-v0/src/main/resources/fabric.mod.json

+8-5
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@
1515
"authors": [
1616
"FabricMC"
1717
],
18+
"entrypoints": {
19+
"client": [
20+
"net.fabricmc.fabric.impl.client.rendering.RenderingCallbackInvoker"
21+
]
22+
},
1823
"depends": {
1924
"fabricloader": ">=0.4.0",
2025
"minecraft": ">=1.15-alpha.19.39.a",
21-
"fabric-api-base": "*"
26+
"fabric-api-base": "*",
27+
"fabric-rendering-v1": "*"
2228
},
23-
"description": "Hooks and registries for rendering-related things.",
24-
"mixins": [
25-
"fabric-rendering-v0.mixins.json"
26-
]
29+
"description": "Hooks and registries for rendering-related things."
2730
}

fabric-rendering-v1/build.gradle

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
archivesBaseName = "fabric-rendering-v1"
2+
version = getSubprojectVersion(project, "0.1.0")
3+
4+
dependencies {
5+
compile project(path: ':fabric-api-base', configuration: 'dev')
6+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package net.fabricmc.fabric.api.client.rendering.v1;
18+
19+
import net.minecraft.block.Block;
20+
import net.minecraft.client.color.block.BlockColorProvider;
21+
import net.minecraft.client.color.item.ItemColorProvider;
22+
import net.minecraft.item.ItemConvertible;
23+
24+
import net.fabricmc.fabric.impl.client.rendering.ColorProviderRegistryImpl;
25+
26+
public interface ColorProviderRegistry<T, Provider> {
27+
ColorProviderRegistry<ItemConvertible, ItemColorProvider> ITEM = ColorProviderRegistryImpl.ITEM;
28+
29+
ColorProviderRegistry<Block, BlockColorProvider> BLOCK = ColorProviderRegistryImpl.BLOCK;
30+
31+
/**
32+
* Register a color provider for one or more objects.
33+
*
34+
* @param provider The color provider to register.
35+
* @param objects The objects which should be colored using this provider.
36+
*/
37+
void register(Provider provider, T... objects);
38+
39+
/**
40+
* Get a color provider for the given object.
41+
*
42+
* <p>Please note that the underlying registry may not be fully populated or stable until the game has started,
43+
* as other mods may overwrite the registry.
44+
*
45+
* @param object The object to acquire the provide for.
46+
* @return The registered mapper for this provider, or {@code null} if none is registered or available.
47+
*/
48+
Provider get(T object);
49+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package net.fabricmc.fabric.api.client.rendering.v1;
18+
19+
import net.fabricmc.fabric.api.event.Event;
20+
import net.fabricmc.fabric.api.event.EventFactory;
21+
22+
public interface HudRenderCallback {
23+
Event<HudRenderCallback> EVENT = EventFactory.createArrayBacked(HudRenderCallback.class, (listeners) ->
24+
(delta) -> {
25+
for (HudRenderCallback event : listeners) {
26+
event.onHudRender(delta);
27+
}
28+
});
29+
30+
/**
31+
* Called after rendering the whole hud, which is displayed in game, in a world.
32+
*
33+
* @param tickDelta Progress for linearly interpolating between the previous and current game state
34+
*/
35+
void onHudRender(float tickDelta);
36+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/*
2+
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package net.fabricmc.fabric.api.client.rendering.v1;
18+
19+
import net.fabricmc.fabric.api.event.Event;
20+
import net.fabricmc.fabric.api.event.EventFactory;
21+
22+
/**
23+
* Called when the world renderer reloads, usually as result of changing resource pack
24+
* or video configuration, or when the player types F3+A in the debug screen.
25+
* Afterwards all render chunks will be reset and reloaded.
26+
*
27+
* <p>Render chunks and other render-related object instances will be made null
28+
* or invalid after this event so do not use it to capture dependent state.
29+
* Instead, use it to invalidate state and reinitialize lazily.
30+
*/
31+
public interface InvalidateRenderStateCallback {
32+
Event<InvalidateRenderStateCallback> EVENT = EventFactory.createArrayBacked(InvalidateRenderStateCallback.class,
33+
(listeners) -> () -> {
34+
for (InvalidateRenderStateCallback event : listeners) {
35+
event.onInvalidate();
36+
}
37+
}
38+
);
39+
40+
void onInvalidate();
41+
}

fabric-rendering-v0/src/main/java/net/fabricmc/fabric/impl/client/rendering/ColorProviderRegistryImpl.java fabric-rendering-v1/src/main/java/net/fabricmc/fabric/impl/client/rendering/ColorProviderRegistryImpl.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import net.minecraft.client.color.item.ItemColors;
2727
import net.minecraft.item.ItemConvertible;
2828

29-
import net.fabricmc.fabric.api.client.render.ColorProviderRegistry;
29+
import net.fabricmc.fabric.api.client.rendering.v1.ColorProviderRegistry;
3030

3131
public abstract class ColorProviderRegistryImpl<T, Provider, Underlying> implements ColorProviderRegistry<T, Provider> {
3232
public static final ColorProviderRegistryImpl<Block, BlockColorProvider, BlockColors> BLOCK = new ColorProviderRegistryImpl<Block, BlockColorProvider, BlockColors>() {
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package net.fabricmc.fabric.mixin.client.rendering;
18+
19+
import org.spongepowered.asm.mixin.Mixin;
20+
import org.spongepowered.asm.mixin.injection.At;
21+
import org.spongepowered.asm.mixin.injection.Inject;
22+
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
23+
24+
import net.minecraft.client.gui.hud.InGameHud;
25+
26+
import net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback;
27+
28+
@Mixin(InGameHud.class)
29+
public class MixinInGameHud {
30+
@Inject(method = "render", at = @At(value = "RETURN", shift = At.Shift.BY, by = -6))
31+
public void render(float tickDelta, CallbackInfo callbackInfo) {
32+
HudRenderCallback.EVENT.invoker().onHudRender(tickDelta);
33+
}
34+
}

fabric-rendering-v0/src/main/java/net/fabricmc/fabric/mixin/client/rendering/MixinWorldRenderer.java fabric-rendering-v1/src/main/java/net/fabricmc/fabric/mixin/client/rendering/MixinWorldRenderer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
import net.minecraft.client.render.WorldRenderer;
2525

26-
import net.fabricmc.fabric.api.client.render.InvalidateRenderStateCallback;
26+
import net.fabricmc.fabric.api.client.rendering.v1.InvalidateRenderStateCallback;
2727

2828
@Mixin(WorldRenderer.class)
2929
public abstract class MixinWorldRenderer {
Loading

fabric-rendering-v0/src/main/resources/fabric-rendering-v0.mixins.json fabric-rendering-v1/src/main/resources/fabric-rendering-v1.mixins.json

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"compatibilityLevel": "JAVA_8",
55
"client": [
66
"MixinBlockColorMap",
7+
"MixinInGameHud",
78
"MixinItemColorMap",
89
"MixinWorldRenderer"
910
],
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"schemaVersion": 1,
3+
"id": "fabric-rendering-v1",
4+
"name": "Fabric Rendering (v1)",
5+
"version": "${version}",
6+
"environment": "client",
7+
"license": "Apache-2.0",
8+
"icon": "assets/fabric-rendering-v1/icon.png",
9+
"contact": {
10+
"homepage": "https://fabricmc.net",
11+
"irc": "irc://irc.esper.net:6667/fabric",
12+
"issues": "https://github.com/FabricMC/fabric/issues",
13+
"sources": "https://github.com/FabricMC/fabric"
14+
},
15+
"authors": [
16+
"FabricMC"
17+
],
18+
"depends": {
19+
"fabricloader": ">=0.4.0",
20+
"fabric-api-base": "*"
21+
},
22+
"description": "Hooks and registries for rendering-related things.",
23+
"mixins": [
24+
"fabric-rendering-v1.mixins.json"
25+
]
26+
}

settings.gradle

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ include 'fabric-renderer-api-v1'
3636
include 'fabric-renderer-indigo'
3737
include 'fabric-renderer-registries-v1'
3838
include 'fabric-rendering-v0'
39+
include 'fabric-rendering-v1'
3940
include 'fabric-rendering-data-attachment-v1'
4041
include 'fabric-rendering-fluids-v1'
4142
include 'fabric-resource-loader-v0'
4243
include 'fabric-tag-extensions-v0'
4344
include 'fabric-textures-v0'
44-
include 'fabric-dimensions-v1'
45+
include 'fabric-dimensions-v1'

0 commit comments

Comments
 (0)