类 TextTexture

_id

destroyedImmediately

hdrEncodeFormat

可选lock

可选name

url

uuid

静态blackTexture

静态DEBUG

静态errorTexture

静态grayTexture

静态normalTexture

静态TEXTURE2D

静态whiteTexture

anisoLevel

• get anisoLevel(): number

  返回 number

  En

  The anisotropy value of texture

  Zh

  纹理的各向异性值

• set anisoLevel(value: number): void

  参数

  • value: number

  返回 void

baseMipmapLevel

• get baseMipmapLevel(): number

  返回 number

  En

  The base mipmap level of the texture.

  Zh

  纹理的mipmap起始等级。

• set baseMipmapLevel(value: number): void

  参数

  • value: number

  返回 void

compareMode

• get compareMode(): TextureCompareMode

  返回 TextureCompareMode

  En

  The texture compare mode.

  Zh

  贴图压缩格式

• set compareMode(value: TextureCompareMode): void

  参数

  • value: TextureCompareMode

  返回 void

cpuMemory

• get cpuMemory(): number

  返回 number

  En

  CPU memory size.

  Zh

  内存大小。

defaultTexture

• get defaultTexture(): BaseTexture

  返回 BaseTexture

  En

  The default texture.

  Zh

  默认纹理。

deps

• get deps(): readonly Resource[]

  返回 readonly Resource[]

  En

  The list of dependencies for the resource.

  Zh

  资源的依赖列表。

destroyed

• get destroyed(): boolean

  返回 boolean

  En

  Whether the resource has been destroyed.

  Zh

  是否已销毁。

dimension

• get dimension(): TextureDimension

  返回 TextureDimension

  En

  The texture dimension.

  Zh

  纹理几何属性

filterMode

• get filterMode(): FilterMode

  返回 FilterMode

  En

  The sampling filtering mode of the texture.

  Zh

  纹理的采样过滤模式。

• set filterMode(value: FilterMode): void

  参数

  • value: FilterMode

  返回 void

format

• get format(): TextureFormat

  返回 TextureFormat

  En

  The format of the texture.

  Zh

  纹理的格式。

gammaCorrection

• get gammaCorrection(): number

  返回 number

  En

  The gamma correction value of the texture. If set to 1.0, texture sampling will be linear without any correction.

  Zh

  纹理的伽马校正值。如果设置为1.0，则纹理采样将为线性，不进行任何校正。

gammaSpace

• get gammaSpace(): boolean

  返回 boolean

  En

  Gets whether the texture is using gamma space.

  Zh

  判断纹理是否使用伽马空间。

gpuMemory

• get gpuMemory(): number

  返回 number

  En

  GPU memory size.

  Zh

  显存大小。

height

• get height(): number

  返回 number

  En

  The height of the texture.

  Zh

  纹理的高度。

• set height(height: number): void

  参数

  • height: number

  返回 void

id

• get id(): number

  返回 number

  En

  Unique identifier ID, usually used for identification.

  Zh

  唯一标识ID,通常用于识别。

maxMipmapLevel

• get maxMipmapLevel(): number

  返回 number

  En

  The maximum mipmap level of the texture.

  Zh

  纹理的最大mipmap等级。

• set maxMipmapLevel(value: number): void

  参数

  • value: number

  返回 void

mipmap

• get mipmap(): boolean

  返回 boolean

  En

  Whether to generate mipmap

  Zh

  是否生成mipmap

mipmapCount

• get mipmapCount(): number

  返回 number

  En

  The number of mipmap generated for this texture.

  Zh

  为此纹理生成的mipmap数量。

obsolute

• get obsolute(): boolean

  返回 boolean

  En

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

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

  Zh

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

  • 1）getRes仍然可以返回这个资源；
  • 2）下次加载时会忽略这个缓存而去重新加载。。
• set obsolute(value: boolean): void

  参数

  • value: boolean

  返回 void

referenceCount

• get referenceCount(): number

  返回 number

  En

  The reference count of the resource.

  Zh

  资源的引用计数。

width

• get width(): number

  返回 number

  En

  The width of the texture.

  Zh

  纹理的宽度。

• set width(width: number): void

  参数

  • width: number

  返回 void

wrapModeU

• get wrapModeU(): WrapMode

  返回 WrapMode

  En

  U-direction sampling mode

  Zh

  U方向采样模式

• set wrapModeU(value: WrapMode): void

  参数

  • value: WrapMode

  返回 void

wrapModeV

• get wrapModeV(): WrapMode

  返回 WrapMode

  En

  V-direction sampling mode

  Zh

  V方向采样模式

• set wrapModeV(value: WrapMode): void

  参数

  • value: WrapMode

  返回 void

wrapModeW

• get wrapModeW(): WrapMode

  返回 WrapMode

  En

  W-direction sampling mode

  Zh

  W方向采样模式

• set wrapModeW(value: WrapMode): void

  参数

  • value: WrapMode

  返回 void

静态cpuMemory

• get cpuMemory(): number

  返回 number

  En

  The current CPU memory, in bytes.

  Zh

  当前内存，以字节为单位。

静态gpuMemory

• get gpuMemory(): number

  返回 number

  En

  The current GPU memory, in bytes.

  Zh

  当前显存，以字节为单位。

_addReference

• _addReference(count?: number): void

  参数

  • count: number = 1

    The amount by which to increment the reference count, default is 1.

  返回 void

  En

  Increments the reference count of the resource by the specified amount.

  Zh

  按指定数量增加资源的引用计数。

_clearReference

