Migration

As a general migration requirement, if you have generated an HLSL shader from the Water Shader Graph, then you will need to regenerate if it changes.

Migrating from 5.6.6

The Crest/Water shader has renamed the flow keyword. Materials will automatically be upgraded in the background, but it can be run manually with Edit ‣ Crest ‣ Materials ‣ Upgrade Materials.

Migrating from Crest 4

Unfortunately, there is no migration path from Crest 4 to 5. This is due to merging three assets together, moved and renamed files, changes in GUIDs and huge changes to serialized data.

Since all GUIDs and file paths have changed, it is possible to import and run both Crest 4 and 5 in one project for manual migration.

When Crest 4 is installed, it adds CREST_OCEAN scripting symbol. When this symbol is present, all Crest 5 components are prefixed with Crest 5.

The following tables document items that have been renamed, removed or changed and their new counterpart.

Table 1 Components

Crest 4	Crest 5
BoatAlignNormal	FloatingObject
BoatProbes	FloatingObject
OceanDebugGUI	DebugGUI
OceanDepthCache	DepthProbe
OceanPlanarReflections	WaterRenderer1
OceanRenderer	WaterRenderer
OceanSampleHeightEvents	QueryEvents
OceanWaterInteraction	N/A1
OceanWaterInteractionAdapter	N/A1
RegisterAlbedoInput	AlbedoInput
RegisterAnimatedWavesInput	AnimatedWavesInput
RegisterClipSurfaceInput	ClipInput
RegisterDynamicWavesInput	DynamicWavesInput
RegisterFlowInput	FlowInput
RegisterFoamInput	FoamInput
RegisterHeightInput	WaterLevelInput
RegisterSeaFloorDepthInput	WaterDepthInput
RegisterShadowInput	ShadowInput
RegisterAlphaOnSurface	N/A1
ShapeGerstnerBatch	N/A1
SimpleFloatingObject	FloatingObject
UnderwaterEffect	N/A1
UnderwaterEnvironmentalLighting	WaterRenderer2
UnderwaterRenderer	WaterRenderer2
VisualiseCollisionArea	CollisionAreaVisualizer
VisualiseRayTrace	RayCastVisualizer

¹ Removed

² Merged into

Table 2 Shaders

Crest 4	Crest 5
CopyDepthBufferIntoCache	N/A1
Inputs/AnimatedWaves/GerstnerBatchGeometry	N/A1
Inputs/ShapeWaves/SampleSpectrum	Inputs/Waves/AddFromGeometry
Inputs/DynamicWaves/ObjectInteraction	N/A1
Inputs/Flow/AddFlowMap	Inputs/Flow/AddFromTexture
Inputs/Foam/AddFromVertColours	Inputs/Foam/AddFromVertexColors
Inputs/Foam/OverrideFoam	Inputs/All/Override
Inputs/All/ScaleByFactor	Inputs/All/Scale
Inputs/AnimatedWaves/GerstnerGeometry	Inputs/ShapeWaves/AddFromGeometry
Inputs/AnimatedWaves/SetBaseWaterHeightUsingGeometry	N/A1
Inputs/ClipSurface/ConvexHull	WatertightHull2
Inputs/ClipSurface/IncludeArea	Inputs/All/Override
Inputs/ClipSurface/RemoveArea	Inputs/All/Override
Inputs/ClipSurface/RemoveAreaTexture	N/A3
Inputs/SeaFloorDepth/SetBaseWaterHeightUsingGeometry	Inputs/Level/WaterLevelFromGeometry
Inputs/Depth/OceanDepthFromGeometry	Inputs/Depth/WaterDepthFromGeometry
Inputs/Depth/CachedDepths	N/A3
Inputs/Shadows/OverrideShadows	Inputs/All/Override
Inputs/AnimatedWaves/Whirlpool	Whirlpool4
Inputs/Flow/Whirlpool	Whirlpool4
Ocean	Water
OceanSurfaceAlpha	N/A1
UnderwaterCurtain	N/A1
UnderwaterMeniscus	N/A1

¹ Removed

² Replaced with component

³ Replaced with Texture Mode

Table 3 Scripting API

Crest 4	Crest 5
SampleHeightHelper	SampleCollisionHelper

Crest 4 never had an official API, thus only the most important changes have been listed. Furthermore, our namespace has changed from Crest to WaveHarmonic.Crest.