stage-js
Version:
2D HTML5 Rendering and Layout
176 lines (90 loc) • 2.31 kB
Markdown
# Class: `abstract` Texture
Textures are used to clip and resize image objects.
## Extended by
- [`ImageTexture`](/api/classes/ImageTexture)
- [`PipeTexture`](/api/classes/PipeTexture)
- [`ResizableTexture`](/api/classes/ResizableTexture)
## Constructors
### new Texture()
> **new Texture**(): [`Texture`](/api/classes/Texture)
#### Returns
[`Texture`](/api/classes/Texture)
## Methods
### draw()
#### draw(context)
> **draw**(`context`): `void`
Defer draw spec to texture config. This is used when a sprite draws its textures.
##### Parameters
• **context**: `CanvasRenderingContext2D`
##### Returns
`void`
#### draw(context, dx, dy, dw, dh)
> **draw**(`context`, `dx`, `dy`, `dw`, `dh`): `void`
This is probably unused.
Note: dx, dy are added to this.dx, this.dy.
##### Parameters
• **context**: `CanvasRenderingContext2D`
• **dx**: `number`
• **dy**: `number`
• **dw**: `number`
• **dh**: `number`
##### Returns
`void`
#### draw(context, sx, sy, sw, sh, dx, dy, dw, dh)
> **draw**(`context`, `sx`, `sy`, `sw`, `sh`, `dx`, `dy`, `dw`, `dh`): `void`
This is used when a piped texture passes drawing to it backend.
Note: sx, sy, dx, dy are added to this.sx, this.sy, this.dx, this.dy.
##### Parameters
• **context**: `CanvasRenderingContext2D`
• **sx**: `number`
• **sy**: `number`
• **sw**: `number`
• **sh**: `number`
• **dx**: `number`
• **dy**: `number`
• **dw**: `number`
• **dh**: `number`
##### Returns
`void`
***
### getHeight()
> `abstract` **getHeight**(): `number`
#### Returns
`number`
***
### getWidth()
> `abstract` **getWidth**(): `number`
#### Returns
`number`
***
### setDestinationCoordinate()
> **setDestinationCoordinate**(`x`, `y`): `void`
#### Parameters
• **x**: `number`
• **y**: `number`
#### Returns
`void`
***
### setDestinationDimension()
> **setDestinationDimension**(`w`, `h`): `void`
#### Parameters
• **w**: `number`
• **h**: `number`
#### Returns
`void`
***
### setSourceCoordinate()
> **setSourceCoordinate**(`x`, `y`): `void`
#### Parameters
• **x**: `number`
• **y**: `number`
#### Returns
`void`
***
### setSourceDimension()
> **setSourceDimension**(`w`, `h`): `void`
#### Parameters
• **w**: `number`
• **h**: `number`
#### Returns
`void`