Class LazyTexture

Texture that resolves its source through the loader registry on demand.

Hierarchy (View Summary)

Texture
- LazyTexture

Constructors

constructor

new LazyTexture(params?: LazyTextureParameters): LazyTexture
Parameters
- params: LazyTextureParameters = {}
Returns LazyTexture
Overrides Texture.constructor
- Defined in texture/LazyTexture.ts:41

Properties

_listeners

_listeners: ListenerMap | null = null

anisotropic

anisotropic: number = 1

anisotropic

autoLoad

autoLoad: boolean = true

autoUpdate

autoUpdate: boolean = false

是否每次都更新Texture

`Readonly`border

border: 0

`Readonly`className

className: "LazyTexture" = 'LazyTexture'

compressed

compressed: boolean = false

是否压缩

crossOrigin

crossOrigin: ImageCrossOrigin = false

depth

depth: number = 1

Depth for 3D textures, or the fixed layer count for 2D-array textures.

flipY

flipY: boolean = false

是否翻转Texture的Y轴

format

format: number = RGBA

图片 Format

height

height: number = 0

`Readonly`id

id: string

internalFormat

internalFormat: number = RGBA8

Texture Internal Format

isImageCanRelease

isImageCanRelease: boolean = false

图片资源是否可以释放，可以的话，上传到GPU后将释放图片引用

The engine keeps a private recovery backing after releasing the public image: raw pixels and ImageData are copied, while DOM/video sources are retained because they cannot be cloned synchronously and portably. Any later WebGL2 context allocation or WebGPU device can rebuild the texture without making the released public image readable again.

`Readonly`isLazyTexture

isLazyTexture: true

`Readonly`isTexture

isTexture: true

magFilter

magFilter: number = LINEAR

magFilter

minFilter

minFilter: number = LINEAR

minFilter

mipmaps

mipmaps: TextureMipmap[] | null = null

mipmaps

name

name: string = ''

needDestroy

needDestroy: boolean = false

是否需要销毁之前的Texture，Texture参数变更之后需要销毁

placeHolder

placeHolder: HTMLImageElement | null = null

premultiplyAlpha

premultiplyAlpha: boolean = false

resType

resType: string = ''

target

target: number = TEXTURE_2D

Texture Target

type

type: number = UNSIGNED_BYTE

类型

uv

uv: TextureUVChannel = 0

width

width: number = 0

wrapR

wrapR: number = REPEAT

R-axis wrap mode used by 3D and 2D-array textures.

wrapS

wrapS: number = REPEAT

wrapS

wrapT

wrapT: number = REPEAT

wrapT

`Static`loader

loader: Loader | null = null

Accessors

image

get image(): Image | null
图片对象

Returns Image | null
Inherited from Texture.image
- Defined in texture/Texture.ts:468
set image(_img: Image | null): void
图片对象
Parameters
- _img: Image | null
Returns void
Inherited from Texture.image
- Defined in texture/Texture.ts:477

isImageReleased

get isImageReleased(): boolean
Whether the CPU image source has already been discarded after a successful upload.

Returns boolean
Inherited from Texture.isImageReleased
- Defined in texture/Texture.ts:493

mipmapCount

get mipmapCount(): number
mipmapCount

Returns number
Inherited from Texture.mipmapCount
- Defined in texture/Texture.ts:857

needUpdate

get needUpdate(): boolean
是否需要更新Texture

Returns boolean
Inherited from Texture.needUpdate
- Defined in texture/Texture.ts:808
set needUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Texture.needUpdate
- Defined in texture/Texture.ts:811

origHeight

get origHeight(): number
获取原始图像高度。

Returns number
Inherited from Texture.origHeight
- Defined in texture/Texture.ts:843

origWidth

get origWidth(): number
获取原始图像宽度。

Returns number
Inherited from Texture.origWidth
- Defined in texture/Texture.ts:837

src

get src(): string
Returns string
- Defined in texture/LazyTexture.ts:31
set src(src: string): void
Parameters
- src: string
Returns void
- Defined in texture/LazyTexture.ts:35

updateRevision

get updateRevision(): number
Monotonic content version used by each rendering backend for independent synchronisation.

Returns number
Inherited from Texture.updateRevision
- Defined in texture/Texture.ts:497

useMipmap

get useMipmap(): boolean
是否使用 mipmap

Returns boolean
Inherited from Texture.useMipmap
- Defined in texture/Texture.ts:851

Methods

clone

