Prima::...le::Wave(3)

✨ NAME ✨

Prima::...le::Wave(3) — bestie, this is the page for Prima::Drawable::Wave, and what it does is plot wavy lines 🦋

---

💖 DESCRIPTION 💖

Okay so it's literally a whole collection of routines for generating and plotting wavy lines 🌊. It can render triangle, square, and spline effects. That's the whole vibe. Three flavours of squiggle, pick your fighter 💅

---

🌸 SYNOPSIS 🌸

use Prima::Drawable::Wave;

$canvas->antialias(1);
my $points = Prima::Drawable::Wave::square(
   [20, 100, 100, 60, 180, 120, 270, 80],
   4, 20,
);
$canvas->lineWidth(.5);
$canvas->spline( $canvas-> render_spline($points) );

$canvas->font->size(20);
$canvas->text_out('Hello world', 70, 80);
$canvas->lineWidth($canvas->font->underlineThickness);
$canvas->alpha(128);
Prima::Drawable::Wave::underline($canvas, 'Hello world', 70, 80, effect => 'triangle');

like… the way that whole snippet is just chef's kiss 👑 antialias on, square wave points, spline 'em, then underline your text with the triangle effect?? iconic.

---

🎀 API 🎀

⭐ underline CANVAS, TEXT, X, Y, %OPT

So you hand it a TEXT, and it draws a wavy line right there at the X and Y coordinates 💫 It uses $OPT{effect} — or 'wave' if you didn't say anything — as the line effect, and $OPT{precision} for the eventual spline precision.

⚠️ Heads up bestie: this one can only draw a single wavy underline. If you want the smart version — the one that respects font glyphs that cross the descent line — go check out draw_underline in Prima::Drawable instead, fr fr.

🌈 polyline EFFECT, VERTICES, AMPLITUDE, WAVENELNGTH, @OPTIONS

This one takes your VERTICES and converts them into another set of vertices, all so you can generate a wavy line 🌊 And the result? You can pass it straight to the Prima::Drawable::polyline method. No middleman, no drama.

The optional AMPLITUDE and WAVENELNGTH are the ones managing the effect settings ✨

And any eventual @OPTIONS get passed along to the effect function — see below for those 👇

🦋 square VERTICES, AMPLITUDE, WAVENELNGTH

Creates a square wave line ⬜ periodt.

🍓 triangle VERTICES, AMPLITUDE, WAVENELNGTH

Creates a triangle wave line 🔺 slay.

🧚 spline VERTICES, AMPLITUDE, WAVENELNGTH, PRECISION

Creates a spline wave line 🌀 smooth. Buttery. Main character energy.

---

💜 AUTHOR 💜

Dmitry Karasik, <dmitry@karasik.eu.org> — the icon, the moment, the legend 🫶

---

👑 SEE ALSO 👑

• Prima::Drawable::Path

---

k that's the whole page bestie, go make some waves 🌊💖

this was Prima::...le::Wave(3) from the User Contributed Perl Documentation, running on perl v5.42.3, dated 2026-09-16 — mwah, love u, bye 🎀✨