Class: StandShader

Hierarchy

• Shader

  ↳ StandShader

Constructors

• constructor

Properties

• computes
• passShader

Accessors

• baseMap
• baseColor
• normalMap
• doubleSide
• alphaCutoff
• emissiveColor
• emissiveIntensity
• uvTransform_1
• uvTransform_2
• depthWriteEnabled
• materialF0
• specularColor
• roughness
• metallic
• ao
• metallic_min
• metallic_max
• roughness_min
• roughness_max
• normalScale
• maskMap
• aoMap
• clearCoatRoughnessMap
• brdfLUT
• emissiveMap
• envIntensity
• ior
• clearcoatFactor
• clearcoatRoughnessFactor
• clearcoatWeight
• clearcoatColor

Methods

• addRenderPass
• removeShader
• removeShaderByIndex
• getSubShaders
• hasSubShaders
• getDefaultShaders
• getDefaultColorShader
• setDefine
• deleteDefine
• setUniform
• setUniformFloat
• setUniformVector2
• setUniformVector3
• setUniformVector4
• setUniformColor
• getUniform
• getUniformFloat
• getUniformVector2
• getUniformVector3
• getUniformVector4
• getUniformColor
• setTexture
• getTexture
• setUniformBuffer
• getUniformBuffer
• setStorageBuffer
• getStorageBuffer
• setStructStorageBuffer
• getStructStorageBuffer
• noticeValueChange
• destroy
• clone
• applyUniform
• setDefault
• useCleanCoat

Constructors

constructor

• new StandShader(): StandShader

Returns

StandShader

Overrides

Shader.constructor

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:13

Properties

computes

• computes: RenderShaderCompute[]

Inherited from

Shader.computes

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:19

---

passShader

• passShader: Map<PassType, RenderShaderPass[]>

Inherited from

Shader.passShader

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:21

Accessors

baseMap

• get baseMap(): Texture

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:66

• set baseMap(value): void

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:70

---

baseColor

• get baseColor(): Color

Returns

Color

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:74

• set baseColor(value): void

Parameters

Name	Type
value	Color

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:78

---

normalMap

• get normalMap(): Texture

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:82

• set normalMap(value): void

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:86

---

doubleSide

• get doubleSide(): boolean

Returns

boolean

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:90

