-
-
Notifications
You must be signed in to change notification settings - Fork 194
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.
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
Create a ConfigureMainRenderTargetEvent for enabling stenciling #1715
Closed
FiniteReality
wants to merge
11
commits into
neoforged:1.21.x
from
FiniteReality:feature/depth-stenciling
Closed
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ea3aeb4
Separate ClientModLoader begin/finish into two methods, implement Mai…
FiniteReality 5135ec1
Flow stencil information through post chains
FiniteReality 613cb46
Fix copy-paste fail in RenderTarget
FiniteReality f938bfe
Use an enum for the buffer type instead of two bools
FiniteReality b5cd630
Fix import whoopsie
FiniteReality 922fad6
Fix stenciling on the main target
FiniteReality 721d79d
Remove no-op method for enabling depth, pass desired width/height
FiniteReality ff68a10
Minimise patch by removing unnecessary indentation
FiniteReality 117c7af
Respond to XFact's feedback
FiniteReality f278e8d
Remove stencil-only patches in MainTarget
FiniteReality 5f6b45d
Event cleanup and attempt other-platform support
FiniteReality File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
49 changes: 49 additions & 0 deletions
49
patches/com/mojang/blaze3d/framegraph/FrameGraphBuilder.java.patch
This file contains 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,49 @@ | ||
--- a/com/mojang/blaze3d/framegraph/FrameGraphBuilder.java | ||
+++ b/com/mojang/blaze3d/framegraph/FrameGraphBuilder.java | ||
@@ -173,6 +_,11 @@ | ||
public T get() { | ||
return this.resource; | ||
} | ||
+ | ||
+ @Override | ||
+ public ResourceDescriptor<T> getDescriptor() { | ||
+ return null; | ||
+ } | ||
} | ||
|
||
@OnlyIn(Dist.CLIENT) | ||
@@ -211,6 +_,10 @@ | ||
public String toString() { | ||
return this.createdBy != null ? this.holder + "#" + this.version + " (from " + this.createdBy + ")" : this.holder + "#" + this.version; | ||
} | ||
+ | ||
+ public ResourceDescriptor<T> getDescriptor() { | ||
+ return this.holder.getDescriptor(); | ||
+ } | ||
} | ||
|
||
@OnlyIn(Dist.CLIENT) | ||
@@ -265,6 +_,11 @@ | ||
this.physicalResource = null; | ||
} | ||
} | ||
+ | ||
+ @Override | ||
+ public ResourceDescriptor<T> getDescriptor() { | ||
+ return descriptor; | ||
+ } | ||
} | ||
|
||
@OnlyIn(Dist.CLIENT) | ||
@@ -363,6 +_,11 @@ | ||
@Override | ||
public String toString() { | ||
return this.name; | ||
+ } | ||
+ | ||
+ @Nullable | ||
+ public ResourceDescriptor<T> getDescriptor() { | ||
+ return null; | ||
} | ||
} | ||
} |
This file contains 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,87 @@ | ||
--- a/com/mojang/blaze3d/pipeline/MainTarget.java | ||
+++ b/com/mojang/blaze3d/pipeline/MainTarget.java | ||
@@ -16,8 +_,12 @@ | ||
static final MainTarget.Dimension DEFAULT_DIMENSIONS = new MainTarget.Dimension(854, 480); | ||
|
||
public MainTarget(int p_166137_, int p_166138_) { | ||
- super(true); | ||
- this.createFrameBuffer(p_166137_, p_166138_); | ||
+ this(net.neoforged.neoforge.client.ClientHooks.configureMainRenderTarget(true, p_166137_, p_166138_)); | ||
+ } | ||
+ | ||
+ private MainTarget(net.neoforged.neoforge.client.event.ConfigureMainRenderTargetEvent e) { | ||
+ super(e.useDepth(), e.useStencil()); | ||
+ this.createFrameBuffer(e.width(), e.height()); | ||
} | ||
|
||
private void createFrameBuffer(int p_166142_, int p_166143_) { | ||
@@ -37,6 +_,10 @@ | ||
GlStateManager._texParameter(3553, 10242, 33071); | ||
GlStateManager._texParameter(3553, 10243, 33071); | ||
GlStateManager._glFramebufferTexture2D(36160, 36096, 3553, this.depthBufferId, 0); | ||
+ if (this.useStencil) { | ||
+ GlStateManager._bindTexture(this.stencilBufferId); | ||
+ GlStateManager._glFramebufferTexture2D(36160, org.lwjgl.opengl.GL32.GL_STENCIL_ATTACHMENT, 3553, this.stencilBufferId, 0); | ||
+ } | ||
GlStateManager._bindTexture(0); | ||
this.viewWidth = maintarget$dimension.width; | ||
this.viewHeight = maintarget$dimension.height; | ||
@@ -50,7 +_,14 @@ | ||
RenderSystem.assertOnRenderThreadOrInit(); | ||
this.colorTextureId = TextureUtil.generateTextureId(); | ||
this.depthBufferId = TextureUtil.generateTextureId(); | ||
+ if (this.useStencil) { | ||
+ this.stencilBufferId = this.depthBufferId; | ||
+ } | ||
MainTarget.AttachmentState maintarget$attachmentstate = MainTarget.AttachmentState.NONE; | ||
+ MainTarget.AttachmentState targetState = MainTarget.AttachmentState.COLOR_DEPTH; | ||
+ if (this.useStencil) { | ||
+ targetState = targetState.with(MainTarget.AttachmentState.STENCIL); | ||
+ } | ||
|
||
for (MainTarget.Dimension maintarget$dimension : MainTarget.Dimension.listWithFallback(p_166147_, p_166148_)) { | ||
maintarget$attachmentstate = MainTarget.AttachmentState.NONE; | ||
@@ -58,11 +_,15 @@ | ||
maintarget$attachmentstate = maintarget$attachmentstate.with(MainTarget.AttachmentState.COLOR); | ||
} | ||
|
||
- if (this.allocateDepthAttachment(maintarget$dimension)) { | ||
+ if (this.useStencil && this.allocateDepthStencilAttachment(maintarget$dimension)) { | ||
+ maintarget$attachmentstate = maintarget$attachmentstate.with(MainTarget.AttachmentState.DEPTH_STENCIL); | ||
+ } | ||
+ | ||
+ else if (this.allocateDepthAttachment(maintarget$dimension)) { | ||
maintarget$attachmentstate = maintarget$attachmentstate.with(MainTarget.AttachmentState.DEPTH); | ||
} | ||
|
||
- if (maintarget$attachmentstate == MainTarget.AttachmentState.COLOR_DEPTH) { | ||
+ if (maintarget$attachmentstate == targetState) { | ||
return maintarget$dimension; | ||
} | ||
} | ||
@@ -86,12 +_,24 @@ | ||
return GlStateManager._getError() != 1285; | ||
} | ||
|
||
+ private boolean allocateDepthStencilAttachment(MainTarget.Dimension p_166145_) { | ||
+ RenderSystem.assertOnRenderThreadOrInit(); | ||
+ GlStateManager._getError(); | ||
+ GlStateManager._bindTexture(this.depthBufferId); | ||
+ GlStateManager._texImage2D(3553, 0, 6402, p_166145_.width, p_166145_.height, 0, org.lwjgl.opengl.GL32.GL_DEPTH_STENCIL, org.lwjgl.opengl.GL32.GL_UNSIGNED_INT_24_8, null); | ||
+ return GlStateManager._getError() != 1285; | ||
+ } | ||
+ | ||
@OnlyIn(Dist.CLIENT) | ||
static enum AttachmentState { | ||
NONE, | ||
COLOR, | ||
DEPTH, | ||
- COLOR_DEPTH; | ||
+ COLOR_DEPTH, | ||
+ STENCIL, | ||
+ COLOR_STENCIL, | ||
+ DEPTH_STENCIL, | ||
+ COLOR_DEPTH_STENCIL; | ||
|
||
private static final MainTarget.AttachmentState[] VALUES = values(); | ||
|
134 changes: 134 additions & 0 deletions
134
patches/com/mojang/blaze3d/pipeline/RenderTarget.java.patch
This file contains 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,134 @@ | ||
--- a/com/mojang/blaze3d/pipeline/RenderTarget.java | ||
+++ b/com/mojang/blaze3d/pipeline/RenderTarget.java | ||
@@ -25,17 +_,31 @@ | ||
public int viewWidth; | ||
public int viewHeight; | ||
public final boolean useDepth; | ||
+ public final boolean useStencil; | ||
public int frameBufferId; | ||
protected int colorTextureId; | ||
protected int depthBufferId; | ||
+ protected int stencilBufferId; | ||
private final float[] clearChannels = Util.make(() -> new float[]{1.0F, 1.0F, 1.0F, 0.0F}); | ||
public int filterMode; | ||
|
||
public RenderTarget(boolean p_166199_) { | ||
- this.useDepth = p_166199_; | ||
+ this(p_166199_, false); | ||
+ } | ||
+ | ||
+ public RenderTarget(boolean useDepth, boolean useStencil) { | ||
+ this.useDepth = useDepth; | ||
+ this.useStencil = useStencil; | ||
this.frameBufferId = -1; | ||
this.colorTextureId = -1; | ||
this.depthBufferId = -1; | ||
+ | ||
+ 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"); | ||
+ } | ||
+ } | ||
FiniteReality marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
public void resize(int p_83942_, int p_83943_) { | ||
@@ -53,6 +_,11 @@ | ||
RenderSystem.assertOnRenderThreadOrInit(); | ||
this.unbindRead(); | ||
this.unbindWrite(); | ||
+ if (this.stencilBufferId > -1 && this.stencilBufferId != this.depthBufferId) { | ||
+ TextureUtil.releaseTextureId(this.stencilBufferId); | ||
+ this.stencilBufferId = -1; | ||
+ } | ||
+ | ||
if (this.depthBufferId > -1) { | ||
TextureUtil.releaseTextureId(this.depthBufferId); | ||
this.depthBufferId = -1; | ||
@@ -96,9 +_,50 @@ | ||
GlStateManager._texParameter(3553, 34892, 0); | ||
GlStateManager._texParameter(3553, 10242, 33071); | ||
GlStateManager._texParameter(3553, 10243, 33071); | ||
+ if (!this.useStencil) // If stenciling is enabled, we will fill this later | ||
GlStateManager._texImage2D(3553, 0, 6402, this.width, this.height, 0, 6402, 5126, null); | ||
} | ||
|
||
+ if (this.useStencil) { | ||
+ if (this.useDepth) { | ||
+ // If depth and stencil buffers are both enabled, we must combine them | ||
+ this.stencilBufferId = this.depthBufferId; | ||
+ } else { | ||
+ // Otherwise, we can generate a new texture in its place. | ||
+ this.stencilBufferId = TextureUtil.generateTextureId(); | ||
+ GlStateManager._bindTexture(this.stencilBufferId); | ||
+ GlStateManager._texParameter(3553, 10241, 9728); | ||
+ GlStateManager._texParameter(3553, 10240, 9728); | ||
+ GlStateManager._texParameter(3553, 34892, 0); | ||
+ GlStateManager._texParameter(3553, 10242, 33071); | ||
+ GlStateManager._texParameter(3553, 10243, 33071); | ||
+ } | ||
+ | ||
+ if (this.useDepth) { | ||
+ // Use a combined format for both depth and stencil. | ||
+ GlStateManager._texImage2D( | ||
+ org.lwjgl.opengl.GL32.GL_TEXTURE_2D, | ||
+ 0, | ||
+ org.lwjgl.opengl.GL32.GL_DEPTH24_STENCIL8, | ||
+ this.width, this.height, | ||
+ 0, | ||
+ org.lwjgl.opengl.GL32.GL_DEPTH_STENCIL, | ||
+ org.lwjgl.opengl.GL32.GL_UNSIGNED_INT_24_8, | ||
+ null); | ||
+ } else { | ||
+ // Otherwise, we can use a separate format. Testing for this was done in the constructor already. | ||
+ GlStateManager._texImage2D( | ||
+ org.lwjgl.opengl.GL32.GL_TEXTURE_2D, | ||
+ 0, | ||
+ org.lwjgl.opengl.GL32.GL_STENCIL_INDEX8, | ||
+ this.width, this.height, | ||
+ 0, | ||
+ org.lwjgl.opengl.GL32.GL_STENCIL_INDEX, | ||
+ org.lwjgl.opengl.GL32.GL_BYTE, | ||
+ null); | ||
+ } | ||
+ } | ||
+ | ||
this.setFilterMode(9728, true); | ||
GlStateManager._bindTexture(this.colorTextureId); | ||
GlStateManager._texParameter(3553, 10242, 33071); | ||
@@ -109,6 +_,14 @@ | ||
if (this.useDepth) { | ||
GlStateManager._glFramebufferTexture2D(36160, 36096, 3553, this.depthBufferId, 0); | ||
} | ||
+ if (this.useStencil) { | ||
+ GlStateManager._glFramebufferTexture2D( | ||
+ org.lwjgl.opengl.GL32.GL_FRAMEBUFFER, | ||
+ org.lwjgl.opengl.GL32.GL_STENCIL_ATTACHMENT, | ||
+ org.lwjgl.opengl.GL32.GL_TEXTURE_2D, | ||
+ this.stencilBufferId, | ||
+ 0); | ||
+ } | ||
|
||
this.checkStatus(); | ||
this.clear(); | ||
@@ -218,6 +_,10 @@ | ||
GlStateManager._clearDepth(1.0); | ||
i |= 256; | ||
} | ||
+ if (this.useStencil) { | ||
+ GlStateManager._clearStencil(0); | ||
+ i |= org.lwjgl.opengl.GL32.GL_STENCIL_BUFFER_BIT; | ||
+ } | ||
|
||
GlStateManager._clear(i); | ||
this.unbindWrite(); | ||
@@ -229,5 +_,9 @@ | ||
|
||
public int getDepthTextureId() { | ||
return this.depthBufferId; | ||
+ } | ||
+ | ||
+ public int getStencilTextureId() { | ||
+ return this.stencilBufferId; | ||
} | ||
} |
14 changes: 14 additions & 0 deletions
14
patches/com/mojang/blaze3d/pipeline/TextureTarget.java.patch
This file contains 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,14 @@ | ||
--- a/com/mojang/blaze3d/pipeline/TextureTarget.java | ||
+++ b/com/mojang/blaze3d/pipeline/TextureTarget.java | ||
@@ -7,7 +_,10 @@ | ||
@OnlyIn(Dist.CLIENT) | ||
public class TextureTarget extends RenderTarget { | ||
public TextureTarget(int p_166213_, int p_166214_, boolean p_166215_) { | ||
- super(p_166215_); | ||
+ this(p_166213_, p_166214_, p_166215_, false); | ||
+ } | ||
+ public TextureTarget(int p_166213_, int p_166214_, boolean p_166215_, boolean useStencil) { | ||
+ super(p_166215_, useStencil); | ||
RenderSystem.assertOnRenderThreadOrInit(); | ||
this.resize(p_166213_, p_166214_); | ||
} |
18 changes: 18 additions & 0 deletions
18
patches/com/mojang/blaze3d/resource/RenderTargetDescriptor.java.patch
This file contains 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,18 @@ | ||
--- a/com/mojang/blaze3d/resource/RenderTargetDescriptor.java | ||
+++ b/com/mojang/blaze3d/resource/RenderTargetDescriptor.java | ||
@@ -6,9 +_,13 @@ | ||
import net.neoforged.api.distmarker.OnlyIn; | ||
|
||
@OnlyIn(Dist.CLIENT) | ||
-public record RenderTargetDescriptor(int width, int height, boolean useDepth) implements ResourceDescriptor<RenderTarget> { | ||
+public record RenderTargetDescriptor(int width, int height, boolean useDepth, boolean useStencil) implements ResourceDescriptor<RenderTarget> { | ||
+ public RenderTargetDescriptor(int width, int height, boolean useDepth) { | ||
+ this(width, height, useDepth, false); | ||
+ } | ||
+ | ||
public RenderTarget allocate() { | ||
- return new TextureTarget(this.width, this.height, this.useDepth); | ||
+ return new TextureTarget(this.width, this.height, this.useDepth, this.useStencil); | ||
} | ||
|
||
public void free(RenderTarget p_363223_) { |
This file contains 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
10 changes: 10 additions & 0 deletions
10
patches/net/minecraft/client/renderer/LevelRenderer.java.patch
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
useDepth
shouldn't be in the event