io.tlf.jme.jfx.injfx.processor.FrameTransferSceneProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jme-jfx Show documentation

jMonkeyEngine library for JavaFX 12+ integration.

The newest version!

package io.tlf.jme.jfx.injfx.processor;

import com.jme3.post.SceneProcessor;

/**
 * The interface for implementing frame transfer processor.
 *
 * @author JavaSaBr
 */
public interface FrameTransferSceneProcessor extends SceneProcessor {

    enum TransferMode {
        ALWAYS,
        ON_CHANGES
    }

    /**
     * Is main boolean.
     *
     * @return if this processor is main.
     */
    boolean isMain();

    /**
     * Is enabled boolean.
     *
     * @return true if this processor is enabled.
     */
    boolean isEnabled();

    /**
     * Sets enabled.
     *
     * @param enabled true if this processor is enabled.
     */
    void setEnabled(boolean enabled);

    /**
     * Reshape a screen.
     */
    void reshape();

    /**
     * Set the transfer mode.
     *
     * @return the transfer mode.
     */
    TransferMode getTransferMode();

    /**
     * Get the transfer mode.
     *
     * @param transferMode the transfer mode.
     */
    void setTransferMode(TransferMode transferMode);
}