phaser - v3.90.0
    Preparing search index...

    A Render Target encapsulates a WebGL framebuffer and the WebGL Texture that displays it.

    Instances of this class are typically created by, and belong to WebGL Pipelines, however other Game Objects and classes can take advantage of Render Targets as well.

    Index

    Constructors

    • Parameters

      • renderer: WebGLRenderer

        A reference to the WebGLRenderer.

      • width: number

        The width of this Render Target.

      • height: number

        The height of this Render Target.

      • Optionalscale: number

        A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer. Default 1.

      • OptionalminFilter: number

        The minFilter mode of the texture when created. 0 is LINEAR, 1 is NEAREST. Default 0.

      • OptionalautoClear: boolean

        Automatically clear this framebuffer when bound? Default true.

      • OptionalautoResize: boolean

        Automatically resize this Render Target if the WebGL Renderer resizes? Default false.

      • OptionaladdDepthBuffer: boolean

        Add a DEPTH_STENCIL and attachment to this Render Target? Default true.

      • OptionalforceClamp: boolean

        Force the texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two? Default true.

      Returns RenderTarget

    Properties

    autoClear: boolean

    Controls if this Render Target is automatically cleared (via gl.COLOR_BUFFER_BIT) during the RenderTarget.bind method.

    If you need more control over how, or if, the target is cleared, you can disable this via the config on creation, or even toggle it directly at runtime.

    autoResize: boolean

    Does this Render Target automatically resize when the WebGL Renderer does?

    Modify this property via the setAutoResize method.

    destroy: any

    Removes all external references from this class and deletes the WebGL framebuffer and texture instances.

    Does not remove this Render Target from the parent pipeline.

    forceClamp: boolean

    Force the WebGL Texture to use the CLAMP_TO_EDGE wrap mode, even if a power of two?

    If false it will use gl.REPEAT instead, which may be required for some effects, such as using this Render Target as a texture for a Shader.

    The Framebuffer of this Render Target.

    This is created in the RenderTarget.resize method.

    hasDepthBuffer: boolean

    Does this Render Target have a Depth Buffer?

    height: number

    The height of the texture.

    minFilter: number

    The minFilter mode of the texture. 0 is LINEAR, 1 is NEAREST.

    renderer: WebGLRenderer

    A reference to the WebGLRenderer instance.

    scale: number

    A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.

    A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.

    The WebGLTextureWrapper of this Render Target.

    This is created in the RenderTarget.resize method.

    unbind: any

    Unbinds this Render Target and optionally flushes the WebGL Renderer first.

    width: number

    The width of the texture.

    Methods

    • Adjusts the GL viewport to match the width and height of this Render Target.

      Also disables SCISSOR_TEST.

      Returns void

    • Pushes this Render Target as the current frame buffer of the renderer.

      If autoClear is set, then clears the texture.

      If adjustViewport is true then it will flush the renderer and then adjust the GL viewport.

      Parameters

      • OptionaladjustViewport: boolean

        Adjust the GL viewport by calling RenderTarget.adjustViewport ? Default false.

      • Optionalwidth: number

        Optional new width of this Render Target.

      • Optionalheight: number

        Optional new height of this Render Target.

      Returns void

    • Clears a portion or everything from this Render Target. To clear an area, specify the x, y, width and height.

      Parameters

      • Optionalx: number

        The left coordinate of the fill rectangle. Default 0.

      • Optionaly: number

        The top coordinate of the fill rectangle. Default 0.

      • Optionalwidth: number

        The width of the fill rectangle. Default this.width.

      • Optionalheight: number

        The height of the fill rectangle. Default this.height.

      Returns void

    • Sets up this Render Target to the given width and height, creating a new frame buffer and texture. This method is called automatically by the constructor and at no other time.

      Parameters

      • width: number

        The new width of this Render Target.

      • height: number

        The new height of this Render Target.

      Returns void

    • Resizes this Render Target as long as the given width and height are different to the current width and height.

      Deletes both the frame buffer and texture, if they exist and then re-creates them using the new sizes.

      This method is called automatically by the pipeline during its resize handler.

      Parameters

      • width: number

        The new width of this Render Target.

      • height: number

        The new height of this Render Target.

      Returns this

    • Sets if this Render Target should automatically resize when the WebGL Renderer emits a resize event.

      Parameters

      • autoResize: boolean

        Automatically resize this Render Target when the WebGL Renderer resizes?

      Returns this

    • Checks if this Render Target will resize, or not, if given the new width and height values.

      Parameters

      • width: number

        The new width of this Render Target.

      • height: number

        The new height of this Render Target.

      Returns boolean