Class: BitmapTexture2D

bitmap texture

Hierarchy

• Texture

  ↳ BitmapTexture2D

Constructors

• constructor

Properties

• name
• url
• pid
• view
• gpuSampler
• gpuSampler_comparison
• format
• usage
• width
• height
• depthOrArrayLayers
• numberLayer
• viewDescriptor
• textureDescriptor
• visibility
• textureBindingLayout
• samplerBindingLayout
• sampler_comparisonBindingLayout
• flipY
• isVideoTexture
• isHDRTexture
• mipmapCount
• premultiplyAlpha

Accessors

• useMipmap
• sourceImageData
• addressModeU
• addressModeV
• addressModeW
• magFilter
• minFilter
• mipmapFilter
• lodMinClamp
• lodMaxClamp
• compare
• maxAnisotropy
• source

Methods

• init
• getMipmapCount
• getGPUTexture
• getGPUView
• bindStateChange
• unBindStateChange
• destroy
• delayDestroyTexture
• destroyTexture
• load
• loadFromBlob

Constructors

constructor

• new BitmapTexture2D(useMipmap?): BitmapTexture2D

Parameters

Name	Type	Default value	Description
useMipmap	boolean	true	Set whether to use mipmap

Returns

BitmapTexture2D

Overrides

Texture.constructor

Defined in

src/textures/BitmapTexture2D.ts:19

Properties

name

• name: string

name of texture

Inherited from

Texture.name

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:15

---

url

• url: string

source url

Inherited from

Texture.url

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:20

---

pid

• pid: number

Return index in texture array

Inherited from

Texture.pid

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:30

---

view

• view: GPUTextureView | GPUExternalTexture

GPUTextureView

Inherited from

Texture.view

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:35

---

gpuSampler

• gpuSampler: GPUSampler

GPUSampler

Inherited from

Texture.gpuSampler

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:40

---

gpuSampler_comparison

• gpuSampler_comparison: GPUSampler

GPUSampler for comparison

Inherited from

Texture.gpuSampler_comparison

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:45

---

format

• format: GPUTextureFormat

GPUTextureFormat

Inherited from

Texture.format

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:50

---

usage

• usage: number

GPUTextureUsage

Inherited from

Texture.usage

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:55

---

width

• width: number = 4

texture width

Inherited from

Texture.width

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:60

---

height

• height: number = 4

texture height

Inherited from

Texture.height

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:65

---

depthOrArrayLayers

• depthOrArrayLayers: number = 1

depth or layers, default value is 1

Inherited from

Texture.depthOrArrayLayers

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:70

---

numberLayer

• numberLayer: number = 1

depth or layers, default value is 1

Inherited from

Texture.numberLayer

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:75

---

viewDescriptor

• viewDescriptor: GPUTextureViewDescriptor

GPUTextureViewDescriptor

Inherited from

Texture.viewDescriptor

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:80

---

textureDescriptor

• textureDescriptor: GPUTextureDescriptor

GPUTextureDescriptor

Inherited from

Texture.textureDescriptor

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:85

---

visibility

• visibility: number

GPUShaderStage

Inherited from

Texture.visibility

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:90

---

textureBindingLayout

• textureBindingLayout: GPUTextureBindingLayout

GPUTextureBindingLayout, contains viewDimension and multisampled

Inherited from

Texture.textureBindingLayout

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:96

---

samplerBindingLayout

• samplerBindingLayout: GPUSamplerBindingLayout

GPUSamplerBindingLayout

Inherited from

Texture.samplerBindingLayout

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:104

---

sampler_comparisonBindingLayout

• sampler_comparisonBindingLayout: GPUSamplerBindingLayout

GPUSamplerBindingLayout

Inherited from

Texture.sampler_comparisonBindingLayout

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:111

---

flipY

• flipY: boolean

whether to flip the image on the y-axis

Inherited from

Texture.flipY

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:118

---

isVideoTexture

• Optional isVideoTexture: boolean

whether is video texture

Inherited from

Texture.isVideoTexture

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:123

---

isHDRTexture

• Optional isHDRTexture: boolean

Inherited from

Texture.isHDRTexture

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:124

---

mipmapCount

• mipmapCount: number = 1

mipmap Count, default value is 1

Inherited from

Texture.mipmapCount

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:191

---

premultiplyAlpha

• premultiplyAlpha: PremultiplyAlpha = 'none'

Defined in

src/textures/BitmapTexture2D.ts:13

Accessors

useMipmap

• get useMipmap(): boolean

enable/disable mipmap

Returns

boolean

Inherited from

Texture.useMipmap

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:315

• set useMipmap(value): void

get mipmap

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Texture.useMipmap

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:322

---

sourceImageData

• get sourceImageData(): HTMLCanvasElement | ImageBitmap | OffscreenCanvas

Returns

HTMLCanvasElement | ImageBitmap | OffscreenCanvas

Inherited from

Texture.sourceImageData

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:353

---

addressModeU

• get addressModeU(): GPUAddressMode

Returns

GPUAddressMode

Inherited from

Texture.addressModeU

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:438

• set addressModeU(value): void

Parameters

Name	Type
value	GPUAddressMode

Returns

