Class Texture

constructor

• new Texture(base?: BaseTexture): Texture

  Parameters

  • Optionalbase: BaseTexture

  Returns Texture

Optionalbase

flipY

glTexture

isAtlas

isRotated

offsetX

offsetY

rawHeight

rawWidth

scale

uvH

uvW

uvX

uvY

height

• get height(): number

  Returns number

width

• get width(): number

  Returns number

clone

• clone(target?: Texture): Texture

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

  Parameters

  • Optionaltarget: Texture

  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,
      gap?: 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.

  • gap: number = 0

    Optional pixel gap between cells.

  Returns Texture[]

  An array of split Textures.

StaticfromImageSource

• fromImageSource(
      render: Rapid,
      source: Images,
      options?: ITextureOptions,
  ): Texture

  Creates a Texture directly from an image source, bypassing the TextureManager.

  Parameters

  • render: Rapid
  • source: Images

    The image element, canvas, video, or bitmap.

  • options: ITextureOptions = {}

    Optional antialias and wrap mode settings.

  Returns Texture