Package com.seibel.distanthorizons.api.interfaces.override.rendering

Interface IDhApiFramebuffer

All Superinterfaces:
IBindable, IDhApiOverrideable
public interface IDhApiFramebuffer extends IDhApiOverrideable
Since:
API 2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addColorAttachment(int textureIndex, int textureId)
    Binds the given OpenGL texture ID to the given texture index relative to OpenGL's GL_COLOR_ATTACHMENT0
    void
    addDepthAttachment(int textureId, boolean isCombinedStencil)
    Binds the given OpenGL depth texture ID.
    void
    bind()
    Runs any necessary binding this program needs so rendering can be done.
    void
    destroy()
    Destroys this framebuffer's OpenGL object(s).
    int
    getId()
     
    int
    getStatus()
     
    boolean
    overrideThisFrame()
    If this method is called that means this program has the highest priority as defined by IDhApiOverrideable.getPriority() and gets to decide if it wants to be used to render this frame or not.

    Methods inherited from interface com.seibel.distanthorizons.coreapi.interfaces.dependencyInjection.IBindable

    finishDelayedSetup, getDelayedSetupComplete

    Methods inherited from interface com.seibel.distanthorizons.api.interfaces.override.IDhApiOverrideable

    getPriority

  • Method Details

    • overrideThisFrame

      boolean overrideThisFrame()
      If this method is called that means this program has the highest priority as defined by IDhApiOverrideable.getPriority() and gets to decide if it wants to be used to render this frame or not.

      If this method returns true then this program will be used for this frame.
      If this returns false then the default DH IDhApiShaderProgram will be used instead.

    • bind

      void bind()
      Runs any necessary binding this program needs so rendering can be done.

    • addDepthAttachment

      void addDepthAttachment(int textureId, boolean isCombinedStencil)
      Binds the given OpenGL depth texture ID.

    • getId

      int getId()
      Returns:
      the OpenGL ID for this shader program

    • getStatus

      int getStatus()
      Returns:
      the OpenGL framebuffer status as defined by glCheckFramebufferStatus

    • addColorAttachment

      void addColorAttachment(int textureIndex, int textureId)
      Binds the given OpenGL texture ID to the given texture index relative to OpenGL's GL_COLOR_ATTACHMENT0

    • destroy

      void destroy()
      Destroys this framebuffer's OpenGL object(s).