Class: HDRTextureCube
HDR TextureCube
Hierarchy
TextureCube
↳
HDRTextureCube
Constructors
Properties
- name
- url
- pid
- view
- gpuSampler
- gpuSampler_comparison
- format
- usage
- numberLayer
- viewDescriptor
- textureDescriptor
- sampler_comparisonBindingLayout
- flipY
- isVideoTexture
- isHDRTexture
- mipmapCount
- width
- height
- depthOrArrayLayers
- visibility
- textureBindingLayout
- samplerBindingLayout
Accessors
- useMipmap
- sourceImageData
- addressModeU
- addressModeV
- addressModeW
- magFilter
- minFilter
- mipmapFilter
- lodMinClamp
- lodMaxClamp
- compare
- maxAnisotropy
Methods
- init
- getGPUTexture
- getGPUView
- bindStateChange
- unBindStateChange
- destroy
- createFromHDRData
- createFromTexture
- load
Constructors
constructor
• new HDRTextureCube()
create a cube texture, it's high dynamic range texture
Overrides
TextureCube.constructor
Defined in
src/textures/HDRTextureCube.ts:23
Properties
name
• name: string
name of texture
Inherited from
TextureCube.name
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:14
url
• url: string
source url
Inherited from
TextureCube.url
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:19
pid
• pid: number
Return index in texture array
Inherited from
TextureCube.pid
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:29
view
• view: GPUTextureView
GPUTextureView
Inherited from
TextureCube.view
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:34
gpuSampler
• gpuSampler: GPUSampler
GPUSampler
Inherited from
TextureCube.gpuSampler
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:39
gpuSampler_comparison
• gpuSampler_comparison: GPUSampler
GPUSampler for comparison
Inherited from
TextureCube.gpuSampler_comparison
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:44
format
• format: GPUTextureFormat
GPUTextureFormat
Inherited from
TextureCube.format
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:49
usage
• usage: number
GPUTextureUsage
Inherited from
TextureCube.usage
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:54
numberLayer
• numberLayer: number
= 1
depth or layers, default value is 1
Inherited from
TextureCube.numberLayer
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:74
viewDescriptor
• viewDescriptor: GPUTextureViewDescriptor
GPUTextureViewDescriptor
Inherited from
TextureCube.viewDescriptor
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:79
textureDescriptor
• textureDescriptor: GPUTextureDescriptor
GPUTextureDescriptor
Inherited from
TextureCube.textureDescriptor
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:84
sampler_comparisonBindingLayout
• sampler_comparisonBindingLayout: GPUSamplerBindingLayout
GPUSamplerBindingLayout
Inherited from
TextureCube.sampler_comparisonBindingLayout
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:110
flipY
• flipY: boolean
whether to flip the image on the y-axis
Inherited from
TextureCube.flipY
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:117
isVideoTexture
• Optional
isVideoTexture: boolean
whether is video texture
Inherited from
TextureCube.isVideoTexture
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:122
isHDRTexture
• Optional
isHDRTexture: boolean
Inherited from
TextureCube.isHDRTexture
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:123
mipmapCount
• mipmapCount: number
= 1
mipmap Count, default value is 1
Inherited from
TextureCube.mipmapCount
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:190
width
• width: number
= 4
texture width, default value is 4
Inherited from
TextureCube.width
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:12
height
• height: number
= 4
texture height, default value is 4
Inherited from
TextureCube.height
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:16
depthOrArrayLayers
• depthOrArrayLayers: number
= 6
depth or array layers, default value is 6
Inherited from
TextureCube.depthOrArrayLayers
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:20
visibility
• visibility: number
= GPUShaderStage.FRAGMENT
GPUShaderStage
Inherited from
TextureCube.visibility
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:25
textureBindingLayout
• textureBindingLayout: GPUTextureBindingLayout
GPUTextureBindingLayout
Inherited from
TextureCube.textureBindingLayout
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:30
samplerBindingLayout
• samplerBindingLayout: GPUSamplerBindingLayout
GPUSamplerBindingLayout
Inherited from
TextureCube.samplerBindingLayout
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:38
Accessors
useMipmap
• get
useMipmap(): boolean
enable/disable mipmap
Returns
boolean
Inherited from
TextureCube.useMipmap
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:309
• set
useMipmap(value
): void
get mipmap
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
TextureCube.useMipmap
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:316
sourceImageData
• get
sourceImageData(): HTMLCanvasElement
| ImageBitmap
| OffscreenCanvas
Returns
HTMLCanvasElement
| ImageBitmap
| OffscreenCanvas
Inherited from
TextureCube.sourceImageData
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:347
addressModeU
• get
addressModeU(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
TextureCube.addressModeU
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:425
• set
addressModeU(value
): void
Parameters
Name | Type |
---|---|
value | GPUAddressMode |
Returns
void
Inherited from
TextureCube.addressModeU
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:429
addressModeV
• get
addressModeV(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
TextureCube.addressModeV
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:436
• set
addressModeV(value
): void
Parameters
Name | Type |
---|---|
value | GPUAddressMode |
Returns
void
Inherited from
TextureCube.addressModeV
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:440
addressModeW
• get
addressModeW(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
TextureCube.addressModeW
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:447
• set
addressModeW(value
): void
Parameters
Name | Type |
---|---|
value | GPUAddressMode |
Returns
void
Inherited from
TextureCube.addressModeW
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:451
magFilter
• get
magFilter(): GPUFilterMode
Returns
GPUFilterMode
Inherited from
TextureCube.magFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:458
• set
magFilter(value
): void
Parameters
Name | Type |
---|---|
value | GPUFilterMode |
Returns
void
Inherited from
TextureCube.magFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:462
minFilter
• get
minFilter(): GPUFilterMode
Returns
GPUFilterMode
Inherited from
TextureCube.minFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:469
• set
minFilter(value
): void
Parameters
Name | Type |
---|---|
value | GPUFilterMode |
Returns
void
Inherited from
TextureCube.minFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:473
mipmapFilter
• get
mipmapFilter(): GPUMipmapFilterMode
Returns
GPUMipmapFilterMode
Inherited from
TextureCube.mipmapFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:480
• set
mipmapFilter(value
): void
Parameters
Name | Type |
---|---|
value | GPUMipmapFilterMode |
Returns
void
Inherited from
TextureCube.mipmapFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:484
lodMinClamp
• get
lodMinClamp(): number
Returns
number
Inherited from
TextureCube.lodMinClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:491
• set
lodMinClamp(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
TextureCube.lodMinClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:495
lodMaxClamp
• get
lodMaxClamp(): number
Returns
number
Inherited from
TextureCube.lodMaxClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:502
• set
lodMaxClamp(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
TextureCube.lodMaxClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:506
compare
• get
compare(): GPUCompareFunction
Returns
GPUCompareFunction
Inherited from
TextureCube.compare
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:513
• set
compare(value
): void
Parameters
Name | Type |
---|---|
value | GPUCompareFunction |
Returns
void
Inherited from
TextureCube.compare
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:517
maxAnisotropy
• get
maxAnisotropy(): number
Returns
number
Inherited from
TextureCube.maxAnisotropy
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:524
• set
maxAnisotropy(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
TextureCube.maxAnisotropy
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:528
Methods
init
▸ init(): HDRTextureCube
Returns
Inherited from
TextureCube.init
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:214
getGPUTexture
▸ getGPUTexture(): GPUTexture
create or get GPUTexture
Returns
GPUTexture
GPUTexture
Inherited from
TextureCube.getGPUTexture
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:371
getGPUView
▸ getGPUView(index?
): GPUTextureView
| GPUExternalTexture
create or get GPUTextureView
Parameters
Name | Type | Default value |
---|---|---|
index | number | 0 |
Returns
GPUTextureView
| GPUExternalTexture
GPUTextureView | GPUExternalTexture
Inherited from
TextureCube.getGPUView
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:382
bindStateChange
▸ bindStateChange(fun
, ref
): void
Parameters
Name | Type |
---|---|
fun | Function |
ref | any |
Returns
void
Inherited from
TextureCube.bindStateChange
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:395
unBindStateChange
▸ unBindStateChange(ref
): void
Parameters
Name | Type |
---|---|
ref | any |
Returns
void
Inherited from
TextureCube.unBindStateChange
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:399
destroy
▸ destroy(force?
): void
release the texture
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
TextureCube.destroy
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:413
createFromHDRData
▸ createFromHDRData(size
, data
): HDRTextureCube
fill this texture by array of numbers;the format as [red0, green0, blue0, alpha0, red1, green1, blue1, alpha1...]
Parameters
Name | Type | Description |
---|---|---|
size | number | assign the cube texture size |
data | Object | raw data of cubeTexture; the format is { width: number; height: number; array: Uint8Array } |
data.width | number | - |
data.height | number | - |
data.array | Uint8Array | - |
Returns
Defined in
src/textures/HDRTextureCube.ts:37
createFromTexture
▸ createFromTexture(size
, texture
): HDRTextureCube
fill this texture by a texture2D, which is a 360 panorama image
Parameters
Name | Type | Description |
---|---|---|
size | number | assign the cube texture size |
texture | Texture | the image texture |
Returns
Defined in
src/textures/HDRTextureCube.ts:52
load
▸ load(url
, loaderFunctions?
): Promise
<HDRTextureCube
>
load texture data from web url, which is a 360 panorama image
Parameters
Name | Type | Description |
---|---|---|
url | string | web url |
loaderFunctions? | LoaderFunctions | callback function when load complete |
Returns
Promise
<HDRTextureCube
>