Class: GlobalFog

screen space fog

Hierarchy

• PostBase

  ↳ GlobalFog

Constructors

• constructor

Properties

• _globalFog
• enable
• postRenderer

Accessors

• fogType
• fogHeightScale
• start
• end
• ins
• density
• skyRoughness
• skyFactor
• overrideSkyFactor
• falloff
• rayLength
• scatteringExponent
• dirHeightLine

Methods

• onResize
• destroy

Constructors

constructor

• new GlobalFog(): GlobalFog

Returns

GlobalFog

Overrides

PostBase.constructor

Defined in

src/gfx/renderJob/post/GlobalFog.ts:32

Properties

_globalFog

• _globalFog: GlobalFogSetting

Defined in

src/gfx/renderJob/post/GlobalFog.ts:30

---

enable

• enable: boolean = true

Inherited from

PostBase.enable

Defined in

src/gfx/renderJob/post/PostBase.ts:20

---

postRenderer

• postRenderer: PostRenderer

Inherited from

PostBase.postRenderer

Defined in

src/gfx/renderJob/post/PostBase.ts:21

Accessors

fogType

• get fogType(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:87

• set fogType(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:83

---

fogHeightScale

• get fogHeightScale(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:94

• set fogHeightScale(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:90

---

start

• get start(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:101

• set start(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:97

---

end

• get end(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:108

• set end(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:104

---

ins

• get ins(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:115

• set ins(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:111

---

density

• get density(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:122

• set density(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:118

---

skyRoughness

• get skyRoughness(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:129

• set skyRoughness(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:125

---

skyFactor

• get skyFactor(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:136

• set skyFactor(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:132

---

overrideSkyFactor

• get overrideSkyFactor(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:144

• set overrideSkyFactor(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:140

---

falloff

• get falloff(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:168

• set falloff(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:163

---

rayLength

• get rayLength(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:177

• set rayLength(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:172

---

scatteringExponent

• get scatteringExponent(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:186

• set scatteringExponent(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:181

---

dirHeightLine

• get dirHeightLine(): number

Returns

number

Defined in

src/gfx/renderJob/post/GlobalFog.ts:195

• set dirHeightLine(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

src/gfx/renderJob/post/GlobalFog.ts:190

Methods

onResize

▸ onResize(): void

Returns

void

Inherited from

PostBase.onResize

Defined in

src/gfx/renderJob/post/PostBase.ts:73

---

destroy

▸ destroy(force?): void

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

PostBase.destroy

Defined in

src/gfx/renderJob/post/PostBase.ts:87