clone(): Texture<TextureImageSource>
clone

Returns Texture<TextureImageSource>
Inherited from Texture.clone
- Defined in texture/Texture.ts:1474

destroy

destroy(): this
销毁当前Texture

Returns this
this
Inherited from Texture.destroy
- Defined in texture/Texture.ts:1450

fire

fire(typeOrEvent?: string | DispatchEvent, detail?: unknown): boolean
Parameters
- OptionaltypeOrEvent: string | DispatchEvent
- Optionaldetail: unknown
Returns boolean
Inherited from Texture.fire
- Defined in core/EventDispatcher.ts:79

getSupportSize

getSupportSize(img: ResizableTextureImage, maxTextureSize?: number): Size
获取支持的尺寸
Parameters
- img: ResizableTextureImage
- maxTextureSize: number = 0
Returns Size
{ width, height }
Inherited from Texture.getSupportSize
- Defined in texture/Texture.ts:886

getTextureUpdatesSince

getTextureUpdatesSince(revision: number): TextureUpdateSnapshot
Snapshot content changes newer than a backend-local revision without consuming them. Backends advance their own revision only after every upload in the snapshot succeeds. If the requested revision predates the bounded incremental journal, requiresFullUpload is true and the retained checkpoint is the authoritative baseline.
Parameters
- revision: number
Returns TextureUpdateSnapshot
Inherited from Texture.getTextureUpdatesSince
- Defined in texture/Texture.ts:522

load

load(): Promise<void>
Returns Promise<void>
- Defined in texture/LazyTexture.ts:61

off

off(type?: string, listener?: EventListener<DispatchEvent>): this
Parameters
- Optionaltype: string
- Optionallistener: EventListener<DispatchEvent>
Returns this
Inherited from Texture.off
- Defined in core/EventDispatcher.ts:60

on

on(type: string, listener: EventListener, once?: boolean): this
Parameters
- type: string
- listener: EventListener
- once: boolean = false
Returns this
Inherited from Texture.on
- Defined in core/EventDispatcher.ts:48

releaseImageIfAllowed

releaseImageIfAllowed(): boolean
Discard the CPU image only when isImageCanRelease opted into that lifecycle.

Returns boolean
whether an image source was released
Inherited from Texture.releaseImageIfAllowed
- Defined in texture/Texture.ts:504

resizeImg

resizeImg(
    img: ResizableTextureImage,
    width: number,
    height: number,
): ResizableTextureImage
更新图片大小
Parameters
- img: ResizableTextureImage
- width: number
- height: number
Returns ResizableTextureImage
Inherited from Texture.resizeImg
- Defined in texture/Texture.ts:913

updateSubTexture

updateSubTexture(descriptor: TextureSubImage): void
Update one texture region. The descriptor is immutable after the call returns. Cube, 2D-array, and 3D destinations select their subresource with face, layer, or z. Non-base levels require an explicit mipmap chain. Compressed writes use exact raw block data.
Parameters
- descriptor: TextureSubImage
  Complete mip/subresource/destination/source description.
Returns void
Example
```
texture.updateSubTexture({
    mipLevel: 0,
    x: 16,
    y: 8,
    width: 4,
    height: 4,
    image: pixels
});
```
Inherited from Texture.updateSubTexture
- Defined in texture/Texture.ts:1434

Class LazyTexture

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LazyTexture

Properties

_listeners

anisotropic

autoLoad

autoUpdate

Readonlyborder

ReadonlyclassName

compressed

crossOrigin

depth

flipY

format

height

Readonlyid

internalFormat

isImageCanRelease

ReadonlyisLazyTexture

ReadonlyisTexture

magFilter

minFilter

mipmaps

name

needDestroy

placeHolder

premultiplyAlpha

resType

target

type

uv

width

wrapR

wrapS

wrapT

Staticloader

Accessors

image

Returns Image | null

Parameters

Returns void

isImageReleased

Returns boolean

mipmapCount

Returns number

needUpdate

Returns boolean

Parameters

Returns void

origHeight

Returns number

origWidth

Returns number

src

Returns string

Parameters

Returns void

updateRevision

Returns number

useMipmap

Returns boolean

Methods

clone

Returns Texture<TextureImageSource>

destroy

Returns this

fire

Parameters

Returns boolean

getSupportSize

Parameters

`Readonly`border

`Readonly`className

`Readonly`id

`Readonly`isLazyTexture

`Readonly`isTexture

`Static`loader