API Docs for: 1.4.0
Show:

Kiwi.Textures.SingleImage Class

Extends TextureAtlas
Defined in: src\textures\SingleImage.ts:10
Module: Textures
Parent Module: Kiwi

A special type of TextureAtlas that is used when the user has loaded a single image. This type of TextureAtlas contains only one cell which is generally the whole width/height of the image and starts at the coordinates 0/0. A SingleImage has a space to store sequences but this will not be used.

Constructor

Kiwi.Textures.SingleImage

(
  • name
  • image
  • [width]
  • [height]
  • [offsetX]
  • [offsetY]
)
Kiwi.SingleImage

Defined in src\textures\SingleImage.ts:10

Parameters:

  • name String

    The name of the single image

  • image HTMLImageElement/HTMLCanvasElement

    the image that is being used.

  • [width] Number optional

    the width of the image

  • [height] Number optional

    the height of the image

  • [offsetX] Number optional

    the offset of the image on the x axis. Useful if the image has a border that you don't want to show.

  • [offsetY] Number optional

    the offset of the image of the y axis. Useful if the image has a border that you don't want to show.

Returns:

Kiwi.SingleImage:

Item Index

Methods

Properties

Methods

generateAtlasCells

() Array public

Defined in src\textures\SingleImage.ts:78

This method generates the single image cell based off the information that was passed during instantion.

Returns:

Array:

objType

() String public

Defined in src\textures\SingleImage.ts:36

The type of object that this is.

Returns:

String:

"SingleImage"

Properties

height

Number private

Defined in src\textures\SingleImage.ts:54

The height of the image.

offsetX

Number private

Defined in src\textures\SingleImage.ts:62

The offset for the image on the X axis.

offsetY

Number private

Defined in src\textures\SingleImage.ts:70

The offset for the image on the Y axis.

width

Number private

Defined in src\textures\SingleImage.ts:46

The width of the image.