SourceTexture

SourceTexture is texture which contains cpu data.

Core Class

SourceTexture is texture which contains cpu data.

Hierarchy

TextureV2
- SourceTexture

Constructors

constructor

new SourceTexture(
dimension: TextureDimension,
viewDimension: TextureViewDimension,
format: TextureFormat,
width: number,
height: number,
depthOrArrayLayers: number,
mipmaps: boolean,
autoGenerateMipmap: boolean,
): SourceTexture
Parameters
- dimension: TextureDimension
- viewDimension: TextureViewDimension
- format: TextureFormat
- width: number
- height: number
- depthOrArrayLayers: number
- mipmaps: boolean
- autoGenerateMipmap: boolean
Returns SourceTexture
Overrides TextureV2.constructor

Properties

`Readonly`autoGenerateMipmap

autoGenerateMipmap: boolean

name

name: string

`Readonly`samplerDescriptor

samplerDescriptor: SamplerDescriptor

`Readonly`storageDescriptor

storageDescriptor: TextureStorageDescriptor

isMipmapDisabled

isMipmapDisabled: boolean

`Readonly`format

format: TextureFormat

`Readonly`width

width: number

`Readonly`height

height: number

`Readonly`depthOrArrayLayers

depthOrArrayLayers: number

`Readonly`sampleCount

sampleCount: number

`Readonly`levels

levels: number

`Readonly`mipmaps

mipmaps: boolean

`Readonly`byteSize

byteSize: number

`Readonly`userData

userData: Record<keyof any, any>

_uuid

_uuid: any

uuid

uuid: string

_listeners

_listeners: Map<Symbol, Listener<never>[]>

Accessors

businessTag

get businessTag(): string
Returns string
Inherited from TextureV2.businessTag
set businessTag(v: string): void
Parameters
- v: string
Returns void
Inherited from TextureV2.businessTag

Methods

getLevelLayerSource

getLevelLayerSource(
level: number,
layer?: number,
):
| HTMLImageElement
| HTMLCanvasElement
| HTMLVideoElement
| OffscreenCanvas
| ImageData
| ImageBitmap
| Uint8Array<ArrayBufferLike>
| Float32Array<ArrayBufferLike>
| Float64Array<ArrayBufferLike>
| Int8Array<ArrayBufferLike>
| Uint8ClampedArray<ArrayBufferLike>
| Int16Array<ArrayBufferLike>
| Uint16Array<ArrayBufferLike>
| Int32Array<ArrayBufferLike>
| Uint32Array<ArrayBufferLike>
| undefined
Parameters
- level: number
- layer: number
Returns
| HTMLImageElement
| HTMLCanvasElement
| HTMLVideoElement
| OffscreenCanvas
| ImageData
| ImageBitmap
| Uint8Array<ArrayBufferLike>
| Float32Array<ArrayBufferLike>
| Float64Array<ArrayBufferLike>
| Int8Array<ArrayBufferLike>
| Uint8ClampedArray<ArrayBufferLike>
| Int16Array<ArrayBufferLike>
| Uint16Array<ArrayBufferLike>
| Int32Array<ArrayBufferLike>
| Uint32Array<ArrayBufferLike>
| undefined

configSampler

configSampler(visitor: (s: SamplerDescriptor) => any): this
Parameters
- visitor: (s: SamplerDescriptor) => any
Returns this
Overrides TextureV2.configSampler

setLevelData

setLevelData(data: TypedArray, level: number): this
Parameters
- data: TypedArray
- level: number
Returns this

setLevelLayerData

setLevelLayerData(data: LayerSource, level: number, layer: number): this
Parameters
- data: LayerSource
- level: number
- layer: number
Returns this

destroy

destroy(): void
Returns void
Inherited from TextureV2.destroy

syncBase

syncBase(): void
Returns void
Inherited from TextureV2.syncBase

getUUID

getUUID(): string
Returns string
Inherited from TextureV2.getUUID

disableAutoMipmap

disableAutoMipmap(): this
Returns this
Inherited from TextureV2.disableAutoMipmap

copyBaseInfo

copyBaseInfo(other: Texture): this
Parameters
- other: Texture
Returns this
Inherited from TextureV2.copyBaseInfo

configAsDataTexture

configAsDataTexture(): this
Returns this
Inherited from TextureV2.configAsDataTexture

