Starter template

Render effects the starter template ships in the scaffolded project's source.

On this page

Generated from the engine's capability manifest: 3 functions. Each entry is the exported signature, what it is for, and a working example.

gradualBackground

function · import { gradualBackground } from "@threenative/template/starter/src/render/effects/gradualBackground"

ThreeNative equivalent for realism-effects gradualBackground.

ts
function gradualBackground

Use it to

  • grade a background by distance

Example

ts
gradualBackground(...)

Good to know

  • Use the running WebGPU renderer and keep appearance choices in template render source.

lensDistortion

function · import { lensDistortion } from "@threenative/template/starter/src/render/effects/lensDistortion"

ThreeNative equivalent for realism-effects lensDistortion.

ts
function lensDistortion

Use it to

  • warp the image with radial lens distortion

Example

ts
lensDistortion(...)

Good to know

  • Use the running WebGPU renderer and keep appearance choices in template render source.

sparkle

function · import { sparkle } from "@threenative/template/starter/src/render/effects/sparkle"

ThreeNative equivalent for realism-effects sparkle.

ts
function sparkle

Use it to

  • add glints to bright highlights

Example

ts
sparkle(...)

Good to know

  • Use the running WebGPU renderer and keep appearance choices in template render source.
View source on GitHub ↗