Effekseer Native for JME

This is a library that uses EffekseerForMultiLanguages to load and render effects made with Effekseer in jme.

Supported platforms:

Windows 64bit
Linux 64bit

Missing features:

Sounds

Gradle coordinates (github packages)

plugins {
    id "io.github.0ffz.github-packages" version "1.2.1"
}

repositories {
    maven githubPackage.invoke("riccardobl")
}

dependencies {
    implementation 'wf.frk:jme-effekseer-native:0.4'
}

Usage - Managed Rendering

For infos regarding version to version upgrade see docs/UPGRADE.md

// Add a filter post processor to your viewPort
// optional:
//   if the FilterPostProcessor is created, EffekseerRenderer will attach itself as a filter
//   otherwise it will be attached as a scene processor.
//   Note: if a FilterPostProcessor is used in the viewport, EffekseerRenderer must be called before 
//         attaching any other filter, becoming defacto the first filter to be attached to the FilterPostProcessor
FilterPostProcessor fpp=new FilterPostProcessor(assetManager);
viewPort.addProcessor(fpp);

// Add Effekseer Renderer
EffekseerRenderer effekseerRenderer=EffekseerRenderer.addToViewPort(stateManager, viewPort, assetManager, settings.isGammaCorrection());
        
// Load an effect
EffekseerEmitterControl effekt=new EffekseerEmitterControl(assetManager,"effekts/Pierre/Lightning.efkefc");

// Set a driver (optional)
effekt.setDriver(
    new EffekseerEmissionDriverGeneric()
        .shape(new EffekseerPointFollowingSpatialShape())
        .spawner(new EffekseerGenericSpawner().loop(true).delay(1f,2f, 1f).maxInstances(1000))
        .dynamicInputSupplier(new EffekseerGenericDynamicInputSupplier().set(0,10f).set(1,11f))
);

// Attach to a spatial
Node n=new Node();
n.addControl(effekt);

rootNode.attachChild(n);

Advanced Usage - Manual Rendering

This is intended to be used on custom render pipelines or offscreen rendering

// Init Effekseer
boolean isSRGB=true;
Effekseer.init(assetManager,isSRGB);

// Update logic: This needs to be called in your update loop (once per frame)
Effekseer.update( tpf);

// --- Render scene 1
// Select the scene to render
Effekseer.beginRender(root1);

// Render
Effekseer.render(
    Renderer gl, /* The opengl renderer */
    Camera cam, /* The scene camera */
    FrameBuffer target, /* The render target */
    Texture2D color, /* The current scene, used for distortions  (null to disable distortions) */
    Texture2D depth, /* The depth of the current scene, used for soft particles (null to disable soft particles) */
    boolean isOrthographic /* true if rendering in orthographic mode */
);

// End the render
Effekseer.endRender();

// --- Render scene 2
// Select the scene to render
Effekseer.beginRender(root2);

// Render
Effekseer.render(
    Renderer gl, /* The opengl renderer */
    Camera cam, /* The scene camera */
    FrameBuffer target, /* The render target */
    Texture2D color, /* The current scene, used for distortions  (null to disable distortions) */
    Texture2D depth, /* The depth of the current scene, used for soft particles (null to disable soft particles) */
    boolean isOrthographic /* true if rendering in orthographic mode */
);

// End the render
Effekseer.endRender();

Note: opengl cannot read and write on the same buffer, this means that depth and colors that come from the same target framebuffer have to be copied. The following helper utility can be used to do it in a reasonably fast way:

FrameBufferCopy copiedFb=EffekseerUtils.copyFrameBuffer(
    AssetManager am, /* the asset manager */
    RenderManager rm, /* the render manager */
    FrameBuffer source, /* source */
    int width, /* width */
    int height, /* height */
    boolean copyColor, /* true to copy the color buffer */
    boolean colorTarget, /* which target to copy (0=first) */
    boolean copyDepth /* true to copy the depth buffer*/
);

Limitations with particles on the GUI

There is an issue with depth sorting when using Managed Rendering to render inside the SimpleApplication's guiViewPort: the particles will always be rendered on top. Finding a generic workaround for this issue is pretty complex due to the way the engine handles the guiViewPort. A possible solution is to use Advanced Usage - Manual Rendering to render a special root node containing only "gui particles" on top of the main framebuffer using an appropriate Camera.

01 February 2023