Interface: TextureStyleOptions

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:9

The options for the texture style.

Advanced

Extends

• Partial<TextureStyle>

Extended by

• TextureSourceOptions

Properties

_maxAnisotropy?

> optional _maxAnisotropy?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:93

Internal

Specifies the maximum anisotropy value clamp used by the sampler. Note: Most implementations support TextureStyle#maxAnisotropy values in range between 1 and 16, inclusive. The used value of TextureStyle#maxAnisotropy will be clamped to the maximum value that the platform supports.

Inherited from

TextureStyle._maxAnisotropy

---

_resourceId?

> optional _resourceId?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:114

Inherited from

Partial._resourceId

---

_resourceType?

> optional _resourceType?: string

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:57

Internal

Inherited from

TextureStyle._resourceType

---

_touched?

> optional _touched?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:59

Internal

Inherited from

TextureStyle._touched

---

addListener?

> optional addListener?: <T>(event, fn, context?) => this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Partial.addListener

---

addressMode?

> optional addressMode?: WRAP_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:11

setting this will set wrapModeU,wrapModeV and wrapModeW all at once!

Overrides

Partial.addressMode

---

addressModeU?

> optional addressModeU?: WRAP_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:13

specifies the address modes for the texture width, height, and depth coordinates, respectively.

Overrides

TextureStyle.addressModeU

---

addressModeV?

> optional addressModeV?: WRAP_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:15

specifies the address modes for the texture width, height, and depth coordinates, respectively.

Overrides

TextureStyle.addressModeV

---

addressModeW?

> optional addressModeW?: WRAP_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:17

Specifies the address modes for the texture width, height, and depth coordinates, respectively.

Overrides

TextureStyle.addressModeW

---

compare?

> optional compare?: COMPARE_FUNCTION

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:36

When provided the sampler will be a comparison sampler with the specified COMPARE_FUNCTION. Note: Comparison samplers may use filtering, but the sampling results will be implementation-dependent and may differ from the normal filtering rules.

Overrides

TextureStyle.compare

---

destroy?

> optional destroy?: () => void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:118

Destroys the style

Returns

void

Inherited from

TextureStyle.destroy

---

destroyed?

> readonly optional destroyed?: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:98

Has the style been destroyed?

Inherited from

TextureStyle.destroyed

---

emit?

> optional emit?: <T>(event, ...args) => boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

args

...ArgumentMap<{ change: TextureStyle; destroy: TextureStyle; }>[Extract<T, "change" | "destroy">]

Returns

boolean

Inherited from

Partial.emit

---

eventNames?

> optional eventNames?: () => ("change" | "destroy")[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

("change" | "destroy")[]

Inherited from

Partial.eventNames

---

listenerCount?

> optional listenerCount?: (event) => number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"change" | "destroy"

Returns

number

Inherited from

Partial.listenerCount

---

listeners?

> optional listeners?: <T>(event) => (...args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

Returns

(...args) => void[]

Inherited from

Partial.listeners

---

lodMaxClamp?

> optional lodMaxClamp?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:29

Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

Overrides

TextureStyle.lodMaxClamp

---

lodMinClamp?

> optional lodMinClamp?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:27

specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

Overrides

TextureStyle.lodMinClamp

---

magFilter?

> optional magFilter?: SCALE_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:21

specifies the sampling behavior when the sample footprint is smaller than or equal to one texel.

Overrides

TextureStyle.magFilter

---

maxAnisotropy?

> optional maxAnisotropy?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:45

Specifies the maximum anisotropy value clamp used by the sampler. Note: Most implementations support TextureStyle#maxAnisotropy values in range between 1 and 16, inclusive. The used value of TextureStyle#maxAnisotropy will be clamped to the maximum value that the platform supports.

setting this to anything higher than 1 will set scale modes to 'linear'

Overrides

Partial.maxAnisotropy

---

minFilter?

> optional minFilter?: SCALE_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:23

specifies the sampling behavior when the sample footprint is larger than one texel.

Overrides

TextureStyle.minFilter

---

mipmapFilter?

> optional mipmapFilter?: SCALE_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:25

specifies behavior for sampling between mipmap levels.

Overrides

TextureStyle.mipmapFilter

---

off?

> optional off?: <T>(event, fn?, context?, once?) => this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

Partial.off

---

on?

> optional on?: <T>(event, fn, context?) => this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Partial.on

---

once?

> optional once?: <T>(event, fn, context?) => this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Partial.once

---

removeAllListeners?

> optional removeAllListeners?: (event?) => this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"change" | "destroy"

Returns

this

Inherited from

Partial.removeAllListeners

---

removeListener?

> optional removeListener?: <T>(event, fn?, context?, once?) => this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

Partial.removeListener

---

scaleMode?

> optional scaleMode?: SCALE_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:19

setting this will set magFilter,minFilter and mipmapFilter all at once!

Overrides

Partial.scaleMode

---

update?

> optional update?: () => void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:115

Returns

void

Inherited from

TextureStyle.update

---

wrapMode?

> optional wrapMode?: WRAP_MODE

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureStyle.d.ts:106

Inherited from

Partial.wrapMode