Matrix Engine Api Documentation - v2.0.0
Preparing search index...
WaterSimEffect
Class WaterSimEffect
Index
Constructors
constructor
Properties
_
caustics
Bind
Groups
_
drop
Queue
_
final
Matrix
_
idle
Frames
_
idle
Threshold
_
index
Format
_
last
Eye
_
local
Matrix
_
parity
_
phys
Views
_
sim
Format
_
sphere
Stamp
_
surface
Bind
Groups
caustic
Intensity
caustics
Pipeline
caustics
Texture
common
Uniform
Buffer
data
data2
detail
device
drop
Bind
Groups
drop
Pipeline
drop
Pipeline
UB
enabled
floor
Sampler
floor
Texture
format
fresnel
Min
height
index
Buffer
index
Count
ior
light
Direction
light
Uniform
Buffer
model
Buffer
normal
Bind
Groups
normal
Pipeline
normal
Pipeline
UB
pool
Height
position
Buffer
sampler
size
sphere
Bind
Groups
sphere
Pipeline
sphere
Pipeline
UB
surface
Bind
Group
Layout
surface
Pipeline
Above
surface
Pipeline
Under
texture
A
texture
B
update
Bind
Groups
update
Pipeline
update
Pipeline
UB
water
Uniform
Buffer
width
_
pipeline
Cache
_
shader
Cache
Methods
_
build
Caustics
Pipeline
_
build
Sim
Pipeline
_
build
Surface
Pipelines
_
create
Caustics
Bind
Groups
_
create
Sampler
_
create
Sim
Uniform
Buffers
_
create
Surface
Bind
Groups
_
create
Surface
Mesh
_
create
Textures
_
create
Uniform
Buffers
_
init
Cached
Pipelines
_
run
Caustics
Pass
_
run
Sim
Pass
_
write
Light
Uniforms
_
write
Water
Uniforms
add
Drop
render
set
Eye
Position
set
Light
Direction
simulate
stamp
Sphere
update
Instance
Data
update
Water
Parameters
use
External
Geometry
Constructors
constructor
new
WaterSimEffect
(
device
:
any
,
format
:
any
,
options
?:
{}
)
:
WaterSimEffect
Parameters
device
:
any
format
:
any
options
:
{}
= {}
Returns
WaterSimEffect
Properties
_
caustics
Bind
Groups
_causticsBindGroups
:
any
[]
_
drop
Queue
_dropQueue
:
any
[]
_
final
Matrix
_finalMatrix
:
Mat4
_
idle
Frames
_idleFrames
:
number
_
idle
Threshold
_idleThreshold
:
number
_
index
Format
_indexFormat
:
string
_
last
Eye
_lastEye
:
any
_
local
Matrix
_localMatrix
:
Mat4
_
parity
_parity
:
any
_
phys
Views
_physViews
:
any
[]
_
sim
Format
_simFormat
:
string
_
sphere
Stamp
_sphereStamp
:
{
newCenter
:
any
;
oldCenter
:
any
;
radius
:
any
}
_
surface
Bind
Groups
_surfaceBindGroups
:
any
[]
caustic
Intensity
causticIntensity
:
any
caustics
Pipeline
causticsPipeline
:
any
caustics
Texture
causticsTexture
:
any
common
Uniform
Buffer
commonUniformBuffer
:
any
data
data
:
Float32Array
<
ArrayBuffer
>
data2
data2
:
Float32Array
<
ArrayBuffer
>
detail
detail
:
any
device
device
:
any
drop
Bind
Groups
dropBindGroups
:
any
[]
drop
Pipeline
dropPipeline
:
any
drop
Pipeline
UB
dropPipelineUB
:
any
enabled
enabled
:
boolean
floor
Sampler
floorSampler
:
any
floor
Texture
floorTexture
:
any
format
format
:
any
fresnel
Min
fresnelMin
:
any
height
height
:
any
index
Buffer
indexBuffer
:
any
index
Count
indexCount
:
any
ior
ior
:
any
light
Direction
lightDirection
:
any
light
Uniform
Buffer
lightUniformBuffer
:
any
model
Buffer
modelBuffer
:
any
normal
Bind
Groups
normalBindGroups
:
any
[]
normal
Pipeline
normalPipeline
:
any
normal
Pipeline
UB
normalPipelineUB
:
any
pool
Height
poolHeight
:
any
position
Buffer
positionBuffer
:
any
sampler
sampler
:
any
size
size
:
any
sphere
Bind
Groups
sphereBindGroups
:
any
[]
sphere
Pipeline
spherePipeline
:
any
sphere
Pipeline
UB
spherePipelineUB
:
any
surface
Bind
Group
Layout
surfaceBindGroupLayout
:
any
surface
Pipeline
Above
surfacePipelineAbove
:
any
surface
Pipeline
Under
surfacePipelineUnder
:
any
texture
A
textureA
:
any
texture
B
textureB
:
any
update
Bind
Groups
updateBindGroups
:
any
[]
update
Pipeline
updatePipeline
:
any
update
Pipeline
UB
updatePipelineUB
:
any
water
Uniform
Buffer
waterUniformBuffer
:
any
width
width
:
any
Static
_
pipeline
Cache
_pipelineCache
:
WeakMap
<
WeakKey
,
any
>
= ...
Static
_
shader
Cache
_shaderCache
:
WeakMap
<
WeakKey
,
any
>
= ...
Methods
_
build
Caustics
Pipeline
_buildCausticsPipeline
()
:
void
Returns
void
_
build
Sim
Pipeline
_buildSimPipeline
(
label
:
any
,
fragCode
:
any
,
uniformSize
:
any
,
)
:
{
label
:
any
;
pipeline
:
any
}
Parameters
label
:
any
fragCode
:
any
uniformSize
:
any
Returns
{
label
:
any
;
pipeline
:
any
}
_
build
Surface
Pipelines
_buildSurfacePipelines
()
:
void
Returns
void
_
create
Caustics
Bind
Groups
_createCausticsBindGroups
()
:
void
Returns
void
_
create
Sampler
_createSampler
()
:
void
Returns
void
_
create
Sim
Uniform
Buffers
_createSimUniformBuffers
()
:
void
Returns
void
_
create
Surface
Bind
Groups
_createSurfaceBindGroups
()
:
void
Returns
void
_
create
Surface
Mesh
_createSurfaceMesh
()
:
void
Returns
void
_
create
Textures
_createTextures
()
:
void
Returns
void
_
create
Uniform
Buffers
_createUniformBuffers
(
options
:
any
)
:
void
Parameters
options
:
any
Returns
void
_
init
Cached
Pipelines
_initCachedPipelines
()
:
void
Returns
void
_
run
Caustics
Pass
_runCausticsPass
(
encoder
:
any
)
:
void
Parameters
encoder
:
any
Returns
void
_
run
Sim
Pass
_runSimPass
(
encoder
:
any
,
label
:
any
,
pipelineObj
:
any
,
bindGroups
:
any
,
uniformBuffer
:
any
,
uniformData
:
any
,
)
:
void
Parameters
encoder
:
any
label
:
any
pipelineObj
:
any
bindGroups
:
any
uniformBuffer
:
any
uniformData
:
any
Returns
void
_
write
Light
Uniforms
_writeLightUniforms
()
:
void
Returns
void
_
write
Water
Uniforms
_writeWaterUniforms
()
:
void
Returns
void
add
Drop
addDrop
(
x
:
any
,
z
:
any
,
radius
?:
number
,
strength
?:
number
)
:
void
Parameters
x
:
any
z
:
any
radius
:
number
= 0.03
strength
:
number
= 0.01
Returns
void
render
render
(
pass
:
any
,
mesh
:
any
,
viewProjMatrix
:
any
)
:
void
Parameters
pass
:
any
mesh
:
any
viewProjMatrix
:
any
Returns
void
set
Eye
Position
setEyePosition
(
pos
:
any
)
:
void
Parameters
pos
:
any
Returns
void
set
Light
Direction
setLightDirection
(
x
:
any
,
y
:
any
,
z
:
any
)
:
void
Parameters
x
:
any
y
:
any
z
:
any
Returns
void
simulate
simulate
(
commandEncoder
:
any
)
:
void
Parameters
commandEncoder
:
any
Returns
void
stamp
Sphere
stampSphere
(
oldCenter
:
any
,
newCenter
:
any
,
radius
:
any
)
:
void
Parameters
oldCenter
:
any
newCenter
:
any
radius
:
any
Returns
void
update
Instance
Data
updateInstanceData
(
baseModelMatrix
:
any
)
:
void
Parameters
baseModelMatrix
:
any
Returns
void
update
Water
Parameters
updateWaterParameters
(
__namedParameters
?:
{}
)
:
void
Parameters
__namedParameters
:
{}
= {}
Returns
void
use
External
Geometry
useExternalGeometry
(
positionBuffer
:
any
,
indexBuffer
:
any
,
indexCount
:
any
,
indexFormat
?:
string
,
)
:
void
Parameters
positionBuffer
:
any
indexBuffer
:
any
indexCount
:
any
indexFormat
:
string
= 'uint32'
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_
caustics
Bind
Groups
_
drop
Queue
_
final
Matrix
_
idle
Frames
_
idle
Threshold
_
index
Format
_
last
Eye
_
local
Matrix
_
parity
_
phys
Views
_
sim
Format
_
sphere
Stamp
_
surface
Bind
Groups
caustic
Intensity
caustics
Pipeline
caustics
Texture
common
Uniform
Buffer
data
data2
detail
device
drop
Bind
Groups
drop
Pipeline
drop
Pipeline
UB
enabled
floor
Sampler
floor
Texture
format
fresnel
Min
height
index
Buffer
index
Count
ior
light
Direction
light
Uniform
Buffer
model
Buffer
normal
Bind
Groups
normal
Pipeline
normal
Pipeline
UB
pool
Height
position
Buffer
sampler
size
sphere
Bind
Groups
sphere
Pipeline
sphere
Pipeline
UB
surface
Bind
Group
Layout
surface
Pipeline
Above
surface
Pipeline
Under
texture
A
texture
B
update
Bind
Groups
update
Pipeline
update
Pipeline
UB
water
Uniform
Buffer
width
_
pipeline
Cache
_
shader
Cache
Methods
_
build
Caustics
Pipeline
_
build
Sim
Pipeline
_
build
Surface
Pipelines
_
create
Caustics
Bind
Groups
_
create
Sampler
_
create
Sim
Uniform
Buffers
_
create
Surface
Bind
Groups
_
create
Surface
Mesh
_
create
Textures
_
create
Uniform
Buffers
_
init
Cached
Pipelines
_
run
Caustics
Pass
_
run
Sim
Pass
_
write
Light
Uniforms
_
write
Water
Uniforms
add
Drop
render
set
Eye
Position
set
Light
Direction
simulate
stamp
Sphere
update
Instance
Data
update
Water
Parameters
use
External
Geometry
Matrix Engine Api Documentation - v2.0.0
Loading...