Class BaseTexture<R, RO>

A Texture stores the information that represents an image. All textures have a base texture, which contains information about the source. Therefore you can have many textures all using a single BaseTexture

Memberof

PIXI

Type Parameters

R extends Resource = Resource
The BaseTexture's Resource type.
RO = IAutoDetectOptions
The options for constructing resource.

Hierarchy (View Summary)

BaseTexture
Pixi.utils.EventEmitter
- BaseTexture
  - BaseRenderTexture

Constructors

constructor

new BaseTexture<R extends Resource = Resource, RO = IAutoDetectOptions>(
resource?: any,
options?: IBaseTextureOptions<RO>,
): BaseTexture<R, RO>
Type Parameters
- R extends Resource = Resource
- RO = IAutoDetectOptions
Parameters
- Optionalresource: any
  The current resource to use, for things that aren't Resource objects, will be converted into a Resource.
- Optionaloptions: IBaseTextureOptions<RO>
  Collection of options, default options inherited from PIXI.BaseTexture.defaultOptions.
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
Returns BaseTexture<R, RO>
Inherited from EventEmitter.constructor
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:201

Properties

_batchEnabled

_batchEnabled: number

Number of the texture batch, used by multi-texture renderers

Member

_batchLocation

_batchLocation: number

Location inside texture batch, used by multi-texture renderers

Member

alphaMode

alphaMode: ALPHA_MODES

How to treat premultiplied alpha, see PIXI.ALPHA_MODES.

Member

Default

PIXI.ALPHA_MODES.UNPACK

anisotropicLevel

anisotropicLevel: number

Anisotropic filtering level of texture

Member

Default

cacheId

cacheId: string

Currently default cache ID.

Member

`Readonly`destroyed

destroyed: boolean

Flag if BaseTexture has been destroyed.

Member

`Readonly`dirtyId

dirtyId: number

Used by TextureSystem to only update texture to the GPU when needed. Please call update() to increment it.

`Protected`dirtyStyleId

dirtyStyleId: number

Used by TextureSystem to only update texture style when needed.

format

format: FORMATS

The pixel format of the texture

Default

PIXI.FORMATS.RGBA

`Readonly`height

height: number

The height of the base texture set when the image has loaded

`Readonly`isPowerOfTwo

isPowerOfTwo: boolean

Whether or not the texture is a power of two, try to use power of two textures as much as you can

Default

false

ktxKeyValueData

ktxKeyValueData: Map<string, DataView<ArrayBufferLike>>

parentTextureArray

parentTextureArray: BaseTexture

Whether its a part of another texture, handled by ArrayResource or CubeResource

Member

`Readonly`resolution

resolution: number

The resolution / device pixel ratio of the texture

Default

PIXI.settings.RESOLUTION

`Readonly`resource

resource: R

The resource used by this BaseTexture, there can only be one resource per BaseTexture, but textures can share resources.

Member

target

target: TARGETS

The target type

Default

PIXI.TARGETS.TEXTURE_2D

`Readonly`textureCacheIds

textureCacheIds: string[]

The collection of alternative cache ids, since some BaseTextures can have more than one ID, short name and longer full URL

Member

`Protected`touched

touched: number

Used by automatic texture Garbage Collection, stores last GC tick when it was bound

type

type: TYPES

The type of resource data

Default

PIXI.TYPES.UNSIGNED_BYTE

`Protected` `Readonly`uid

uid: number

Global unique identifier for this BaseTexture

`Readonly`valid

valid: boolean

Generally speaking means when resource is loaded.

Member

`Readonly`width

width: number

The width of the base texture set when the image has loaded

`Static`_globalBatch

_globalBatch: number

Global number of the texture batch, used by multi-texture renderers.

`Static`defaultOptions

defaultOptions: IBaseTextureOptions

Default options used when creating BaseTexture objects.

Static

Memberof

PIXI.BaseTexture

`Static`prefixed

prefixed: string | boolean

Accessors

mipmap

get mipmap(): MIPMAP_MODES
Mipmap mode of the texture, affects downscaled images

