gameforge - v0.1.12
    Preparing search index...

    Class FramebufferSystem

    System plugin to the renderer to manage framebuffers.

    PIXI

    Implements

    Index

    Constructors

    Properties

    CONTEXT_UID: number
    current: Framebuffer
    hasMRT: boolean
    managedFramebuffers: Framebuffer[]

    A list of managed framebuffers.

    msaaSamples: number[]
    renderer: Renderer
    unknownFramebuffer: Framebuffer

    Framebuffer value that shows that we don't know what is bound.

    viewport: Rectangle
    writeDepthTexture: boolean

    Accessors

    • get size(): { height: number; width: number; x: number; y: number }

      Get the size of the current width and height. Returns object with width and height values.

      Returns { height: number; width: number; x: number; y: number }

    Methods

    • Bind a framebuffer.

      Parameters

      • Optionalframebuffer: Framebuffer
      • Optionalframe: Rectangle

        frame, default is framebuffer size

      • OptionalmipLevel: number

        optional mip level to set on the framebuffer - defaults to 0

      Returns void

    • Only works with WebGL2

      blits framebuffer to another of the same or bigger size after that target framebuffer is bound

      Fails with WebGL warning if blits multisample framebuffer to different size

      Parameters

      • Optionalframebuffer: Framebuffer

        by default it blits "into itself", from renderBuffer to texture.

      • OptionalsourcePixels: Rectangle

        source rectangle in pixels

      • OptionaldestPixels: Rectangle

        dest rectangle in pixels, assumed to be the same as sourcePixels

      Returns void

    • Returns true if the frame buffer can be multisampled.

      Parameters

      Returns boolean

    • Clear the color of the context

      Parameters

      • r: number

        Red value from 0 to 1

      • g: number

        Green value from 0 to 1

      • b: number

        Blue value from 0 to 1

      • a: number

        Alpha value from 0 to 1

      • Optionalmask: BUFFER_BITS

        Bitwise OR of masks that indicate the buffers to be cleared, by default COLOR and DEPTH buffers.

      Returns void

    • Sets up the renderer context and necessary buffers.

      Returns void

    • Generic destroy methods to be overridden by the subclass

      Returns void

    • Detects number of samples that is not more than a param but as close to it as possible

      Parameters

      Returns MSAA_QUALITY

      • recommended number of samples
    • Disposes all framebuffers, but not textures bound to them.

      Parameters

      • OptionalcontextLost: boolean

        If context was lost, we suppress all delete function calls

      Returns void

    • Disposes framebuffer.

      Parameters

      • framebuffer: Framebuffer

        framebuffer that has to be disposed of

      • OptionalcontextLost: boolean

        If context was lost, we suppress all delete function calls

      Returns void

    • Protected

      Initialize framebuffer for this context

      Parameters

      Returns GLFramebuffer

      • created GLFramebuffer
    • Resets framebuffer stored state, binds screen framebuffer. Should be called before renderTexture reset().

      Returns void

    • Protected

      Resize the framebuffer

      Parameters

      Returns void

    • Set the WebGLRenderingContext's viewport.

      Parameters

      • x: number

        X position of viewport

      • y: number

        Y position of viewport

      • width: number

        Width of viewport

      • height: number

        Height of viewport

      Returns void

    • Protected

      Update the framebuffer

      Parameters

      Returns void