Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# `Hydra.sim.erosion`

Module responsible for water erosion.

## Module Contents

Hydra.sim.erosion.erosionPrepare(obj: bpy.types.Object | bpy.types.Image)

  Prepares textures for water erosion.

  Parameters:

    obj (`bpy.types.Object` or `bpy.types.Image`) – Object or image to erode.

Hydra.sim.erosion.erosionRun(obj: bpy.types.Object | bpy.types.Image)

  Erodes the specified entity. Can be run multiple times.

  Parameters:

    obj (`bpy.types.Object` or `bpy.types.Image`) – Object or image to erode.

Hydra.sim.erosion.erosionFinish(obj: bpy.types.Object | bpy.types.Image) → list[bpy.types.Image]

  Releases resources allocated for water erosion.

  Parameters:

    obj (`bpy.types.Object` or `bpy.types.Image`) – Object or image that was eroded.