Class TextTexture

Optionalbase

glTexture

height

padding

scale

uvH

uvW

uvX

uvY

width

clone

• clone(): Texture

  Creates a shallow copy of this Texture, sharing the same BaseTexture.

  Returns Texture

  A new Texture instance.

destroy

• destroy(): void

  Marks this Texture as destroyed, decrementing the BaseTexture reference count.

  Returns void

getSubTexture

• getSubTexture(x: number, y: number, width: number, height: number): Texture

  Creates a new Texture representing a sub-region of this Texture.

  Parameters

  • x: number

    The x coordinate in pixels, relative to this texture's logical start.

  • y: number

    The y coordinate in pixels, relative to this texture's logical start.

  • width: number

    The width of the sub-texture in pixels.

  • height: number

    The height of the sub-texture in pixels.

  Returns Texture

  A new Texture pointing to the sub-region.

setBase

• setBase(base: BaseTexture): this

  Sets the base texture and increments its reference count.

  Parameters

  • base: BaseTexture

    The BaseTexture instance.

  Returns this

  The current Texture instance.

setRegion

• setRegion(x: number, y: number, w: number, h: number): this

  Sets the visible region (clipping) in pixels relative to the BaseTexture.

  Parameters

  • x: number

    The x coordinate in pixels.

  • y: number

    The y coordinate in pixels.

  • w: number

    The width in pixels.

  • h: number

    The height in pixels.

  Returns this

  The current Texture instance.

splitGrid

• splitGrid(
      cellWidth: number,
      cellHeight: number,
      cols?: number,
      rows?: number,
  ): Texture[]

  Utility to split this texture into a grid of sprite textures. Sub-textures will respect the current UV offsets.

  Parameters

  • cellWidth: number

    The width of each cell in pixels.

  • cellHeight: number

    The height of each cell in pixels.

  • Optionalcols: number

    Optional number of columns. Truncates based on texture width if omitted.

  • Optionalrows: number

    Optional number of rows. Truncates based on texture height if omitted.

  Returns Texture[]

  An array of split Textures.

withPadding

• withPadding(pixels: number): Texture

  Returns a new Texture with the rendered quad expanded by pixels on all sides. The UV coordinates are adjusted outward so the padded border samples outside the original texture region (which is transparent when using CLAMP wrap mode).

  Use this with outline or glow shaders that need to draw beyond the texture edge.

  Parameters

  • pixels: number

    Number of pixels to expand on each side.

  Returns Texture

  Example

  const padded = catTex.withPadding(6);
  rapid.drawSprite(padded, Color.White(), false, false, outlineShader);
  Copy