Package foundry.veil.editor

Interface Editor

All Superinterfaces:
AutoCloseable, org.lwjgl.system.NativeResource
All Known Implementing Classes:
DeferredEditor, DeviceInfoViewer, ExampleEditor, OpenCLEditor, PostEditor, ShaderEditor, SingleWindowEditor, TextureEditor
public interface Editor extends org.lwjgl.system.NativeResource
A basic panel that can be toggled in the editor view.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    free()
    Frees any resources allocated by this editor before being destroyed.
    String
    getDisplayName()
     
    default boolean
    isEnabled()
     
    default boolean
    isMenuBarEnabled()
     
    default boolean
    isOpen()
     
    default void
    onHide()
    Called when this editor is no longer open.
    default void
    onShow()
    Called when this editor is first opened.
    void
    render()
    Renders this editor to the screen.
    default void
    renderLast()
    Called just before the imgui state is drawn to the screen
    default void
    renderMenuBar()
    Renders elements into the menu bar.

    Methods inherited from interface org.lwjgl.system.NativeResource

    close

  • Method Details

    • renderMenuBar

      default void renderMenuBar()
      Renders elements into the menu bar. Only called if isMenuBarEnabled() is true.

    • render

      void render()
      Renders this editor to the screen.

    • renderLast

      default void renderLast()
      Called just before the imgui state is drawn to the screen

    • getDisplayName

      String getDisplayName()
      Returns:
      The visible display name of this editor

    • isEnabled

      default boolean isEnabled()
      Returns:
      Whether this editor should be selectable.

    • isMenuBarEnabled

      default boolean isMenuBarEnabled()
      Returns:
      Whether this editor should draw into the menu bar

    • onShow

      default void onShow()
      Called when this editor is first opened.

    • onHide

      default void onHide()
      Called when this editor is no longer open.

    • isOpen

      default boolean isOpen()
      Returns:
      Whether this editor is open

    • free

      default void free()
      Frees any resources allocated by this editor before being destroyed.
      Specified by:
      free in interface org.lwjgl.system.NativeResource