LitSpriteOptions

Defined in: packages/nodes/src/lighting/lit.ts:262

Combined sprite lighting with diffuse, specular, and optional rim. Convenience function that combines common lighting components.

Param

Surface normal

Param

Base surface color

Param

Light result from pointLight2D, directionalLight2D, etc.

Param

Ambient light result

Param

Additional lighting options

Example

const lit = litSprite(normal, inputColor, pointLight, ambient, {
  specular: true,
  shininess: 32,
  rim: true,
  rimColor: [0.5, 0.8, 1]
})

Properties

rim?

optional rim?: boolean

Defined in: packages/nodes/src/lighting/lit.ts:270

Enable rim lighting

---

rimColor?

optional rimColor?: Vec3Input

Defined in: packages/nodes/src/lighting/lit.ts:272

Rim light color

---

rimPower?

optional rimPower?: FloatInput

Defined in: packages/nodes/src/lighting/lit.ts:274

Rim power (default: 2)

---

rimStrength?

optional rimStrength?: FloatInput

Defined in: packages/nodes/src/lighting/lit.ts:276

Rim strength (default: 1)

---

shininess?

optional shininess?: FloatInput

Defined in: packages/nodes/src/lighting/lit.ts:266

Specular shininess (default: 32)

---

specular?

optional specular?: boolean

Defined in: packages/nodes/src/lighting/lit.ts:264

Enable specular highlights

---

specularStrength?

optional specularStrength?: FloatInput

Defined in: packages/nodes/src/lighting/lit.ts:268

Specular strength (default: 0.5)

---

viewDir?

optional viewDir?: Vec3Input

Defined in: packages/nodes/src/lighting/lit.ts:278

View direction for specular/rim (default: [0, 0, 1])