Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode
Crest Water
Light Logo Dark Logo

About

  • Introduction
  • Integrations
  • Known Issues
  • Release Notes

Manual

  • Getting Started
    • Initial Setup
    • Migration
    • Usage Guide
    • Quick Start Guide
  • Basics
    • Water Appearance
    • Underwater
    • Water Inputs
    • Waves
    • Water Exclusion
    • Water Level
    • Water Bodies
    • Shorelines and Shallows
    • Flow
    • Floating Objects
    • Events
  • Advanced
    • Queries
    • Time Control
    • Open Worlds
    • Rendering
    • Scripting
  • Guides
    • Performance Guide
    • Rendering Notes
    • System Notes
  • Frequently Asked Questions

Packages

  • CPU Queries
    • Introduction
    • Release Notes
    • CPU Queries
  • Paint
    • Introduction
    • Release Notes
    • Paint
  • Portals
    • Introduction
    • Release Notes
    • Portals & Volumes
  • Shallow Water
    • Introduction
    • Release Notes
    • Shallow Water Simulation
  • Shifting Origin
    • Introduction
    • Release Notes
    • Shifting Origin
  • Splines
    • Introduction
    • Release Notes
    • Splines
  • Whirlpool
    • Introduction
    • Release Notes
    • Whirlpool

API

  • Crest
    • AbsorptionLod
    • AbsorptionLodInput
    • AbsorptionRendererLodInputData
    • AbsorptionTextureLodInputData
    • AlbedoLod
    • AlbedoLodInput
    • AlbedoRendererLodInputData
    • AnimatedWavesLod
    • AnimatedWavesLodInput
    • AnimatedWavesRendererLodInputData
    • ClipLod
    • ClipLodInput
    • ClipRendererLodInputData
    • ClipTextureLodInputData
    • CollisionLayer
    • CollisionLayers
    • CollisionSource
    • ColorLod
    • Control
    • Controller
    • CustomTimeProvider
    • CutsceneTimeProvider
    • DefaultClippingState
    • DepthGeometryLodInputData
    • DepthLod
    • DepthLodInput
    • DepthProbe
    • DepthProbeMode
    • DepthProbeRefreshMode
    • DepthRendererLodInputData
    • DepthTextureLodInputData
    • DirectionalTextureLodInputData
    • DisplacementPass
    • DynamicWavesLod
    • DynamicWavesLodInput
    • DynamicWavesLodSettings
    • DynamicWavesRendererLodInputData
    • FixedControl
    • FloatingObject
    • FloatingObjectModel
    • FloatingObjectProbe
    • FlowLod
    • FlowLodInput
    • FlowRendererLodInputData
    • FlowTextureLodInputData
    • FoamLod
    • FoamLodInput
    • FoamLodSettings
    • FoamRendererLodInputData
    • FoamTextureLodInputData
    • GeometryLodInputData
    • ICollisionProvider
    • IDepthProvider
    • IFlowProvider
    • IQueryProvider
    • ITimeProvider
    • LevelGeometryLodInputData
    • LevelLod
    • LevelLodInput
    • LevelRendererLodInputData
    • LevelTextureLodInputData
    • Lod
    • Lod<T>
    • LodInput
    • LodInputBlend
    • LodInputData
    • LodInputMode
    • LodInputPrimitive
    • LodSettings
    • LodTextureFormatMode
    • Meniscus
    • NetworkedTimeProvider
    • PersistentLod
    • Placement
    • PortalMode
    • PortalRenderer
    • QualitySettingsOverride
    • QueryEvents
    • QuerySource
    • RayCastHelper
    • RendererLodInputData
    • SampleCollisionHelper
    • SampleDepthHelper
    • SampleFlowHelper
    • ScatteringLod
    • ScatteringLodInput
    • ScatteringRendererLodInputData
    • ScatteringTextureLodInputData
    • ShadowLod
    • ShadowLodInput
    • ShadowRendererLodInputData
    • ShapeFFT
    • ShapeGerstner
    • ShapeWaves
    • ShapeWavesRendererLodInputData
    • ShapeWavesTextureLodInputData
    • ShorelineVolumeColorSource
    • SphereWaterInteraction
    • SurfaceRenderer
    • TextureLodInputData
    • TimeProvider
    • UnderwaterRenderer
    • WaterBody
    • WaterInjectionPoint
    • WaterReflectionSide
    • WaterReflections
    • WaterRenderer
    • WatertightHull
    • WatertightHullMode
    • WaveSpectrum
  • Crest.Whirlpool
    • Whirlpool
  • Crest.Splines
    • AbsorptionSplineLodInputData
    • AbsorptionSplinePointData
    • FlowSplineLodInputData
    • FlowSplinePointData
    • FoamSplineLodInputData
    • FoamSplinePointData
    • LevelSplineLodInputData
    • ScatteringSplineLodInputData
    • ScatteringSplinePointData
    • ShapeWavesSplineLodInputData
    • Spline
    • SplineLodInputData
    • SplineOffset
    • SplinePoint
    • SplinePointData
    • WavesSplinePointData
  • Crest.ShiftingOrigin
    • ShiftingOrigin
  • Crest.ShallowWater
    • ShallowWaterSimulation
    • ShallowWaterSimulationInjection
    • ShallowWaterSimulationMode
    • ShallowWaterSimulationPreset
  • Crest.Scripting
    • Extensions
Back to top

DepthProbeRefreshMode¶

Enum in WaveHarmonic.Crest, WaveHarmonic.Crest

How the DepthProbe refreshes when using DepthProbeMode.RealTime.

Members¶

Properties¶

OnStart

Populates the DepthProbe in Start.

ViaScripting

Requires manual updating via DepthProbe.Populate.

Next
DepthRendererLodInputData
Previous
DepthProbeMode
Copyright © 2024, Wave Harmonic
On this page
  • DepthProbeRefreshMode
    • Members
      • Properties