Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715

FiniteReality · 2024-11-27T17:29:02Z

This needed a small change to mod loading: it has been separated into two separate methods instead of the one ClientModLoader.begin to enable configuring the render target.

The API I've implemented here is somewhat a placeholder, but ideally we would be able to add additional methods for things like additional color attachments, or potentially listeners for when the render target gets resized.

neoforged-pr-publishing · 2024-11-27T17:29:18Z

Publish PR to GitHub Packages

Last commit published: b6c5afb4f75acb87ba2c3281b71533d21de2f53f.

PR Publishing

The artifacts published by this PR:

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1715' // https://github.com/neoforged/NeoForge/pull/1715
        url 'https://prmaven.neoforged.net/NeoForge/pr1715'
        content {
            includeModule('net.neoforged', 'testframework')
            includeModule('net.neoforged', 'neoforge')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1715.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1715
cd NeoForge-pr1715
curl -L https://prmaven.neoforged.net/NeoForge/pr1715/net/neoforged/neoforge/21.4.21-beta-pr-1715-feature-depth-stenciling/mdk-pr1715.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

patches/net/minecraft/client/renderer/PostPass.java.patch

embeddedt · 2024-11-30T18:50:09Z

patches/net/minecraft/client/renderer/PostChain.java.patch

+             RenderTargetDescriptor rendertargetdescriptor = switch (entry.getValue()) {
+                 case PostChainConfig.FixedSizedTarget(int i, int j) -> {
+-                    yield new RenderTargetDescriptor(i, j, true);
+                    yield new RenderTargetDescriptor(i, j, useDepth, useStencil);


Since vanilla always enables depth should we do the same?

Since shaders targeting vanilla only work on the main render target, which has depth enabled, this should effectively be the same - It should only be different if somebody tries to set up a render target with depth disabled which I feel is unlikely to happen anyway

shartte · 2024-12-06T19:30:04Z

src/main/java/net/neoforged/neoforge/client/event/ConfigureMainRenderTargetEvent.java

+ * This event is fired on the mod-speciffic event bus, only on the {@linkplain LogicalSide#CLIENT logical client}.
+ */
+public class ConfigureMainRenderTargetEvent extends Event implements IModBusEvent {
+    private boolean useDepth;


I'd remove this if it cannot be set to false (and why would it be possible to do so)

The reason why I kept it is because vanilla doesn't exactly use the depth buffer themselves*, so they may change it to false in The Future:tm: for VRAM purposes. Furthermore, it allows mods to be explicit about whether they need the depth information to be written. (I see as this a good thing)

The defaults are basically lifted from vanilla code currently, though it may be better to inline them where the event is actually constructed

I'd not keep this "in reserve" in the API. If Vanilla does add it, we can re-add it then.

This functionality should be removed for now. We can re-assess if Mojang changes something or there is a formal feature request to allow it.

Instead of removing it completely, I instead changed the patch to pass this boolean, as well as the desired width and height to the event. As we always pass true, I made it final and removed the set/enable method.

shartte · 2024-12-06T19:30:52Z

patches/com/mojang/blaze3d/pipeline/RenderTarget.java.patch

+
+        if (!useDepth && useStencil) {
+            var capabilities = org.lwjgl.opengl.GL.getCapabilities();
+            if (!capabilities.GL_ARB_texture_stencil8 && !capabilities.OpenGL44) {
+                throw new UnsupportedOperationException("Stencil-only buffers require GL_ARB_texture_stencil8 OR OpenGL 4.4");
+            }
+        }


Is there a use-case for this or is this going to be effectively dead code?

OpenGL technically supports it, and it's a supported combination of parameters, so rather than getting a confusing error about framebuffer completeness with no exception, I'd rather throw an exception beforehand.

You are correct though, in that the average user would probably not hit this branch

If this is perf-critical code I would suggest dropping this check. Presumably the modder raising the incorrect flag combo would see a breakage elsewhere.

If not, we can keep it for informative purposes.

It's not performance critical, as it's only checked on construct. As far as I'm aware, vanilla prefers to reuse render targets rather than re-create them every frame.

patches/com/mojang/blaze3d/pipeline/RenderTarget.java.patch

neoforged-automation · 2024-12-08T15:07:37Z

@FiniteReality, this pull request has conflicts, please resolve them for this PR to move forward.

patches/net/minecraft/client/renderer/PostChain.java.patch

…nTarget configuration event

FiniteReality · 2024-12-09T09:42:16Z

patches/net/minecraft/client/renderer/PostPass.java.patch

+     @OnlyIn(Dist.CLIENT)
+-    public static record TargetInput(String samplerName, ResourceLocation targetId, boolean depthBuffer, boolean bilinear) implements PostPass.Input {
+    public static record TargetInput(String samplerName, ResourceLocation targetId, BufferType bufferType, boolean bilinear) implements PostPass.Input {
+        public enum BufferType {


Question: should this be @OnlyIn too, or should we move it to another type? This was the suggestion by @embeddedt to combine the separate bools into a single enum

Technici4n

I think that the overall strategy is sound, but I would remove all of the patches to make depth disable-able. That will already reduce the amount of patching by quite a bit. I would try to reduce the patch size even further. Finally, might be nice to reactivate StencilEnableTest to at least validate that enabling the stencil buffer won't cause everything to blow up.

XFactHD · 2024-12-09T20:00:41Z

patches/com/mojang/blaze3d/framegraph/FrameGraphBuilder.java.patch

+         }
+
+        @Nullable
+        public abstract ResourceDescriptor<T> getDescriptor();


This method needs to not be abstract and instead return null by default.

XFactHD · 2024-12-09T20:03:25Z

patches/net/minecraft/client/renderer/PostChain.java.patch

+                    useDepth |= renderDescriptor.useDepth();
+                    useStencil |= renderDescriptor.useStencil();
+            } else {
+                useDepth |= p_361871_.get(resourcelocation).get().useDepth;


Is there any reason to look this up three times instead of once?

neoforged-automation · 2024-12-21T19:20:19Z

@FiniteReality, this pull request has conflicts, please resolve them for this PR to move forward.

FiniteReality marked this pull request as ready for review November 30, 2024 18:39

embeddedt reviewed Nov 30, 2024

View reviewed changes

FiniteReality added 1.21.3 Targeted at Minecraft 1.21.3 needs porting Patch conflicts; needs porting and updating. labels Dec 3, 2024

FiniteReality force-pushed the feature/depth-stenciling branch from e354ca3 to f85ba22 Compare December 6, 2024 04:37

FiniteReality added 1.21.4 Targeted at Minecraft 1.21.4 and removed needs porting Patch conflicts; needs porting and updating. 1.21.3 Targeted at Minecraft 1.21.3 labels Dec 6, 2024

shartte reviewed Dec 6, 2024

View reviewed changes

patches/com/mojang/blaze3d/pipeline/RenderTarget.java.patch Outdated Show resolved Hide resolved

neoforged-automation bot added the needs rebase label Dec 8, 2024

FiniteReality commented Dec 8, 2024

View reviewed changes

patches/net/minecraft/client/renderer/PostChain.java.patch Outdated Show resolved Hide resolved

FiniteReality force-pushed the feature/depth-stenciling branch from b6c15f2 to 5537e4c Compare December 8, 2024 15:21

neoforged-automation bot removed the needs rebase label Dec 8, 2024

FiniteReality force-pushed the feature/depth-stenciling branch from 5537e4c to b7d4e14 Compare December 9, 2024 09:27

FiniteReality added 7 commits December 9, 2024 09:37

Separate ClientModLoader begin/finish into two methods, implement Mai…

bd64882

…nTarget configuration event

Flow stencil information through post chains

45328f7

Fix copy-paste fail in RenderTarget

4d32fa6

Use an enum for the buffer type instead of two bools

1bf3f36

Fix import whoopsie

8b61aa5

Fix stenciling on the main target

1b484aa

Remove no-op method for enabling depth, pass desired width/height

ef3f2f4

FiniteReality force-pushed the feature/depth-stenciling branch from b8e0333 to ef3f2f4 Compare December 9, 2024 09:37

FiniteReality commented Dec 9, 2024

View reviewed changes

Minimise patch by removing unnecessary indentation

b6c5afb

Technici4n requested changes Dec 9, 2024

View reviewed changes

XFactHD requested changes Dec 9, 2024

View reviewed changes

sciwhiz12 added enhancement New (or improvement to existing) feature or request rendering Related to rendering labels Dec 10, 2024

neoforged-automation bot added the needs rebase label Dec 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715

Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715

FiniteReality commented Nov 27, 2024

neoforged-pr-publishing bot commented Nov 27, 2024 •

edited

Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

embeddedt Nov 30, 2024

FiniteReality Nov 30, 2024

shartte Dec 6, 2024

FiniteReality Dec 8, 2024

shartte Dec 8, 2024

Shadows-of-Fire Dec 9, 2024

FiniteReality Dec 9, 2024

shartte Dec 6, 2024

FiniteReality Dec 8, 2024

Shadows-of-Fire Dec 9, 2024

FiniteReality Dec 9, 2024

neoforged-automation bot commented Dec 8, 2024

FiniteReality Dec 9, 2024

Technici4n left a comment •

edited

Loading

XFactHD Dec 9, 2024

XFactHD Dec 9, 2024

neoforged-automation bot commented Dec 21, 2024

Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715

Are you sure you want to change the base?

Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715

Conversation

FiniteReality commented Nov 27, 2024

neoforged-pr-publishing bot commented Nov 27, 2024 • edited Loading

The artifacts published by this PR:

Repository Declaration

MDK installation

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

neoforged-automation bot commented Dec 8, 2024

Choose a reason for hiding this comment

Technici4n left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neoforged-automation bot commented Dec 21, 2024

neoforged-pr-publishing bot commented Nov 27, 2024 •

edited

Loading

Technici4n left a comment •

edited

Loading