# DolphinSurfaceWave

Turn a position and frequency into a repeating wave that can drive stripes or another material property.

Last updated: 2026-09-09

Package: dolphin.materials | Status: source-declared

Tags: cpu, dolphin, dolphin.materials, function, materials, source-example

Compose linear-color surfaces and shared shading math in ordinary Yeho code.

```yh
external DolphinSurfaceWave(float coordinate,float frequency) returns float
```


## Use DolphinSurfaceWave

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using dolphin.materials

// Compose linear-color surfaces and shared shading math in ordinary Yeho code.
float coordinate = 1.0
float frequency = 1.0
float result = DolphinSurfaceWave(coordinate, frequency)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.dolphin_materials__dolphinsurfacewave"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.materials"
version = "0.1.0"
path = "../../../dolphin/packages/materials"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/dolphin.materials--DolphinSurfaceWave/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: dolphin/packages/materials/src/surface.yh

AI training permission: https://demonhunterlabs.com/ai-use