configSamplerRepeat

configSamplerRepeat(): this
Returns this
Inherited from TextureV2.configSamplerRepeat

configTrilinear

configTrilinear(): this
Returns this
Inherited from TextureV2.configTrilinear

configDoubleLinear

configDoubleLinear(): this
Returns this
Inherited from TextureV2.configDoubleLinear

configStorage

configStorage(visitor: (t: TextureStorageDescriptor) => any): this
Parameters
- visitor: (t: TextureStorageDescriptor) => any
Returns this
Inherited from TextureV2.configStorage

freeGPU

freeGPU(): void
Returns void
Inherited from TextureV2.freeGPU

serialize

serialize(ctx: Serializer<Texture>): void
Parameters
- ctx: Serializer<Texture>
Returns void
Inherited from TextureV2.serialize

deserialize

deserialize(ctx: Deserializer): void
Parameters
- ctx: Deserializer
Returns void
Inherited from TextureV2.deserialize

markBusinessTag

markBusinessTag(v: string): this
Parameters
- v: string
Returns this
Inherited from TextureV2.markBusinessTag

isDestroyed

isDestroyed(): boolean
Returns boolean
Inherited from TextureV2.isDestroyed

validate

validate(): void
Returns void
Inherited from TextureV2.validate

destroyAllResourcesOwned

destroyAllResourcesOwned(): void
Returns void
Inherited from TextureV2.destroyAllResourcesOwned

freeAllGpuResourceOwned

freeAllGpuResourceOwned(): void
Returns void
Inherited from TextureV2.freeAllGpuResourceOwned

on

on<T>(_type: EventType<T>, _listener: Listener<T>): void
Adds a listener to an event type.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from TextureV2.on

once

once<T>(_type: EventType<T>, _listener: Listener<T>): void
Only active the listener one times and then off it| it.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from TextureV2.once

has

has<T>(_type: EventType<T>, _listener: Listener<T>): boolean
Checks if listener is added to an event type.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns boolean
Inherited from TextureV2.has

off

off<T>(_type: EventType<T>, _listener: Listener<T>): void
Removes a listener from listening list.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from TextureV2.off

emit

emit(type: EventType<never>): void
Active the event and call the registered listener.
Parameters
- type: EventType<never>
Returns void
Inherited from TextureV2.emit
emit<T>(type: EventType<T>, payload: T): void
Type Parameters
- T
Parameters
- type: EventType<T>
- payload: T
Returns void
Inherited from TextureV2.emit

clearAllListeners

clearAllListeners(): void
Removes all listeners from listening list.

Returns void
Inherited from TextureV2.clearAllListeners

Hierarchy

Constructors

constructor

Parameters

Returns SourceTexture

Properties

ReadonlyautoGenerateMipmap

name

ReadonlysamplerDescriptor

ReadonlystorageDescriptor

isMipmapDisabled

Readonlyformat

Readonlywidth

Readonlyheight

ReadonlydepthOrArrayLayers

ReadonlysampleCount

Readonlylevels

Readonlymipmaps

ReadonlybyteSize

ReadonlyuserData

_uuid

uuid

_listeners

Accessors

businessTag

Returns string

Parameters

Returns void

Methods

getLevelLayerSource

Parameters

configSampler

Parameters

Returns this

setLevelData

Parameters

Returns this

setLevelLayerData

Parameters

Returns this

destroy

Returns void

syncBase

Returns void

getUUID

Returns string

disableAutoMipmap

Returns this

copyBaseInfo

Parameters

Returns this

configAsDataTexture

Returns this

configSamplerRepeat

Returns this

configTrilinear

Returns this

configDoubleLinear

Returns this

configStorage

Parameters

Returns this

freeGPU

Returns void

serialize

Parameters

Returns void

deserialize

Parameters

Returns void

markBusinessTag

Parameters

Returns this

isDestroyed

Returns boolean

validate

Returns void

destroyAllResourcesOwned

Returns void

freeAllGpuResourceOwned

`Readonly`autoGenerateMipmap

`Readonly`samplerDescriptor

`Readonly`storageDescriptor

`Readonly`format

`Readonly`width

`Readonly`height

`Readonly`depthOrArrayLayers

`Readonly`sampleCount

`Readonly`levels

`Readonly`mipmaps

`Readonly`byteSize

`Readonly`userData