类 Texture2D

En

The Texture2D class is used to generate 2D textures.

Zh

Texture2D 类用于生成2D纹理。

层级 (查看层级一览)

构造函数

constructor

属性

_id destroyedImmediately hdrEncodeFormat lock? name? url uuid blackTexture DEBUG errorTexture grayTexture normalTexture TEXTURE2D whiteTexture

访问器

anisoLevel baseMipmapLevel compareMode cpuMemory defaultTexture deps destroyed dimension filterMode format gammaCorrection gammaSpace gpuMemory height id maxMipmapLevel mipmap mipmapCount obsolute referenceCount width wrapModeU wrapModeV wrapModeW cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps destroy event getPixels gpuCompressFormat hasListener isCreateFromURL off offAll offAllCaller on once setDDSData setHDRData setImageData setKTXData setPixelsData setSubPixelsData destroyUnusedResources load

构造函数

constructor

  • new Texture2D(
        width: number,
        height: number,
        format: TextureFormat,
        mipmap?: boolean,
        canRead: boolean,
        sRGB?: boolean,
        premultiplyAlpha?: boolean,
    ): Texture2D

    参数

    • width: number

      The width of the texture.

    • height: number

      The height of the texture.

    • format: TextureFormat

      The format of the texture.

    • mipmap: boolean = true

      Indicates whether to generate mipmaps for the texture.

    • canRead: boolean

      Indicates whether the texture data can be read.

    • sRGB: boolean = false

      Indicates whether the texture uses sRGB color space.

    • premultiplyAlpha: boolean = false

      Indicates whether the texture data is premultiplied by the alpha channel.

    返回 Texture2D

    En

    Creates an instance of Texture2D.

    Zh

    创建 Texture2D 类的实例。

属性

_id

_id: number = 0

destroyedImmediately

destroyedImmediately: boolean

En

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

Zh

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

hdrEncodeFormat

hdrEncodeFormat: HDREncodeFormat

En

hdr encode format

Zh

hdr编码格式

可选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

资源名称。

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态blackTexture

blackTexture: Texture2D = null

En

A pure black texture.

Zh

纯黑色纹理。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

静态errorTexture

errorTexture: Texture2D = null

En

The error texture displayed when a texture fails to load.

Zh

当纹理加载失败时显示的错误纹理。

静态grayTexture

grayTexture: Texture2D = null

En

A pure gray texture.

Zh

纯灰色纹理。

静态normalTexture

normalTexture: Texture2D = null

En

The default normal map texture.

Zh

默认法线纹理。

静态TEXTURE2D

TEXTURE2D: string = "TEXTURE2D"

En

The identifier for Texture2D resources.

Zh

Texture2D 资源的标识符。

静态whiteTexture

whiteTexture: Texture2D = null

En

A pure white texture.

Zh

纯白色纹理。

访问器

anisoLevel

baseMipmapLevel

compareMode

cpuMemory

defaultTexture

deps

destroyed

dimension

filterMode

format

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

gpuMemory

height

id

maxMipmapLevel

mipmap

mipmapCount

obsolute

  • get obsolute(): boolean

    返回 boolean

    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）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

referenceCount

width

wrapModeU

wrapModeV

wrapModeW

静态cpuMemory

静态gpuMemory

方法

_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

_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

_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

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

gpuCompressFormat

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

offAll

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

setDDSData

setHDRData

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

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

静态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 加载纹理。

显示设置

成员可见性

目录

构造函数
属性
访问器
方法