TextureBase | DuckEngine

Type parameters

type: Duck.Types.Texture.Type

Hierarchy

TextureBase

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextureBase<type>(type: "image", dataType: DataType, texture: HTMLImageElement, w: number, h: number): TextureBase<type>
new TextureBase<type>(type: "color", dataType: DataType, texture: string, w: number, h: number): TextureBase<type>
new TextureBase<type>(type: "either", dataType: DataType, texture: string | HTMLImageElement, w: number, h: number): TextureBase<type>

- Defined in core/texture/textureBase.ts:59
description
Creates an image texture

since
2.1.0

Type parameters
- type: Duck.Types.Texture.Type
Parameters
- type: "image"
  
  Texture type
- dataType: DataType
- texture: HTMLImageElement
  
  Texture source
- w: number
  
  Width of texture
- h: number
  
  Height of texture
Returns TextureBase<type>
- Defined in core/texture/textureBase.ts:76
description
Creates a color texture

since
2.1.0

Type parameters
- type: Duck.Types.Texture.Type
Parameters
- type: "color"
  
  Texture type
- dataType: DataType
- texture: string
  
  Texture source
- w: number
  
  Width of texture
- h: number
  
  Height of texture
Returns TextureBase<type>
- Defined in core/texture/textureBase.ts:93
description
Creates a color or image texture

since
2.1.0

Type parameters
- type: Duck.Types.Texture.Type
Parameters
- type: "either"
  
  Texture type
- dataType: DataType
- texture: string | HTMLImageElement
  
  Texture source
- w: number
  
  Width of texture
- h: number
  
  Height of texture
Returns TextureBase<type>

Properties

Readonly dataType

dataType: DataType

memberof: TextureBase
description: The data type of texture, 'sheet' | 'base' | 'atlas' | 'list'
since: 2.1.0

Readonly id

id: string

memberof: TextureBase
description: The unique identifier for the texture
since: 2.1.0

scale

scale: Vector2

memberof: Texture
description: The scale of the texture
since: 2.1.0

texture

texture: type extends "image" ? HTMLImageElement : type extends "either" ? string | HTMLImageElement : string

memberof: TextureBase
description: The texture itself, can be an image or color
since: 2.1.0

type

type: Duck.Types.Texture.Type

memberof: TextureBase
description: The type of texture source, 'image' | 'color' | 'either'
since: 2.1.0

Methods

setFillColor

setFillColor(color: string | number): void

- Defined in core/texture/textureBase.ts:169
memberof
Texture

description
Sets the Texture color if the type is color

since
2.1.0

Parameters
- color: string | number
  
  New color of the texture
Returns void

setImagePath

setImagePath(imagePath: string): void

- Defined in core/texture/textureBase.ts:157
memberof
Texture

description
Sets the Texture Image Path if the type is image

since
2.1.0

Parameters
- imagePath: string
  
  New imagePath of the texture
Returns void

setScale

setScale(scale: Scale): Vector2

- Defined in core/texture/textureBase.ts:140
memberof
Texture

description
Sets the Texture Scale

since
2.1.0

Parameters
- scale: Scale
  
  New scale of the texture
Returns Vector2

Static fromColor

fromColor(color: string, w: number, h: number): TextureBase<"color">

- Defined in core/texture/textureBase.ts:185
memberof
TextureBase

description
Creates a new TextureBase instance from a color

static
since
2.1.0

Parameters
- color: string
  
  Color
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"color">

Static fromEither

fromEither(fillColorOrIMGPath: string, w: number, h: number): TextureBase<"either">

- Defined in core/texture/textureBase.ts:216
memberof
TextureBase

description
Creates a new TextureBase instance from a color or an image path

static
since
2.1.0

Parameters
- fillColorOrIMGPath: string
  
  Color or Image path
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"either">

Static fromTexture

fromTexture(imgpath: string, w: number, h: number): TextureBase<"image">

- Defined in core/texture/textureBase.ts:199
memberof
TextureBase

description
Creates a new TextureBase instance from an image path

static
since
2.1.0

Parameters
- imgpath: string
  
  Image path
- w: number
  
  Width
- h: number
  
  Height
Returns TextureBase<"image">

Type parameters

type: Duck.Types.Texture.Type

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

type: Duck.Types.Texture.Type

Parameters

type: "image"

dataType: DataType

texture: HTMLImageElement

w: number

h: number

Returns TextureBase<type>

Type parameters

type: Duck.Types.Texture.Type

Parameters

type: "color"

dataType: DataType

texture: string

w: number

h: number

Returns TextureBase<type>

Type parameters

type: Duck.Types.Texture.Type

Parameters

type: "either"

dataType: DataType

texture: string | HTMLImageElement

w: number

h: number

Returns TextureBase<type>

Properties

Readonly dataType

Readonly id

scale

texture

type

Methods

setFillColor

Parameters

color: string | number

Returns void

setImagePath

Parameters

imagePath: string

Returns void

setScale

Parameters

scale: Scale

Returns Vector2

Static fromColor

Parameters

color: string

w: number

h: number

Returns TextureBase<"color">

Static fromEither

Parameters

fillColorOrIMGPath: string

w: number

h: number

Returns TextureBase<"either">

Static fromTexture

Parameters

imgpath: string

w: number

h: number

Returns TextureBase<"image">