pixi.js
    Preparing search index...

    Class RenderTextureAdvanced

    A render texture, extends Texture.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    defaultAnchor?: { x: number; y: number }

    Anchor point that is used as default if sprite is created with this texture. Changing the defaultAnchor at a later point of time will not update Sprite's anchor point.

    {0,0}
    
    defaultBorders?: TextureBorders

    Default width of the non-scalable border that is used if 9-slice plane is created with this texture.

    7.2.0

    NineSliceSprite

    destroyed: boolean

    Has the texture been destroyed?

    dynamic: boolean = false

    Set to true if you plan on modifying the uvs of this texture. When this is the case, sprites and other objects using the texture will make sure to listen for changes to the uvs and update their vertices accordingly.

    frame: Rectangle = ...

    This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering, irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)

    isTexture: true

    is it a texture? yes! used for type checking

    label?: string

    label used for debugging

    noFrame: boolean = false

    Does this Texture have any frame data assigned to it?

    This mode is enabled automatically if no frame was passed inside constructor.

    In this mode texture is subscribed to baseTexture events, and fires update on any change.

    Beware, after loading or resize of baseTexture event can fired two times! If you want more control, subscribe on baseTexture itself.

    texture.on('update', () => {});
    
    orig: Rectangle

    This is the area of original texture, before it was put in atlas.

    rotate: number

    Indicates whether the texture is rotated inside the atlas set to 2 to compensate for texture packer rotation set to 6 to compensate for spine packer rotation can be used to rotate or mirror sprites See groupD8 for explanation

    trim: Rectangle

    This is the trimmed area of original texture, before it was put in atlas Please call updateUvs() after you change coordinates of trim manually.

    uid: number = ...

    unique id for this texture

    uvs: UVs = ...

    A uvs object based on the given frame and the texture source

    EMPTY: Texture

    an Empty Texture used internally by the engine

    from: (id: TextureSourceLike, skipCache?: boolean) => Texture

    Helper function that creates a returns Texture based on the source you provide. The source should be loaded and ready to go. If not its best to grab the asset using Assets.

    Type declaration

    a White texture used internally by the engine

    Accessors

    • get height(): number

      The height of the Texture in pixels.

      Returns number

    • get textureMatrix(): TextureMatrix

      returns a TextureMatrix instance for this texture. By default, that object is not created because its heavy.

      Returns TextureMatrix

    • get width(): number

      The width of the Texture in pixels.

      Returns number

    Methods

    • Destroys this texture

      Parameters

      • destroySource: boolean = false

        Destroy the source when the texture is destroyed.

      Returns void

    • Resizes the render texture.

      Parameters

      • width: number

        The new width of the render texture.

      • height: number

        The new height of the render texture.

      • Optionalresolution: number

        The new resolution of the render texture.

      Returns this

      This texture.

    • Call this if you have modified the texture outside of the constructor.

      If you have modified this texture's source, you must separately call texture.source.update() to see those changes.

      Returns void

    • Call this function when you have modified the frame of this texture.

      Returns void