• set doubleSide(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:93

---

alphaCutoff

• get alphaCutoff(): any

Returns

any

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:97

• set alphaCutoff(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:100

---

emissiveColor

• get emissiveColor(): Color

Returns

Color

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:106

• set emissiveColor(value): void

Parameters

Name	Type
value	Color

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:110

---

emissiveIntensity

• get emissiveIntensity(): number

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:114

• set emissiveIntensity(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:118

---

uvTransform_1

• get uvTransform_1(): Vector4

get transformUV1

Returns

Vector4

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:125

• set uvTransform_1(value): void

set transformUV1

Parameters

Name	Type
value	Vector4

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:132

---

uvTransform_2

• get uvTransform_2(): Vector4

get transformUV2

Returns

Vector4

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:140

• set uvTransform_2(value): void

set transformUV2

Parameters

Name	Type
value	Vector4

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:147

---

depthWriteEnabled

• get depthWriteEnabled(): boolean

Returns

boolean

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:152

• set depthWriteEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:155

---

materialF0

• get materialF0(): Vector4

get reflectivity

Returns

Vector4

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:162

• set materialF0(value): void

set reflectivity

Parameters

Name	Type
value	Vector4

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:169

---

specularColor

• get specularColor(): Color

get specularColor

Returns

Color

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:176

• set specularColor(value): void

specularColor set reflectivity

Parameters

Name	Type
value	Color

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:183

---

roughness

• get roughness(): number

get roughness

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:190

• set roughness(value): void

set roughness

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:197

---

metallic

• get metallic(): number

get metallic

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:204

• set metallic(value): void

set metallic

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:211

---

ao

• get ao(): number

get Ambient Occlussion, dealing with the effect of ambient light on object occlusion

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:218

• set ao(value): void

set Ambient Occlussion, dealing with the effect of ambient light on object occlusion

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:225

---

metallic_min

• get metallic_min(): number

get min metallic

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:232

• set metallic_min(value): void

set min metallic

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:239

---

metallic_max

• get metallic_max(): number

get max metallic

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:246

• set metallic_max(value): void

set max metallic

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:253

---

roughness_min

• get roughness_min(): number

get min roughness

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:260

• set roughness_min(value): void

set min roughness

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:267

---

roughness_max

• get roughness_max(): number

get max roughness

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:274

• set roughness_max(value): void

set max roughness

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:281

---

normalScale

• get normalScale(): number

Get the influence of Normal mapping on materials

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:288

• set normalScale(value): void

Set the influence of Normal mapping on materials

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:295

---

maskMap

• get maskMap(): Texture

get Mask Map R_chanel -> AoMap G_chanel -> Roughness B_chanel -> Metallic A_chanel -> C

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:306

• set maskMap(value): void

set Mask Map R_chanel -> AoMap G_chanel -> Roughness B_chanel -> Metallic A_chanel -> C

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:317

---

aoMap

• get aoMap(): Texture

get Ambient Occlussion Map, dealing with the effect of ambient light on object occlusion

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:340

• set aoMap(value): void

set Ambient Occlussion Map, dealing with the effect of ambient light on object occlusion

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:329

---

clearCoatRoughnessMap

• get clearCoatRoughnessMap(): Texture

get clearCoatRoughnessMap

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:358

• set clearCoatRoughnessMap(value): void

set clearCoatRoughnessMap

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:347

---

brdfLUT

• get brdfLUT(): Texture

get brdf query map

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:365

• set brdfLUT(value): void

set brdf query map

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:372

---

emissiveMap

• get emissiveMap(): Texture

get emissive map

Returns

Texture

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:380

• set emissiveMap(value): void

set emissive map

Parameters

Name	Type
value	Texture

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:387

---

envIntensity

• get envIntensity(): number

get intensity of environment light or color of sampled by texture

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:401

• set envIntensity(value): void

set intensity of environment light or color of sampled by texture

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:394

---

ior

• get ior(): number

get factor of refractive

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:415

• set ior(value): void

set factor of refractive

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:408

---

clearcoatFactor

• get clearcoatFactor(): number

get the factor of the clearcoat

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:437

• set clearcoatFactor(value): void

Set the factor of the clearcoat

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:429

---

clearcoatRoughnessFactor

• get clearcoatRoughnessFactor(): number

get the factor of the clearcoat Roughness

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:452

• set clearcoatRoughnessFactor(value): void

set the factor of the clearcoat Roughness

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:444

---

clearcoatWeight

• get clearcoatWeight(): number

get the weight of the clearcoat

Returns

number

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:467

• set clearcoatWeight(value): void

set the weight of the clearcoat

Parameters

Name	Type
value	number

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:459

---

clearcoatColor

• get clearcoatColor(): Color

set the color of the clearcoat

Returns

Color

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:482

• set clearcoatColor(value): void

get the color of the clearcoat

Parameters

Name	Type
value	Color

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:474

Methods

addRenderPass

▸ addRenderPass(renderShader, index?): void

Parameters

Name	Type	Default value
renderShader	RenderShaderPass	undefined
index	number	-1

Returns

void

Inherited from

Shader.addRenderPass

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:28

---

removeShader

▸ removeShader(renderShader, index?): void

Parameters

Name	Type	Default value
renderShader	RenderShaderPass	undefined
index	number	-1

Returns

void

Inherited from

Shader.removeShader

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:38

---

removeShaderByIndex

▸ removeShaderByIndex(passType, index?): void

Parameters

Name	Type	Default value
passType	PassType	undefined
index	number	-1

Returns

void

Inherited from

Shader.removeShaderByIndex

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:52

---

getSubShaders

▸ getSubShaders(passType): RenderShaderPass[]

Parameters

Name	Type
passType	PassType

Returns

RenderShaderPass[]

Inherited from

Shader.getSubShaders

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:63

---

hasSubShaders

▸ hasSubShaders(passType): boolean

Parameters

Name	Type
passType	PassType

Returns

boolean

Inherited from

Shader.hasSubShaders

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:67

---

getDefaultShaders

▸ getDefaultShaders(): RenderShaderPass[]

Returns

RenderShaderPass[]

Inherited from

Shader.getDefaultShaders

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:72

---

getDefaultColorShader

▸ getDefaultColorShader(): RenderShaderPass

Returns

RenderShaderPass

Inherited from

Shader.getDefaultColorShader

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:76

---

setDefine

▸ setDefine(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	boolean

Returns

void

Inherited from

Shader.setDefine

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:80

---

deleteDefine

▸ deleteDefine(arg0): void

Parameters

Name	Type
arg0	string

Returns

void

Inherited from

Shader.deleteDefine

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:88

---

setUniform

▸ setUniform(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	any

Returns

void

Inherited from

Shader.setUniform

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:96

---

setUniformFloat

▸ setUniformFloat(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	number

Returns

void

Inherited from

Shader.setUniformFloat

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:104

---

setUniformVector2

▸ setUniformVector2(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	Vector2

Returns

void

Inherited from

Shader.setUniformVector2

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:112

---

setUniformVector3

▸ setUniformVector3(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	Vector3

Returns

void

Inherited from

Shader.setUniformVector3

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:120

---

setUniformVector4

▸ setUniformVector4(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	Vector4

Returns

void

Inherited from

Shader.setUniformVector4

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:128

---

setUniformColor

▸ setUniformColor(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	Color

Returns

void

Inherited from

Shader.setUniformColor

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:136

---

getUniform

▸ getUniform(arg0): any

Parameters

Name	Type
arg0	string

Returns

any

Inherited from

Shader.getUniform

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:144

---

getUniformFloat

▸ getUniformFloat(arg0): number

Parameters

Name	Type
arg0	string

Returns

number

Inherited from

Shader.getUniformFloat

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:148

---

getUniformVector2

▸ getUniformVector2(arg0): Vector2

Parameters

Name	Type
arg0	string

Returns

Vector2

Inherited from

Shader.getUniformVector2

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:152

---

getUniformVector3

▸ getUniformVector3(arg0): Vector3

Parameters

Name	Type
arg0	string

Returns

Vector3

Inherited from

Shader.getUniformVector3

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:156

---

getUniformVector4

▸ getUniformVector4(arg0): Vector4

Parameters

Name	Type
arg0	string

Returns

Vector4

Inherited from

Shader.getUniformVector4

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:160

---

getUniformColor

▸ getUniformColor(arg0): Color

Parameters

Name	Type
arg0	string

Returns

Color

Inherited from

Shader.getUniformColor

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:164

---

setTexture

▸ setTexture(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	Texture

Returns

void

Inherited from

Shader.setTexture

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:168

---

getTexture

▸ getTexture(arg0): Texture

Parameters

Name	Type
arg0	string

Returns

Texture

Inherited from

Shader.getTexture

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:177

---

setUniformBuffer

▸ setUniformBuffer(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	UniformGPUBuffer

Returns

void

Inherited from

Shader.setUniformBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:181

---

getUniformBuffer

▸ getUniformBuffer(arg0): GPUBufferBase

Parameters

Name	Type
arg0	string

Returns

GPUBufferBase

Inherited from

Shader.getUniformBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:189

---

setStorageBuffer

▸ setStorageBuffer(arg0, arg1): void

Parameters

Name	Type
arg0	string
arg1	StorageGPUBuffer

Returns

void

Inherited from

Shader.setStorageBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:193

---

getStorageBuffer

▸ getStorageBuffer(arg0): StorageGPUBuffer

Parameters

Name	Type
arg0	string

Returns

StorageGPUBuffer

Inherited from

Shader.getStorageBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:201

---

setStructStorageBuffer

▸ setStructStorageBuffer<T>(arg0, arg1): void

Type parameters

Name	Type
T	extends Struct

Parameters

Name	Type
arg0	string
arg1	StructStorageGPUBuffer<T>

Returns

void

Inherited from

Shader.setStructStorageBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:205

---

getStructStorageBuffer

▸ getStructStorageBuffer(arg0): GPUBufferBase

Parameters

Name	Type
arg0	string

Returns

GPUBufferBase

Inherited from

Shader.getStructStorageBuffer

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:213

---

noticeValueChange

▸ noticeValueChange(): void

Returns

void

Inherited from

Shader.noticeValueChange

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:217

---

destroy

▸ destroy(): void

Returns

void

Inherited from

Shader.destroy

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:225

---

clone

▸ clone(): Shader

Returns

Shader

Inherited from

Shader.clone

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:229

---

applyUniform

▸ applyUniform(): void

Returns

void

Inherited from

Shader.applyUniform

Defined in

src/gfx/graphics/webGpu/shader/Shader.ts:238

---

setDefault

▸ setDefault(): void

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:36

---

useCleanCoat

▸ useCleanCoat(): void

valid USE_CLEARCOAT define in shader

Returns

void

Defined in

src/loader/parser/prefab/mats/shader/StandShader.ts:422