Adds Custom Render Pipeline Interface #2304

codex128 · 2024-08-19T15:47:22Z

This PR adds an API that allows custom rendering pipelines to be used instead of the default forward pipeline.

I apologize for how messy this branch is. This used to contain many more changes (which have since been moved), so there are a lot of small changes throughout the branch (i.e. adding a line).

API Usage

There are two primary interfaces for pipelines:

RenderPipeline: performs all the rendering functions
PipelineContext: manages globals for a set of RenderPipelines (i.e. all ForwardPipelines).

Before rendering a ViewPort, the RenderPipeline asks for a PipelineContext, which are stored in a HashMap by class in the RenderManager. If the requested context does not exist (maybe it hasn't been created yet), the RenderPipeline creates it and has RenderManager store it in the map. Thus, subsequent requests (using the same key, ofc) will result in the same PipelineContext, regardless of who made the actual request.

This system allows for all RenderPipelines of the same type (i.e. ForwardPipeline) to use the same PipelineContext instance. Simultaneously, other RenderPipeline implementations can have their own global PipelineContext instance, without interference. As a result, the engine user can use many different RenderPipeline implementations in the same application.

Changes

Introduced RenderPipeline and PipelineContext to the RenderManager and ViewPort classes.
Added AbstractPipelineContext and DefaultPipelineContext.
Moved the default forward pipeline to ForwardPipeline, an implementation of RenderPipeline.
Moved static method renderMeshFromGeometry from DefaultTechniqueDefLogic to TechniqueDefLogic, to be more accessible.
Added method to Camera that only changes the width and height if those values would actually change, which saves certain things from recalculating unnecessarily.
Added method to Camera that checks if a point is within the frustum.
Added DepthRange class that manages the range in which geometries are rendered at.
Added GeometryRenderHandler interface that allows for operations to be performed on geometries right before render.
Made GeometryComparator savable.
Added update flag to GeometryList.
Added color target management methods and target creation utilities to FrameBuffer.

1. Added basic framework of framegraph to manage and organize new rendering passes; 2. Split existing rendering into several core RenderPasses; 3. Added multiple rendering paths (forward, deferred, tile based deferred); 4. Activated Framegraph system by useFramegraph, activated rendering paths by setRenderPath;

Fix flickering issues in tile based deferred shading;

…F), DEPTH

…tDirectionalAndSpotLightShadows.java"

…nlit, lighting)

Added two renderPath sample codes. Added terrain unlit shading model test code; Added terrain lighting shading model test code;

… java file, fix a few minor issues

…ickering problems, fixed attenuation issue with multiple PBR lights under deferred rendering.

1.change java.com.jme3.renderer.renderPass=>java.com.jme3.renderer.pass 2.change IRenderGeometry.java=>RenderGeometry.java

capdevon · 2024-08-21T16:36:05Z

Just a few suggestions:

Restore Unrelated Files:
Please remove any files that haven't been modified as part of this specific change. (eg: com.jme3.anim.tween.Action, com.jme3.post.filters.DepthOfFieldFilter, etc...)
Revert Formatting Changes:
If any files only contain code formatting changes (e.g., indentation, spacing), please revert those changes. (eg: files like .java, .j3md, .vert, .gradle, and .properties)

Why This Matters:

Following these steps will help keep the pull request focused on the core changes you're introducing. This makes it easier for reviewers to understand the impact of your work and provide valuable feedback.

I understand this might seem like extra attention to detail, but considering the potential impact of this change on the engine, adhering to these guidelines ensures a smoother review process for everyone involved, including future contributors.

Thanks for your understanding!

codex128 · 2024-08-21T23:23:55Z

Ok, I restored as much as I could, but there are still some "changes" left I can't figure out how to restore.

build.gradle

jme3-core/src/main/java/com/jme3/material/TechniqueDef.java

jme3-core/src/main/java/com/jme3/renderer/pipeline/RenderPipeline.java

jme3-core/src/main/resources/Common/MatDefs/Light/Deferred.j3md

jme3-core/src/main/resources/Common/MatDefs/Light/Deferred.vert

jme3-core/src/plugins/java/com/jme3/material/plugins/J3MLoader.java

jme3-effects/src/main/java/com/jme3/post/filters/DepthOfFieldFilter.java

jme3-examples/gradle.properties

jme3-terrain/src/main/resources/Common/MatDefs/Terrain/HeightBasedTerrain.j3md

jme3-terrain/src/main/resources/Common/MatDefs/Terrain/Terrain.j3md

codex128 · 2024-08-28T23:38:58Z

Hey @capdevon, would you mind taking another look at this? I have reverted all the changes that I could. There are still some unnecessary changes, but I couldn't figure out how to revert them.

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java