Returns MIPMAP_MODES
Default
```
PIXI.MIPMAP_MODES.POW2
```
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:216
set mipmap(value: MIPMAP_MODES): void
Parameters
- value: MIPMAP_MODES
Returns void
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:217

realHeight

get realHeight(): number
Pixel height of the source of this texture

Returns number
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:211

realWidth

get realWidth(): number
Pixel width of the source of this texture

Returns number
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:206

scaleMode

get scaleMode(): SCALE_MODES
The scale mode to apply when scaling this texture

Returns SCALE_MODES
Default
```
PIXI.SCALE_MODES.LINEAR
```
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:222
set scaleMode(value: SCALE_MODES): void
Parameters
- value: SCALE_MODES
Returns void
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:223

wrapMode

get wrapMode(): WRAP_MODES
How the texture wraps

Returns WRAP_MODES
Default
```
PIXI.WRAP_MODES.CLAMP
```
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:228
set wrapMode(value: WRAP_MODES): void
Parameters
- value: WRAP_MODES
Returns void
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:229

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

castToBaseTexture

castToBaseTexture(): BaseTexture
Utility function for BaseTexture|Texture cast.

Returns BaseTexture
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:293

destroy

destroy(): void
Destroys this base texture. The method stops if resource doesn't want this texture to be destroyed. Removes texture from all caches.

Returns void
Fires
PIXI.BaseTexture#destroyed
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:284

dispose

dispose(): void
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.

Returns void
Fires
PIXI.BaseTexture#dispose
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:291

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

setRealSize

setRealSize(realWidth: number, realHeight: number, resolution?: number): this
Sets real size of baseTexture, preserves current resolution.
Parameters
- realWidth: number
  Full rendered width
- realHeight: number
  Full rendered height
- Optionalresolution: number
  Optionally set resolution
Returns this
- this
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:252

setResolution

setResolution(resolution: number): this
Changes resolution
Parameters
- resolution: number
  res
Returns this
- this
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:263

setResource

setResource(resource: R): this
Sets the resource if it wasn't set. Throws error if resource already present
Parameters
- resource: R
  that is managing this BaseTexture
Returns this
- this
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:269

setSize

setSize(desiredWidth: number, desiredHeight: number, resolution?: number): this
Changes w/h/resolution. Texture becomes valid if width and height are greater than zero.
Parameters
- desiredWidth: number
  Desired visual width
- desiredHeight: number
  Desired visual height
- Optionalresolution: number
  Optionally set resolution
Returns this
- this
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:244

setStyle

setStyle(scaleMode?: SCALE_MODES, mipmap?: MIPMAP_MODES): this
Changes style options of BaseTexture
Parameters
- OptionalscaleMode: SCALE_MODES
  Pixi scalemode
- Optionalmipmap: MIPMAP_MODES
  enable mipmaps
Returns this
- this
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:236

update

update(): void
Invalidates the object. Texture becomes valid if width and height are greater than zero.

Returns void
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:271

`Static`addToCache

addToCache(baseTexture: BaseTexture, id: string): void
Adds a BaseTexture to the global BaseTextureCache. This cache is shared across the whole PIXI object.
Parameters
- baseTexture: BaseTexture
  The BaseTexture to add to the cache.
- id: string
  The id that the BaseTexture will be stored against.
Returns void
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:332

`Static`from

from<R extends Resource = Resource, RO = IAutoDetectOptions>(
    source: string | ImageSource | string[],
    options?: IBaseTextureOptions<RO>,
    strict?: boolean,
): BaseTexture<R>
Helper function that creates a base texture based on the source you provide. The source can be - image url, image element, canvas element. If the source is an image url or an image element and not in the base texture cache, it will be created and loaded.
Type Parameters
- R extends Resource = Resource
- RO = IAutoDetectOptions
Parameters
- source: string | ImageSource | string[]
  The source to create base texture from.
