类 Texture

En

The Texture is a texture processing class.

Zh

Texture 是一个纹理处理类。

层级 (查看层级一览)

构造函数

constructor

属性

_id destroyedImmediately lock? name? offsetX offsetY scaleRate sourceHeight sourceWidth url uuid uvrect DEBUG DEF_UV INV_UV NO_UV

访问器

bitmap cpuMemory deps destroyed gpuMemory height id obsolute referenceCount uv valid width cpuMemory gpuMemory

方法

_clearReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps destroy disposeBitmap event getCachedClip getPixels getTexturePixels hasListener isCreateFromURL load off offAll offAllCaller on once recoverBitmap setTo create createFromTexture destroyUnusedResources

构造函数

constructor

  • new Texture(
        source?: BaseTexture | Texture,
        uv?: ArrayLike<number>,
        sourceWidth?: number,
        sourceHeight?: number,
    ): Texture

    参数

    • source: BaseTexture | Texture = null

      Bitmap resource.

    • uv: ArrayLike<number> = null

      UV data information.

    • sourceWidth: number = 0

      Original width of the texture.

    • sourceHeight: number = 0

      Original height of the texture.

    返回 Texture

    En

    Creates an instance of Texture class.

    Zh

    创建 Texture 类的新实例

属性

_id

_id: number = 0

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

offsetX

offsetX: number = 0

En

The offset along the X-axis.

Zh

沿 X 轴的偏移量。

offsetY

offsetY: number = 0

En

The offset along the Y-axis.

Zh

沿 Y 轴的偏移量。

scaleRate

scaleRate: number = 1

En

The scale rate of the texture.

Zh

纹理的缩放率。

sourceHeight

sourceHeight: number = 0

En

The original height of the texture, including any transparent areas that have been cropped out.

Zh

包括已被裁剪掉的透明区域的纹理原始高度。

sourceWidth

sourceWidth: number = 0

En

The original width of the texture, including any transparent areas that have been cropped out.

Zh

包括已被裁剪掉的透明区域的纹理原始宽度。

url

url: string

En

The URL of the texture image.

Zh

纹理图片的地址。

uuid

uuid: string

En

The UUID of the texture.

Zh

纹理的 UUID。

uvrect

uvrect: number[] = ...

En

Range of UV

Zh

uv的范围

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

静态 只读DEF_UV

DEF_UV: Float32Array = ...

En

Default UV information.

Zh

默认 UV 信息。

静态 只读INV_UV

INV_UV: Float32Array = ...

En

Inverse UV information.

Zh

反转 UV 信息。

静态 只读NO_UV

NO_UV: Float32Array = ...

En

No UV information.

Zh

无 UV 信息

访问器

bitmap

cpuMemory

deps

destroyed

gpuMemory

height

id

obsolute

  • get obsolute(): boolean

    返回 boolean

    En

    Whether the texture is considered obsolete.

    Zh

    纹理是否被认为是过时的。

  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。

referenceCount

uv

valid

width

静态cpuMemory

静态gpuMemory

方法

_clearReference

_setCPUMemory

_setCreateURL

  • _setCreateURL(url: string, uuid?: string): void

    参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDep

addDeps

destroy

disposeBitmap

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

getCachedClip

  • getCachedClip(x: number, y: number, width: number, height: number): Texture

    参数

    • x: number

      The x-coordinate of the clip area.

    • y: number

      The y-coordinate of the clip area.

    • width: number

      The width of the clip area.

    • height: number

      The height of the clip area.

    返回 Texture

    A Texture object representing the clipped sub-texture, or null if the clip area is out of bounds.

    En

    Retrieves a clipped sub-texture from this texture and caches it for future access.

    Zh

    从当前纹理获取裁剪后的子纹理，并将其缓存以供将来访问。

getPixels

  • getPixels(x: number, y: number, width: number, height: number): Uint8Array

    参数

    • x: number

      The x-coordinate of the area.

    • y: number

      The y-coordinate of the area.

    • width: number

      The width of the area.

    • height: number

      The height of the area.

    返回 Uint8Array

    A Uint8Array containing the pixel data.

    En

    Retrieves the pixel data from a specific area of the Texture.

    Zh

    从 Texture 的特定区域获取像素点集合。

