Package foundry.veil.api.client.render.framebuffer

Interface AdvancedFboAttachment

All Superinterfaces:
AutoCloseable, Cloneable, org.lwjgl.system.NativeResource
All Known Implementing Classes:
AdvancedFboMutableTextureAttachment, AdvancedFboRenderAttachment, AdvancedFboTextureAttachment
public interface AdvancedFboAttachment extends org.lwjgl.system.NativeResource, Cloneable
An attachment added to an AdvancedFboImpl.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    attach(int attachment)
    Attaches this attachment to the provided target under the specified attachment point.
    void
    bindAttachment()
    Binds this attachment.
    boolean
    canSample()
     
    AdvancedFboAttachment
    clone()
     
    void
    create()
    Creates the attachment and initializes it with the default properties.
    int
    getAttachmentType()
    Returns the OpenGL attachment point.
    int
    getFormat()
     
    int
    getLevels()
     
    @Nullable String
    getName()
     
    void
    unbindAttachment()
    Unbinds this attachment.

    Methods inherited from interface org.lwjgl.system.NativeResource

    close, free

  • Method Details

    • create

      void create()
      Creates the attachment and initializes it with the default properties.

    • attach

      void attach(int attachment)
      Attaches this attachment to the provided target under the specified attachment point.
      Parameters:
      attachment - The attachment point to add this attachment to

    • bindAttachment

      void bindAttachment()
      Binds this attachment.

    • unbindAttachment

      void unbindAttachment()
      Unbinds this attachment.

    • getAttachmentType

      int getAttachmentType()
      Returns the OpenGL attachment point. One of:
      All possible OpenGL attachment points
      COLOR_ATTACHMENT0 COLOR_ATTACHMENT1 COLOR_ATTACHMENT2 COLOR_ATTACHMENT3
      COLOR_ATTACHMENT4 COLOR_ATTACHMENT5 COLOR_ATTACHMENT6 COLOR_ATTACHMENT7
      COLOR_ATTACHMENT8 COLOR_ATTACHMENT9 COLOR_ATTACHMENT10 COLOR_ATTACHMENT11
      COLOR_ATTACHMENT12 COLOR_ATTACHMENT13 COLOR_ATTACHMENT14 COLOR_ATTACHMENT15
      COLOR_ATTACHMENT16 COLOR_ATTACHMENT17 COLOR_ATTACHMENT18 COLOR_ATTACHMENT19
      COLOR_ATTACHMENT20 COLOR_ATTACHMENT21 COLOR_ATTACHMENT22 COLOR_ATTACHMENT23
      COLOR_ATTACHMENT24 COLOR_ATTACHMENT25 COLOR_ATTACHMENT26 COLOR_ATTACHMENT27
      COLOR_ATTACHMENT28 COLOR_ATTACHMENT29 COLOR_ATTACHMENT30 COLOR_ATTACHMENT31
      DEPTH_ATTACHMENT STENCIL_ATTACHMENT DEPTH_STENCIL_ATTACHMENT
      Returns:
      OpenGL attachment point

    • getFormat

      int getFormat()
      Returns:
      The OpenGL format for this attachment

    • getLevels

      int getLevels()
      Returns:
      Texture targets return mipmaps and render targets return samples.

    • canSample

      boolean canSample()
      Returns:
      Whether this attachment can be read from

    • getName

      @Nullable @Nullable String getName()
      Returns:
      The custom name of this attachment or null to use DiffuseSampler#

    • clone

      AdvancedFboAttachment clone()
      Returns:
      A new identical attachment to this one