OrillusionClass: AtmosphericScatteringSky
Atmospheric Scattering Sky Texture
Hierarchy
↳
AtmosphericScatteringSky
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
- setting
Accessors
- useMipmap
- sourceImageData
- addressModeU
- addressModeV
- addressModeW
- magFilter
- minFilter
- mipmapFilter
- lodMinClamp
- lodMaxClamp
- compare
- maxAnisotropy
- texture2D
- ldrImageUrl
Methods
Constructors
constructor
• new AtmosphericScatteringSky(setting)
Parameters
| Name | Type | Description |
|---|---|---|
setting | AtmosphericScatteringSkySetting | AtmosphericScatteringSkySetting |
Overrides
Defined in
src/textures/AtmosphericScatteringSky.ts:43
Properties
name
• name: string
name of texture
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:14
url
• url: string
source url
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:19
pid
• pid: number
Return index in texture array
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:29
view
• view: GPUTextureView
GPUTextureView
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:34
gpuSampler
• gpuSampler: GPUSampler
GPUSampler
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:39
gpuSampler_comparison
• gpuSampler_comparison: GPUSampler
GPUSampler for comparison
Inherited from
LDRTextureCube.gpuSampler_comparison
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:44
format
• format: GPUTextureFormat
GPUTextureFormat
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:49
usage
• usage: number
GPUTextureUsage
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:54
numberLayer
• numberLayer: number = 1
depth or layers, default value is 1
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:74
viewDescriptor
• viewDescriptor: GPUTextureViewDescriptor
GPUTextureViewDescriptor
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:79
textureDescriptor
• textureDescriptor: GPUTextureDescriptor
GPUTextureDescriptor
Inherited from
LDRTextureCube.textureDescriptor
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:84
sampler_comparisonBindingLayout
• sampler_comparisonBindingLayout: GPUSamplerBindingLayout
GPUSamplerBindingLayout
Inherited from
LDRTextureCube.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
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:117
isVideoTexture
• Optional isVideoTexture: boolean
whether is video texture
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:122
isHDRTexture
• Optional isHDRTexture: boolean
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:123
mipmapCount
• mipmapCount: number = 1
mipmap Count, default value is 1
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:190
width
• width: number = 4
texture width, default value is 4
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:12
height
• height: number = 4
texture height, default value is 4
Inherited from
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
LDRTextureCube.depthOrArrayLayers
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:20
visibility
• visibility: number = GPUShaderStage.FRAGMENT
GPUShaderStage
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:25
textureBindingLayout
• textureBindingLayout: GPUTextureBindingLayout
GPUTextureBindingLayout
Inherited from
LDRTextureCube.textureBindingLayout
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:30
samplerBindingLayout
• samplerBindingLayout: GPUSamplerBindingLayout
GPUSamplerBindingLayout
Inherited from
LDRTextureCube.samplerBindingLayout
Defined in
src/gfx/graphics/webGpu/core/texture/TextureCube.ts:38
setting
• Readonly setting: AtmosphericScatteringSkySetting
Defined in
src/textures/AtmosphericScatteringSky.ts:36
Accessors
useMipmap
• get useMipmap(): boolean
enable/disable mipmap
Returns
boolean
Inherited from
LDRTextureCube.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
LDRTextureCube.useMipmap
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:316
sourceImageData
• get sourceImageData(): HTMLCanvasElement | ImageBitmap | OffscreenCanvas
Returns
HTMLCanvasElement | ImageBitmap | OffscreenCanvas
Inherited from
LDRTextureCube.sourceImageData
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:347
addressModeU
• get addressModeU(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
LDRTextureCube.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
LDRTextureCube.addressModeU
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:429
addressModeV
• get addressModeV(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
LDRTextureCube.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
LDRTextureCube.addressModeV
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:440
addressModeW
• get addressModeW(): GPUAddressMode
Returns
GPUAddressMode
Inherited from
LDRTextureCube.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
LDRTextureCube.addressModeW
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:451
magFilter
• get magFilter(): GPUFilterMode
Returns
GPUFilterMode
Inherited from
LDRTextureCube.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
LDRTextureCube.magFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:462
minFilter
• get minFilter(): GPUFilterMode
Returns
GPUFilterMode
Inherited from
LDRTextureCube.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
LDRTextureCube.minFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:473
mipmapFilter
• get mipmapFilter(): GPUMipmapFilterMode
Returns
GPUMipmapFilterMode
Inherited from
LDRTextureCube.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
LDRTextureCube.mipmapFilter
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:484
lodMinClamp
• get lodMinClamp(): number
Returns
number
Inherited from
LDRTextureCube.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
LDRTextureCube.lodMinClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:495
lodMaxClamp
• get lodMaxClamp(): number
Returns
number
Inherited from
LDRTextureCube.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
LDRTextureCube.lodMaxClamp
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:506
compare
• get compare(): GPUCompareFunction
Returns
GPUCompareFunction
Inherited from
LDRTextureCube.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
LDRTextureCube.compare
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:517
maxAnisotropy
• get maxAnisotropy(): number
Returns
number
Inherited from
LDRTextureCube.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
LDRTextureCube.maxAnisotropy
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:528
texture2D
• get texture2D(): Texture
Returns
Defined in
src/textures/AtmosphericScatteringSky.ts:54
ldrImageUrl
• get ldrImageUrl(): string
constructor: create a cube texture, it's low dynamic range texture
Returns
string
Inherited from
LDRTextureCube.ldrImageUrl
Defined in
src/textures/LDRTextureCube.ts:21
Methods
init
▸ init(): AtmosphericScatteringSky
Returns
Inherited from
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:214
getGPUTexture
▸ getGPUTexture(): GPUTexture
create or get GPUTexture
Returns
GPUTexture
GPUTexture
Inherited from
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
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
LDRTextureCube.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
LDRTextureCube.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
Defined in
src/gfx/graphics/webGpu/core/texture/Texture.ts:413
load
▸ load(url, loaderFunctions?): Promise<LDRTextureCube>
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<LDRTextureCube>
Inherited from
Defined in
src/textures/LDRTextureCube.ts:37
createFromTexture
▸ createFromTexture(size, texture): AtmosphericScatteringSky
create cube texture by environment image
Parameters
| Name | Type | Description |
|---|---|---|
size | number | size of cube texture |
texture | Texture | source texture |
Returns
Inherited from
LDRTextureCube.createFromTexture