getTexturePixels

  • getTexturePixels(
        x: number,
        y: number,
        width: number,
        height: number,
    ): Uint8Array

    参数

    • x: number

      The x-coordinate of the region.

    • y: number

      The y-coordinate of the region.

    • width: number

      The width of the region.

    • height: number

      The height of the region.

    返回 Uint8Array

    A Uint8Array containing the pixel data.

    En

    Retrieves the pixel data from a region of the texture.

    Zh

    从纹理的特定区域获取像素数据。

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url: string): boolean

    参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

load

  • load(url: string, complete?: Handler): Promise<void>

    参数

    • url: string

      The URL of the image to load.

    • 可选complete: Handler

      An optional callback function that is called when the image is loaded.

    返回 Promise<void>

    A promise that resolves to the loaded image.

    En

    Loads an image from the specified URL.

    Zh

    从指定的 URL 加载图片。

off

  • off(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

  • off(
        type: string,
        caller: any,
        listener?: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • 可选listener: Function

      The listener function.

    • 可选args: any[]

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

offAll

  • offAll(type?: string): EventDispatcher

    参数

    • 可选type: string

      (Optional) The type of event. If the value is null, all types of listeners on this object are removed.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove all listeners of the specified event type from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除指定事件类型的所有侦听器。

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

recoverBitmap

  • recoverBitmap(callback?: () => void): void

    参数

    • 可选callback: () => void

      An optional callback function to call after the bitmap is recovered.

    返回 void

    En

    Forces the recovery of the bitmap from the URL.

    Zh

    通过 URL 强制恢复 bitmap。

setTo

  • setTo(
        bitmap?: BaseTexture,
        uv?: ArrayLike<number>,
        sourceWidth?: number,
        sourceHeight?: number,
    ): void

    参数

    • bitmap: BaseTexture = null

      The bitmap resource.

    • uv: ArrayLike<number> = null

      The UV data information.

    • sourceWidth: number = 0

      The original width of the texture.

    • sourceHeight: number = 0

      The original height of the texture.

    返回 void

    En

    Sets the bitmap resource and UV data information for this object.

    Zh

    设置此对象的位图资源和 UV 数据信息。

静态create

  • create(
        source: BaseTexture | Texture,
        x: number,
        y: number,
        width: number,
        height: number,
        offsetX?: number,
        offsetY?: number,
        sourceWidth?: number,
        sourceHeight?: number,
    ): Texture

    参数

    • source: BaseTexture | Texture

      The source texture, either a Texture2D or a Texture object.

    • x: number

      The starting absolute x coordinate.

    • y: number

      The starting absolute y coordinate.

    • width: number

      The absolute width.

    • height: number

      The absolute height.

    • offsetX: number = 0

      The offset on the X-axis (optional). It is the position of [x, y] relative to the original small image. Generally, it is positive, indicating that the size of the blank edge has been cut off. If it is negative, it usually indicates that a protective edge has been added

    • offsetY: number = 0

      The offset on the Y-axis (optional).

    • sourceWidth: number = 0

      The original width, including any cropped transparent areas (optional).

    • sourceHeight: number = 0

      The original height, including any cropped transparent areas (optional).

    返回 Texture

    A Texture object.

    En

    Creates a Texture object based on the specified source, coordinates, dimensions, and offsets.

    Zh

    根据指定的资源、坐标、宽高和偏移量等创建 Texture 对象。

静态createFromTexture

  • createFromTexture(
        texture: Texture,
        x: number,
        y: number,
        width: number,
        height: number,
    ): Texture

    参数

    • texture: Texture

      The target Texture to crop.

    • x: number

      The x position relative to the target Texture.

    • y: number

      The y position relative to the target Texture.

    • width: number

      The width to crop.

    • height: number

      The height to crop.

    返回 Texture

    A new Texture or null if the areas do not intersect.

    En

    Creates a new Texture by cropping a part of an existing Texture. If the two areas do not intersect, it returns null.

    Zh

    截取 Texture 的一部分区域，生成一个新的 Texture，如果两个区域没有相交，则返回 null。

静态destroyUnusedResources

显示设置

成员可见性

目录

构造函数
属性
访问器
方法