jme3-core/src/main/java/com/jme3/renderer/pipeline/RenderPipeline.java

jme3-core/src/main/java/com/jme3/renderer/pipeline/DefaultPipelineContext.java

jme3-core/src/main/java/com/jme3/renderer/pipeline/ForwardPipeline.java

capdevon · 2024-09-03T13:33:23Z

Other than the latest revision, I don’t have any additional technical changes to propose. I currently lack sufficient information to determine whether your API is flexible enough for future developments. On this matter, I will defer to the opinions of other experienced individuals.

I truly admire your passion and enthusiasm. I would recommend investing some time in learning Maven or Gradle to ensure your example projects (Renthyl) are compilable. This will allow others to experiment with the ideas you wish to implement. Introducing changes like these will understandably take time to be approved, but clear communication paired with practical examples can significantly expedite the process.

codex128 · 2024-09-03T17:40:50Z

I would recommend investing some time in learning Maven or Gradle to ensure your example projects (Renthyl) are compilable.

I attempted to use Gradle on Renthyl, but Gradle did not work well with my network proxy when I was trying to build JME as a dependency. It would get to jme3-lwjgl3 then timeout waiting for connection. :\

zzuegg · 2024-09-10T19:20:37Z

jme3-core/src/main/java/com/jme3/renderer/RenderUtils.java

It seems a bit strange that the regular variants are part of rendermanager and the variants with added Geometryhandlers are inside RenderUtils

That discrepancy is due to me not being entirely happy with GeometryRenderHandler's existence. It has been very useful, though, which is why it hasn't been removed already.

I will have to check with your framegraph implementation to see the usecases.

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java

jme3-core/src/main/java/com/jme3/renderer/GeometryRenderHandler.java

jme3-core/src/main/java/com/jme3/renderer/RenderManager.java

codex128 · 2024-10-22T17:37:23Z

@zzuegg how close are you to finishing the review?

zzuegg · 2024-10-22T19:22:53Z

Quite close. I would like if one of the core guys would take a look at this, mainly regarding the geometryhandler and the code added to the rendermanager.
The question i can't answer is, if you leaked renthyl code into this, or if this is the smallest change possible to support the features.

It seems jme is kind of stuck in a release cycle currently, but i would like this merged in the release after.

At that point having renthyl on maven would be nice to have for an easy access for larger testing audience.

codex128 · 2024-10-22T21:54:50Z

If I'm being totally honest, GeometryRenderHandler is mostly a Renthyl leak. The reason I originally kept it in the PR, is I thought it would be generally useful for people writing their own pipeline implementations. I can remove it if you want. In fact, that'd probably be for the best.

The code added to the RenderManager is necessary. I double checked to make sure I hadn't missed anything.

At that point having renthyl on maven would be nice to have for an easy access for larger testing audience.

Yeah, publishing to maven central is definitely something I should prioritize. I'm still stuck trying to get gradle to work with my proxy server. 😛

Thanks for taking the time to review this PR. I greatly appreciate it! 🤗

zzuegg · 2024-10-22T22:31:53Z

As for maven, currently i don't think it is possible because jme does not include the required changes, but it should be available around the sametime jme releases the features.

One issue with the geometryhandler is that i kind of see the requirement for allowing lit/unshaded material mixing in the deferred pipeline but in the same time it enforces a "deferred first". (Maybe i am talking about renthyl here too, but that is the reference implementation).

The remaining thing on my todo list for checking this is if i am able to replace the renderqueue filling with something of my own, or surpress the whole process and use a framegraph task for that.

zzuegg

thanks for the fast changes.

stephengold · 2024-10-24T16:21:47Z

Thank you @codex128, @capdevon, and @zzuegg.
Looking forward to v3.8.0-alpha1 !

codex128 and others added 30 commits July 24, 2023 18:10

added AlertArmatureMask

d2315be

fixed docs and added another helper

2f1dae8

made it easier to turn off priority checking

a750f1c

removed copy methods

cd876d4

jme3-examples:Added a set of test cases for renderPath.

8479dd3

jme3-core:Improve deferred shading issues;

e5737df

Fix flickering issues in tile based deferred shading;

jme3-examples:Adjust deferred rendering test code

d69de2d

jme3-core:Adjust GBuffer format, RT0(16F), RT1(16F), RT2(16F), RT3(32…

6e75f0b

…F), DEPTH

jme3-core:Delete test code

0290dcd

jme3-core:Fixed all known bugs in Tile-based DeferredShading.

6a64da6

jme3-examples:update TestTileBasedDeferredShading

c8e7426

jme3-core:update GLSLCompat.glsllib

e540601

jme3-core:Fix frameGraph assertion error

