Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StandardMaterialOcclusionTexture

Represents a texture which holds specific data for a occlusion map.

Hierarchy

Index

Constructors

constructor

  • new StandardMaterialOcclusionTexture(baseTexture: BaseTexture<Resource, IAutoDetectOptions>, strength?: number, uvSet?: number): StandardMaterialOcclusionTexture

Properties

_frame

_frame: Rectangle

Protected _rotate

_rotate: number

_updateID

_updateID: number

_uvs

_uvs: TextureUvs

baseTexture

baseTexture: BaseTexture<Resource, IAutoDetectOptions>

defaultAnchor

defaultAnchor: Point

noFrame

noFrame: boolean

orig

orig: Rectangle

Optional patternCache

patternCache?: {}

Type declaration

  • [key: string]: CanvasPattern

Optional strength

strength?: number

textureCacheIds

textureCacheIds: string[]

Optional tintCache

tintCache?: {}

Type declaration

  • [key: string]: HTMLCanvasElement | HTMLImageElement

Optional transform

transform?: TextureTransform

The transform to use for this texture.

trim

trim: Rectangle

uvMatrix

uvMatrix: TextureMatrix

Optional uvSet

uvSet?: number

valid

valid: boolean

Static Readonly EMPTY

EMPTY: Texture<CanvasResource>

Static Readonly WHITE

WHITE: Texture<CanvasResource>

Static prefixed

prefixed: string | boolean

Accessors

frame

  • get frame(): Rectangle
  • set frame(frame: Rectangle): void
  • The frame specifies the region of the base texture that this texture uses. Please call updateUvs() after you change coordinates of frame manually.

    member

    {PIXI.Rectangle}

    Returns Rectangle

  • The frame specifies the region of the base texture that this texture uses. Please call updateUvs() after you change coordinates of frame manually.

    member

    {PIXI.Rectangle}

    Parameters

    • frame: Rectangle

    Returns void

height

  • get height(): number
  • The height of the Texture in pixels.

    member

    {number}

    Returns number

resolution

  • get resolution(): number
  • Returns resolution of baseTexture

    member

    {number}

    readonly

    Returns number

rotate

  • get rotate(): number
  • set rotate(rotate: number): void
  • Indicates whether the texture is rotated inside the atlas set to 2 to compensate for texture packer rotation set to 6 to compensate for spine packer rotation can be used to rotate or mirror sprites See {@link PIXI.groupD8} for explanation

    member

    {number}

    Returns number

  • Indicates whether the texture is rotated inside the atlas set to 2 to compensate for texture packer rotation set to 6 to compensate for spine packer rotation can be used to rotate or mirror sprites See {@link PIXI.groupD8} for explanation

    member

    {number}

    Parameters

    • rotate: number

    Returns void

width

  • get width(): number
  • The width of the Texture in pixels.

    member

    {number}

    Returns number

Methods

addListener

castToBaseTexture

  • castToBaseTexture(): BaseTexture<Resource, IAutoDetectOptions>
  • Utility function for BaseTexture|Texture cast

    Returns BaseTexture<Resource, IAutoDetectOptions>

clone

  • clone(): Texture<Resource>
  • Creates a new texture object that acts the same as this one.

    Returns Texture<Resource>

    The new texture

destroy

  • destroy(destroyBase?: boolean): void
  • Destroys this texture

    Parameters

    • Optional destroyBase: boolean

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

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

    Returns (string | symbol)[]

listenerCount

  • listenerCount(event: string | symbol): number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): ListenerFn[]
  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

    Returns ListenerFn[]

off

on

Protected onBaseTextureUpdated

  • onBaseTextureUpdated(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void
  • Called when the base texture is updated

    Parameters

    • baseTexture: BaseTexture<Resource, IAutoDetectOptions>

      The base texture.

    Returns void

once

removeAllListeners

removeListener

update

  • update(): void
  • Updates this texture on the gpu.

    Calls the TextureResource update.

    If you adjusted frame manually, please call updateUvs() instead.

    Returns void

updateUvs

  • updateUvs(): void
  • Updates the internal WebGL UV cache. Use it after you change frame or trim of the texture. Call it after changing the frame

    Returns void

Static addToCache

  • addToCache(texture: Texture<Resource>, id: string): void
  • Adds a Texture to the global TextureCache. This cache is shared across the whole PIXI object.

    static

    Parameters

    • texture: Texture<Resource>

      The Texture to add to the cache.

    • id: string

      The id that the Texture will be stored against.

    Returns void

Static from

  • from<R, RO>(source: TextureSource, options?: IBaseTextureOptions<RO>, strict?: boolean): Texture<R>
  • Helper function that creates a new Texture based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture

    static

    Type parameters

    • R: Resource<R> = Resource

    • RO = any

    Parameters

    • source: TextureSource
      •   Source to create texture from
        
    • Optional options: IBaseTextureOptions<RO>
    • Optional strict: boolean

    Returns Texture<R>

    The newly created texture

Static fromBuffer

  • fromBuffer(buffer: Float32Array | Uint8Array, width: number, height: number, options?: IBaseTextureOptions<ISize>): Texture<BufferResource>
  • Create a new Texture with a BufferResource from a Float32Array. RGBA values are floats from 0 to 1.

    static

    Parameters

    • buffer: Float32Array | Uint8Array

      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

    • Optional options: IBaseTextureOptions<ISize>

    Returns Texture<BufferResource>

    The resulting new BaseTexture

Static fromLoader

  • fromLoader<R>(source: string | HTMLImageElement | HTMLCanvasElement, imageUrl: string, name?: string, options?: IBaseTextureOptions<any>): Promise<Texture<R>>
  • Create a texture from a source and add to the cache.

    static

    Type parameters

    • R: Resource<R> = Resource

    Parameters

    • source: string | HTMLImageElement | HTMLCanvasElement

      The input source.

    • imageUrl: string

      File name of texture, for cache and resolving resolution.

    • Optional name: string
    • Optional options: IBaseTextureOptions<any>

    Returns Promise<Texture<R>>

    Output texture

Static fromURL

  • fromURL<R, RO>(url: string, options?: IBaseTextureOptions<RO>): Promise<Texture<R>>
  • Useful for loading textures via URLs. Use instead of Texture.from because it does a better job of handling failed URLs more effectively. This also ignores PIXI.settings.STRICT_TEXTURE_CACHE. Works for Videos, SVGs, Images.

    Type parameters

    • R: Resource<R> = Resource

    • RO = any

    Parameters

    • url: string

      The remote URL to load.

    • Optional options: IBaseTextureOptions<RO>

    Returns Promise<Texture<R>>

    A Promise that resolves to a Texture.

Static removeFromCache

  • removeFromCache(texture: string | Texture<Resource>): null | Texture<Resource>
  • Remove a Texture from the global TextureCache.

    static

    Parameters

    • texture: string | Texture<Resource>

      id of a Texture to be removed, or a Texture instance itself

    Returns null | Texture<Resource>

    The Texture that was removed

Generated using TypeDoc