- Optionaloptions: IBaseTextureOptions<RO>
  See PIXI.BaseTexture's constructor for options.
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
- Optionalstrict: boolean
  Enforce strict-mode, see PIXI.settings.STRICT_TEXTURE_CACHE.
Returns BaseTexture<R>
The new base texture.

Static
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:307

`Static`fromBuffer

fromBuffer(
    buffer: BufferType,
    width: number,
    height: number,
    options?: IBaseTextureOptions<IBufferResourceOptions>,
): BaseTexture<BufferResource>
Create a new Texture with a BufferResource from a typed array.
Parameters
- buffer: BufferType
  The optional array to use. If no data is provided, a new Float32Array is created.
- width: number
  Width of the resource
- height: number
  Height of the resource
- Optionaloptions: IBaseTextureOptions<IBufferResourceOptions>
  See PIXI.BaseTexture's constructor for options. Default properties are different from the constructor's defaults.
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
Returns BaseTexture<BufferResource>
- The resulting new BaseTexture
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:326

`Static`removeFromCache

removeFromCache(
baseTexture: string | BaseTexture<Resource, IAutoDetectOptions>,
): null | BaseTexture<Resource, IAutoDetectOptions>
Remove a BaseTexture from the global BaseTextureCache.
Parameters
- baseTexture: string | BaseTexture<Resource, IAutoDetectOptions>
  id of a BaseTexture to be removed, or a BaseTexture instance itself.
Returns null | BaseTexture<Resource, IAutoDetectOptions>
The BaseTexture that was removed.
- Defined in node_modules/@pixi/core/lib/textures/BaseTexture.d.ts:338

Class BaseTexture<R, RO>

Memberof

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

OptionalalphaMode?: ALPHA_MODES

OptionalanisotropicLevel?: number

Optionalformat?: FORMATS

Optionalheight?: number

Optionalmipmap?: MIPMAP_MODES

Optionalmultisample?: MSAA_QUALITY

OptionalpixiIdPrefix?: string

Optionalresolution?: number

OptionalresourceOptions?: RO

OptionalscaleMode?: SCALE_MODES

Optionaltarget?: TARGETS

Optionaltype?: TYPES

Optionalwidth?: number

OptionalwrapMode?: WRAP_MODES

Returns BaseTexture<R, RO>

Properties

_batchEnabled

Member

_batchLocation

Member

alphaMode

Member

Default

anisotropicLevel

Member

Default

cacheId

Member

Readonlydestroyed

Member

ReadonlydirtyId

ProtecteddirtyStyleId

format

Default

Readonlyheight

ReadonlyisPowerOfTwo

Default

ktxKeyValueData

parentTextureArray

Member

Readonlyresolution

Default

Readonlyresource

Member

target

Default

ReadonlytextureCacheIds

Member

Protectedtouched

type

Default

Protected Readonlyuid

Readonlyvalid

Member

Readonlywidth

Static_globalBatch

StaticdefaultOptions

Static

Memberof

Staticprefixed

Accessors

mipmap

Returns MIPMAP_MODES

Default

Parameters

Returns void

realHeight

`Optional`alphaMode?: ALPHA_MODES

`Optional`anisotropicLevel?: number

`Optional`format?: FORMATS

`Optional`height?: number

`Optional`mipmap?: MIPMAP_MODES

`Optional`multisample?: MSAA_QUALITY

`Optional`pixiIdPrefix?: string

`Optional`resolution?: number

`Optional`resourceOptions?: RO

`Optional`scaleMode?: SCALE_MODES

`Optional`target?: TARGETS

`Optional`type?: TYPES

`Optional`width?: number

`Optional`wrapMode?: WRAP_MODES

`Readonly`destroyed

`Readonly`dirtyId

`Protected`dirtyStyleId

`Readonly`height

`Readonly`isPowerOfTwo

`Readonly`resolution

`Readonly`resource

`Readonly`textureCacheIds

`Protected`touched

`Protected` `Readonly`uid

`Readonly`valid

`Readonly`width

`Static`_globalBatch

`Static`defaultOptions

`Static`prefixed