ludic/screen-clear.html
2026-09-17 22:10:03 +00:00

40 lines
No EOL
2.4 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Screen.clear — Ludic</title>
<meta name="description" content="Fill the whole framebuffer with one color to start a fresh frame.">
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="docs.css">
</head>
<body>
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
<main class="wrap item">
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="ns-screen.html">Screen — drawing</a> <span>›</span> <span class="here">Screen.clear</span></div>
<div class="item-head">
<span class="kind-badge kind-method">method</span>
<h1 id="top">Screen.clear</h1>
</div>
<code class="sig">Screen.clear(color)</code>
<div class="desc"><p>Paints every pixel of the framebuffer a single color, wiping whatever the previous frame drew. Call it first inside your <code>Render</code> handler so each frame starts from a known background instead of leftover pixels. The one argument is a color, which can be a named palette value such as <code>Color.MidnightBlue</code> or a raw hex literal like <code>0x0d1020</code>. After clearing, draw the scene on top and finish with <code>Screen.show()</code>.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-color"><code class="pname">color</code><span class="pdesc">the background color to fill with, e.g. a <code>Color.*</code> name or a <code>0xRRGGBB</code> literal</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ClearBackground {
var elapsed_frames: int = 0
handler CountFrames phase Update {
elapsed_frames = elapsed_frames + 1
}
handler DrawWorld phase Render {
Screen.clear(Color.MidnightBlue)
Screen.draw_number(x: 8, y: 8, value: elapsed_frames, color: Color.White, scale: 1)
Screen.show()
}
}</pre></div>
<a class="back" href="api.html">← All symbols</a>
</main>
<script src="ludic-highlight.js"></script>
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
</body></html>