• _clearReference(): void

  返回 void

  En

  Clears the reference count of the resource.

  Zh

  清除引用

_removeReference

• _removeReference(count?: number): void

  参数

  • count: number = 1

    The amount by which to decrement the reference count, default is 1.

  返回 void

  En

  Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

  Zh

  按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

• _setCPUMemory(value: number): void

  参数

  • value: number

    The amount by which to adjust the CPU memory usage.

  返回 void

  En

  Adjusts the cpu memory usage by the specified value.

  Zh

  根据指定的值调整内存使用量。

_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

• _setGPUMemory(value: number): void

  参数

  • value: number

    The amount by which to adjust the GPU memory usage.

  返回 void

  En

  Adjusts the GPU memory usage by the specified value.

  Zh

  根据指定的值调整显存使用量。

addDep

• addDep(res: Resource): void

  增加一个依赖内容

  参数

  • res: Resource

    依赖内容

  返回 void

addDeps

• addDeps(resArr: Resource[]): void

  增加多个依赖内容

  参数

  • resArr: Resource[]

    依赖内容

  返回 void

destroy

• destroy(): void

  返回 void

  En

  Destroys the resource, the resource cannot be recovered.

  Zh

  销毁资源,销毁后资源不能恢复。

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

  派发事件。

getPixels

• getPixels(): Uint8Array

  返回 Uint8Array

  En

  Retrieves the pixel data from the texture.

  Zh

  从纹理中检索像素数据。

gpuCompressFormat

• gpuCompressFormat(): boolean

  返回 boolean

  True if the texture is in a GPU compressed format, otherwise false.

  En

  Checks if the texture is in a GPU compressed format.

  Zh

  是否是gpu压缩纹理格式

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 创建。

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

• offAllCaller(caller: any): EventDispatcher

  参数

  • caller: any

    The target caller object.

  返回 EventDispatcher

  This EventDispatcher object.

  En

  Remove all event listeners whose caller is the specified target.

  Zh

  移除caller为target的所有事件监听。

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 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

setDDSData

• setDDSData(ddsInfo: DDSTextureInfo): void

  参数

  • ddsInfo: DDSTextureInfo

    The DDS texture information containing the data to be set.

  返回 void

  En

  Sets the DDS data for the texture.

  Zh

  设置纹理的 DDS 数据。

setHDRData

• setHDRData(hdrInfo: HDRTextureInfo): void

  参数

  • hdrInfo: HDRTextureInfo

    The HDR texture information containing the data to be set.

  返回 void

  En

  Sets the HDR data for the texture.

  Zh

  设置纹理的 HDR 数据。

setImageData

• setImageData(
      source: HTMLImageElement | HTMLCanvasElement | ImageBitmap,
      premultiplyAlpha: boolean,
      invertY: boolean,
  ): void

  参数

  • source: HTMLImageElement | HTMLCanvasElement | ImageBitmap

    The image source, can be an HTMLImageElement, HTMLCanvasElement, or ImageBitmap.
  • premultiplyAlpha: boolean

    Whether to premultiply the alpha.
  • invertY: boolean

    Whether to invert the Y-axis of the image.

  返回 void

  En

  Sets the image data for the texture.

  Zh

  设置纹理的图像数据。

setKTXData

• setKTXData(ktxInfo: KTXTextureInfo): void

  参数

  • ktxInfo: KTXTextureInfo

    The KTX texture information containing the data to be set.

  返回 void

  En

  Sets the KTX data for the texture.

  Zh

  设置纹理的 KTX 数据。

setPixelsData

• setPixelsData(
      source: ArrayBufferView,
      premultiplyAlpha: boolean,
      invertY: boolean,
  ): void

  参数

  • source: ArrayBufferView

    The pixel data to be set.
  • premultiplyAlpha: boolean

    Whether to premultiply the alpha.
  • invertY: boolean

    Whether to invert the Y-axis of the pixel data.

  返回 void

  En

  Sets the pixel data for the texture.

  Zh

  设置纹理的像素数据。

setSubPixelsData

• setSubPixelsData(
      xOffset: number,
      yOffset: number,
      width: number,
      height: number,
      pixels: ArrayBufferView,
      mipmapLevel: number,
      generateMipmap: boolean,
      premultiplyAlpha: boolean,
      invertY: boolean,
  ): void

  参数

  • xOffset: number

    The x-offset for the sub-region.
  • yOffset: number

    The y-offset for the sub-region.
  • width: number

    The width of the sub-region.
  • height: number

    The height of the sub-region.
  • pixels: ArrayBufferView

    The pixel data for the sub-region.
  • mipmapLevel: number

    The mipmap level to update, if mipmap is enabled.
  • generateMipmap: boolean

    Whether to generate mipmaps for the updated region.
  • premultiplyAlpha: boolean

    Whether to premultiply the alpha channel of the pixel data.
  • invertY: boolean

    Whether to invert the Y-axis of the pixel data.

  返回 void

  En

  Sets a sub-region of pixel data for the texture.

  Zh

  设置纹理的子区域像素数据。

静态destroyUnusedResources

• destroyUnusedResources(): void

  返回 void

  En

  Destroy unused resources, this function will ignore resources with lock=true.

  Zh

  销毁当前没有被使用的资源,该函数会忽略lock=true的资源。

静态load

• load(url: string, complete: Handler): void

  参数

  • url: string

    The path to the texture file.
  • complete: Handler

    The callback function to be called after the texture is loaded.

  返回 void

  En

  Loads a texture from the specified URL.

  Zh

  从指定的 URL 加载纹理。