fdea4cc

jme3-core:Add some core code comments, delete Chinese code comments

f60a03b

jme3-core:Fix bugs existed in shadingModel

b7f0b58

jme3-examples:Add test case "TestShadingModel.java,TestRenderPathPoin…

e4862a6

…tDirectionalAndSpotLightShadows.java"

jme3-core:GBuffer data packing for terrain rendering compatibility (u…

2475337

…nlit, lighting)

jme3-examples:

81c1362

Added two renderPath sample codes. Added terrain unlit shading model test code; Added terrain lighting shading model test code;

jme3-core:Add rendering path support for AdvancedPBRTerrain

05eb006

jme3-examples:Add a test code

e327316

jme3-core:Supplement core code comments, add full JME license to each…

63222d6

… java file, fix a few minor issues

jme3-terrain:Implement PBRTerrain compatibility code

82c6dc2

jme3-core:Fixed Tile-basedDeferred light culling issue, fixed some fl…

0359a8e

…ickering problems, fixed attenuation issue with multiple PBR lights under deferred rendering.

jme3-examples:update TestCode

98e0ae4

jme3-examples:update TestPBRTerrainRenderPath.java

000fb0e

jme3-core:Fix TestTexture3D/TestTexture3DLoading

09a22a6

jme3-core:fix lightTexSizeInv undefined

83ac2b5

Merge branch 'master' into master

65fd3de

jme3-core:

3521b2a

1.change java.com.jme3.renderer.renderPass=>java.com.jme3.renderer.pass 2.change IRenderGeometry.java=>RenderGeometry.java

codex128 added 4 commits August 21, 2024 18:30

remove miscellaneous

7ba557c

removed miscellaneous

e4a0c87

remove miscellaneous

f5a2b36

remove miscellaneous

343a80b

changed render start order

e548145

capdevon reviewed Aug 23, 2024

View reviewed changes

added license and attempted to revert changes

f100750

capdevon reviewed Aug 30, 2024

View reviewed changes

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java Outdated Show resolved Hide resolved

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java Outdated Show resolved Hide resolved

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java Outdated Show resolved Hide resolved

remove target creation helpers

d291849

capdevon reviewed Sep 3, 2024

View reviewed changes

added spacing

986603c

zzuegg reviewed Sep 10, 2024

View reviewed changes

several small changes

b9d7b41

added null pipeline and context creation helper

27fd262

delete GeometryRenderHandler and RenderUtils

8e4c4e6

zzuegg self-requested a review October 24, 2024 15:49

zzuegg approved these changes Oct 24, 2024

View reviewed changes

stephengold merged commit 327426d into jMonkeyEngine:master Oct 24, 2024
14 checks passed

stephengold added this to the Future Release milestone Oct 24, 2024

stephengold mentioned this pull request Oct 25, 2024

A framegraph framework that supports 3 render paths #2090

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Custom Render Pipeline Interface #2304

Adds Custom Render Pipeline Interface #2304

codex128 commented Aug 19, 2024

capdevon commented Aug 21, 2024 •

edited

Loading

codex128 commented Aug 21, 2024

codex128 commented Aug 28, 2024

capdevon commented Sep 3, 2024

codex128 commented Sep 3, 2024

zzuegg Sep 10, 2024

codex128 Sep 10, 2024

zzuegg Sep 11, 2024

codex128 commented Oct 22, 2024

zzuegg commented Oct 22, 2024 •

edited

Loading

codex128 commented Oct 22, 2024 •

edited

Loading

zzuegg commented Oct 22, 2024

zzuegg left a comment

stephengold commented Oct 24, 2024

Adds Custom Render Pipeline Interface #2304

Adds Custom Render Pipeline Interface #2304

Conversation

codex128 commented Aug 19, 2024

API Usage

Changes

capdevon commented Aug 21, 2024 • edited Loading

codex128 commented Aug 21, 2024

codex128 commented Aug 28, 2024

capdevon commented Sep 3, 2024

codex128 commented Sep 3, 2024

zzuegg Sep 10, 2024

Choose a reason for hiding this comment

codex128 Sep 10, 2024

Choose a reason for hiding this comment

zzuegg Sep 11, 2024

Choose a reason for hiding this comment

codex128 commented Oct 22, 2024

zzuegg commented Oct 22, 2024 • edited Loading

codex128 commented Oct 22, 2024 • edited Loading

zzuegg commented Oct 22, 2024

zzuegg left a comment

Choose a reason for hiding this comment

stephengold commented Oct 24, 2024

capdevon commented Aug 21, 2024 •

edited

Loading

zzuegg commented Oct 22, 2024 •

edited

Loading

codex128 commented Oct 22, 2024 •

edited

Loading