22 lines
No EOL
3.5 KiB
HTML
22 lines
No EOL
3.5 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Assets — Ludic</title>
|
||
<meta name="description" content="Loading and lookup for whole-file assets, paired with the Sprite.* atlas API.">
|
||
<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> <span class="here">Assets</span></div>
|
||
<div class="item-head"><span class="kind-badge kind-namespace">namespace</span><h1 id="top">Assets</h1></div>
|
||
<p class="ns-blurb">Loading and lookup for whole-file assets, paired with the <a href="sprite-sheet"><code>Sprite.*</code></a> atlas API. <a href="assets-image"><code>Assets.image</code></a> (and its alias <a href="assets-load"><code>Assets.load</code></a>) loads a whole image file as one sprite; <a href="assets-get"><code>Assets.get</code></a> looks a named sprite up.</p>
|
||
<div class="ns-methods"><a class="ns-method" href="assets-image.html"><code class="nm-sig">Assets.image(path) -> int</code><span class="nm-tip">Load a whole image file as one sprite; returns its id.</span></a><a class="ns-method" href="assets-load.html"><code class="nm-sig">Assets.load(path) -> int</code><span class="nm-tip">Alias of Assets.image.</span></a><a class="ns-method" href="assets-get.html"><code class="nm-sig">Assets.get(name) -> int</code><span class="nm-tip">Look up a named sprite's id (alias of Sprite.named).</span></a><a class="ns-method" href="assets-enqueue.html"><code class="nm-sig">Assets.enqueue(name, path)</code><span class="nm-tip">Queue a named image file to preload later.</span></a><a class="ns-method" href="assets-pump.html"><code class="nm-sig">Assets.pump(max) -> int</code><span class="nm-tip">Load up to max queued assets this frame; returns how many it loaded.</span></a><a class="ns-method" href="assets-total.html"><code class="nm-sig">Assets.total() -> int</code><span class="nm-tip">How many assets are enqueued.</span></a><a class="ns-method" href="assets-loaded.html"><code class="nm-sig">Assets.loaded() -> int</code><span class="nm-tip">How many enqueued assets have loaded so far.</span></a><a class="ns-method" href="assets-ready.html"><code class="nm-sig">Assets.ready() -> int</code><span class="nm-tip">1 once every enqueued asset has loaded.</span></a><a class="ns-method" href="assets-font.html"><code class="nm-sig">Assets.font(name: s) -> int</code><span class="nm-tip">A font loaded through the preload queue, by name.</span></a><a class="ns-method" href="assets-progress.html"><code class="nm-sig">Assets.progress() -> int</code><span class="nm-tip">Loading progress as a 0..100 percent.</span></a><a class="ns-method" href="assets-enqueue_dir.html"><code class="nm-sig">Assets.enqueue_dir(path: dir)</code><span class="nm-tip">Enqueue every file of a directory, named by its file name.</span></a></div>
|
||
<a class="back" href="api.html">← All symbols</a>
|
||
</main>
|
||
<script src="ludic-highlight.js"></script>
|
||
<script>Ludic.installCards(); Ludic.flashTarget();</script>
|
||
</body></html> |