Global

Members

# (readonly) NEGATIVE_Z :clay.Vector3

Source:
Type:

Type Definitions

# App3DNamespace

Source:
Properties:
Name Type Attributes Default Description
init function

Initialization callback that will be called when initing app. You can return a promise in init to start the loop asynchronously when the promise is resolved.

loop function

Loop callback that will be called each frame.

autoRender boolean <optional>
true

If render automatically each frame.

beforeRender function <optional>
afterRender function <optional>
width number <optional>

Container width.

height number <optional>

Container height.

devicePixelRatio number <optional>
methods Object.<string, function()> <optional>

Methods that will be injected to App3D#methods.

graphic Object <optional>

Graphic configuration including shadow, color space.

Properties
Name Type Attributes Default Description
shadow boolean <optional>
false

If enable shadow

linear boolean <optional>
false

If use linear color space

tonemapping boolean <optional>
false

If enable ACES tone mapping.

event boolean <optional>
false

If enable mouse/touch event. It will slow down the system if geometries are complex.

Type:
  • Object

# Color

Source:
Type:
  • string | Array.<number>

# DomQuery

Source:
Type:
  • HTMLElement | string

# ImageLike

Source:
Type:
  • string | HTMLCanvasElement | HTMLImageElement | HTMLVideoElement

# StandardMaterialMRConfig

Source:
Properties:
Name Type Attributes Default Description
shader string <optional>
'standardMR'
color Color <optional>
alpha number <optional>
metalness number <optional>
roughness number <optional>
emission Color <optional>
emissionIntensity number <optional>
transparent boolean <optional>
diffuseMap TextureLike <optional>
normalMap TextureLike <optional>
roughnessMap TextureLike <optional>
metalnessMap TextureLike <optional>
emissiveMap TextureLike <optional>
Type:
  • Object

# TextureLike

Source:
Type:
  • string | HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | clay.Texture2D