void

Inherited from

Texture.addressModeU

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:442

---

addressModeV

• get addressModeV(): GPUAddressMode

Returns

GPUAddressMode

Inherited from

Texture.addressModeV

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:449

• set addressModeV(value): void

Parameters

Name	Type
value	GPUAddressMode

Returns

void

Inherited from

Texture.addressModeV

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:453

---

addressModeW

• get addressModeW(): GPUAddressMode

Returns

GPUAddressMode

Inherited from

Texture.addressModeW

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:460

• set addressModeW(value): void

Parameters

Name	Type
value	GPUAddressMode

Returns

void

Inherited from

Texture.addressModeW

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:464

---

magFilter

• get magFilter(): GPUFilterMode

Returns

GPUFilterMode

Inherited from

Texture.magFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:471

• set magFilter(value): void

Parameters

Name	Type
value	GPUFilterMode

Returns

void

Inherited from

Texture.magFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:475

---

minFilter

• get minFilter(): GPUFilterMode

Returns

GPUFilterMode

Inherited from

Texture.minFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:482

• set minFilter(value): void

Parameters

Name	Type
value	GPUFilterMode

Returns

void

Inherited from

Texture.minFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:486

---

mipmapFilter

• get mipmapFilter(): GPUMipmapFilterMode

Returns

GPUMipmapFilterMode

Inherited from

Texture.mipmapFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:493

• set mipmapFilter(value): void

Parameters

Name	Type
value	GPUMipmapFilterMode

Returns

void

Inherited from

Texture.mipmapFilter

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:497

---

lodMinClamp

• get lodMinClamp(): number

Returns

number

Inherited from

Texture.lodMinClamp

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:504

• set lodMinClamp(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Texture.lodMinClamp

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:508

---

lodMaxClamp

• get lodMaxClamp(): number

Returns

number

Inherited from

Texture.lodMaxClamp

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:515

• set lodMaxClamp(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Texture.lodMaxClamp

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:519

---

compare

• get compare(): GPUCompareFunction

Returns

GPUCompareFunction

Inherited from

Texture.compare

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:526

• set compare(value): void

Parameters

Name	Type
value	GPUCompareFunction

Returns

void

Inherited from

Texture.compare

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:530

---

maxAnisotropy

• get maxAnisotropy(): number

Returns

number

Inherited from

Texture.maxAnisotropy

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:537

• set maxAnisotropy(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

Texture.maxAnisotropy

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:541

---

source

• get source(): HTMLCanvasElement | HTMLImageElement | ImageBitmap | OffscreenCanvas

get raw data of this texture

Returns

HTMLCanvasElement | HTMLImageElement | ImageBitmap | OffscreenCanvas

Defined in

src/textures/BitmapTexture2D.ts:32

• set source(value): void

set raw data of this texture

Parameters

Name	Type
value	HTMLCanvasElement | HTMLImageElement | ImageBitmap | OffscreenCanvas

Returns

void

Defined in

src/textures/BitmapTexture2D.ts:39

Methods

init

▸ init(): this

Returns

this

Inherited from

Texture.init

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:215

---

getMipmapCount

▸ getMipmapCount(): number

Returns

number

Inherited from

Texture.getMipmapCount

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:357

---

getGPUTexture

▸ getGPUTexture(): GPUTexture

create or get GPUTexture

Returns

GPUTexture

GPUTexture

Inherited from

Texture.getGPUTexture

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:384

---

getGPUView

▸ getGPUView(index?): GPUTextureView | GPUExternalTexture

create or get GPUTextureView

Parameters

Name	Type	Default value
index	number	0

Returns

GPUTextureView | GPUExternalTexture

GPUTextureView | GPUExternalTexture

Inherited from

Texture.getGPUView

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:395

---

bindStateChange

▸ bindStateChange(fun, ref): void

Parameters

Name	Type
fun	Function
ref	any

Returns

void

Inherited from

Texture.bindStateChange

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:408

---

unBindStateChange

▸ unBindStateChange(ref): void

Parameters

Name	Type
ref	any

Returns

void

Inherited from

Texture.unBindStateChange

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:412

---

destroy

▸ destroy(force?): void

release the texture

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

Texture.destroy

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:426

---

delayDestroyTexture

▸ delayDestroyTexture(tex): void

Parameters

Name	Type
tex	GPUTexture

Returns

void

Inherited from

Texture.delayDestroyTexture

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:549

---

destroyTexture

▸ destroyTexture(): void

Returns

void

Inherited from

Texture.destroyTexture

Defined in

src/gfx/graphics/webGpu/core/texture/Texture.ts:555

---

load

▸ load(url, loaderFunctions?): Promise<unknown>

load texture data from web url

Parameters

Name	Type	Description
url	string	web url
loaderFunctions?	LoaderFunctions	callback function when load complete

Returns

Promise<unknown>

Defined in

src/textures/BitmapTexture2D.ts:62

---

loadFromBlob

▸ loadFromBlob(imgData): Promise<boolean>

load data from Blob

Parameters

Name	Type	Description
imgData	Blob	blob data which contains image

Returns

Promise<boolean>

Defined in

src/textures/BitmapTexture2D.ts:110