Class: TextureStyle

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

A texture style describes how a texture should be sampled by a shader.

Advanced

Extends

• EventEmitter<{ change: TextureStyle; destroy: TextureStyle; }>

Implements

• BindResource

Constructors

Constructor

> new TextureStyle(options?): TextureStyle

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

Parameters

options?

TextureStyleOptions

options for the style

Returns

TextureStyle

Overrides

EventEmitter.constructor

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.

---

_resourceType

> _resourceType: string

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

Internal

Implementation of

BindResource._resourceType

---

_touched

> _touched: number

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

Internal

Implementation of

BindResource._touched

---

addressModeU?

> optional addressModeU?: WRAP_MODE

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

---

addressModeV?

> optional addressModeV?: WRAP_MODE

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

---

addressModeW?

> optional addressModeW?: WRAP_MODE

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

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

---

compare?

> optional compare?: COMPARE_FUNCTION

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

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.

---

destroyed

> readonly destroyed: boolean

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

Has the style been destroyed?

Implementation of

BindResource.destroyed

---

lodMaxClamp?

> optional lodMaxClamp?: number

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

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

---

lodMinClamp?

> optional lodMinClamp?: number

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

---

magFilter?

> optional magFilter?: SCALE_MODE

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

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

---

minFilter?

> optional minFilter?: SCALE_MODE

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

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

---

mipmapFilter?

> optional mipmapFilter?: SCALE_MODE

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

Specifies behavior for sampling between mipmap levels.

---

defaultOptions

> readonly static defaultOptions: TextureStyleOptions

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

default options for the style

---

prefixed

> static prefixed: string | boolean

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

Inherited from

EventEmitter.prefixed

Accessors

addressMode

Get Signature

> get addressMode(): WRAP_MODE

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

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

Returns

WRAP_MODE

Set Signature

> set addressMode(value): void

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

Parameters

value

WRAP_MODE

Returns

void

---

maxAnisotropy

Get Signature

> get maxAnisotropy(): number

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

Returns

number

Set Signature

> set maxAnisotropy(value): void

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

Specifies the maximum anisotropy value clamp used by the sampler.

Parameters

value

number

Returns

void

---

scaleMode

Get Signature

> get scaleMode(): SCALE_MODE

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

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

Returns

SCALE_MODE

Set Signature

> set scaleMode(value): void

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

Parameters

value

SCALE_MODE

Returns

void

---

wrapMode

Get Signature

> get wrapMode(): WRAP_MODE

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

Returns

WRAP_MODE

Set Signature

> set wrapMode(value): void

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

Parameters

value

WRAP_MODE

Returns

void

Methods

addListener()

> 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

EventEmitter.addListener

---

destroy()

> destroy(): void

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

Destroys the style

Returns

void

---

emit()

> 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

EventEmitter.emit

---

eventNames()

> 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

EventEmitter.eventNames

---

listenerCount()

> 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

EventEmitter.listenerCount

---

listeners()

> 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

EventEmitter.listeners

---

off()

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

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

todo

Type Parameters

T

T extends "change" | "destroy"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Implementation of

BindResource.off

Inherited from

EventEmitter.off

---

on()

> 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

Implementation of

BindResource.on

Inherited from

EventEmitter.on

---

once()

> 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

EventEmitter.once

---

removeAllListeners()

> 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

EventEmitter.removeAllListeners

---

removeListener()

> 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

EventEmitter.removeListener

---

update()

> update(): void

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

Returns

void