pixi-effects 0.12.0 → 0.13.0

package/dist/index.cjs

@@ -1569,7 +1569,7 @@ ${offset}
 }
 
 // src/core/stops.ts
-var KEYS = ["at", "page", "notes", "advance"];
+var KEYS = ["at", "page", "notes", "advance", "pdf"];
 function normalizeStops(raw, duration, frameRate) {
   if (!raw || raw.length === 0) return [];
   const total = Math.round(duration * frameRate);
@@ -1577,7 +1577,7 @@ function normalizeStops(raw, duration, frameRate) {
   raw.forEach((r, i) => {
     const spec = typeof r === "number" ? { at: r } : r && typeof r === "object" ? r : null;
     if (!spec || typeof spec.at !== "number" || !Number.isFinite(spec.at)) {
-      console.warn(`pixi-effects: stops[${i}] ${JSON.stringify(r)} is not a time in seconds (or { at, page?, notes?, advance? }); ignored`);
+      console.warn(`pixi-effects: stops[${i}] ${JSON.stringify(r)} is not a time in seconds (or { at, page?, notes?, advance?, pdf? }); ignored`);
       return;
     }
     if (typeof r === "object") chunkUQBGW5DO_cjs.warnUnknownOptions(`stops[${i}]`, r, KEYS);
@@ -1613,6 +1613,10 @@ function normalizeStops(raw, duration, frameRate) {
       if (typeof s.advance === "number" && Number.isFinite(s.advance) && s.advance >= 0) stop.advance = s.advance;
       else console.warn(`pixi-effects: stops[${index}] advance must be a number of seconds >= 0, got ${JSON.stringify(s.advance)}; ignored`);
     }
+    if (s.pdf !== void 0) {
+      if (typeof s.pdf === "boolean") stop.pdf = s.pdf;
+      else console.warn(`pixi-effects: stops[${index}] pdf must be true or false, got ${JSON.stringify(s.pdf)}; ignored`);
+    }
     return stop;
   });
 }
@@ -1630,6 +1634,20 @@ function stopAtOrBefore(stops, frame) {
 function pageStarts(stops) {
   return stops.filter((s) => s.pageStart);
 }
+function pictureStops(stops, opts = {}) {
+  if (opts.which === "stops") return opts.pdf ? stops.filter((s) => s.pdf !== false) : [...stops];
+  const byPage = /* @__PURE__ */ new Map();
+  for (const s of stops) byPage.set(s.pageIndex, [...byPage.get(s.pageIndex) ?? [], s]);
+  const take = (list) => opts.pick === "first" ? list[0] : list[list.length - 1];
+  const picks = [];
+  for (const list of byPage.values()) {
+    const flagged = list.filter((s) => s.pdf === true);
+    const usable = list.filter((s) => s.pdf !== false);
+    const one = take(flagged.length ? flagged : usable.length ? usable : opts.pdf ? [] : list);
+    if (one) picks.push(one);
+  }
+  return picks;
+}
 
 // src/core/loader.ts
 var FADE_FALLBACK_MS = 900;
@@ -1932,16 +1950,10 @@ var Movie = class {
     return encodeCanvas(out, o.type, o.as, o.quality);
   }
   async stopImages(opts = {}) {
-    chunkUQBGW5DO_cjs.warnUnknownOptions("movie.stopImages()", opts, ["which", "pick", "scale", "type", "quality", "as", "motionBlur", "onImage"]);
+    chunkUQBGW5DO_cjs.warnUnknownOptions("movie.stopImages()", opts, ["which", "pick", "scale", "type", "quality", "as", "motionBlur", "pdf", "onImage"]);
     this._requireReady("stopImages");
     if (this.stops.length === 0) return [];
-    let picks;
-    if (opts.which === "stops") picks = this.stops;
-    else {
-      const byPage = /* @__PURE__ */ new Map();
-      for (const s of this.stops) byPage.set(s.pageIndex, [...byPage.get(s.pageIndex) ?? [], s]);
-      picks = [...byPage.values()].map((list) => opts.pick === "first" ? list[0] : list[list.length - 1]);
-    }
+    const picks = pictureStops(this.stops, { which: opts.which, pick: opts.pick, pdf: opts.pdf });
     this.pause();
     const back = this.currentFrame, wasAtPoster = this._atPoster;
     const out = [];
@@ -1965,7 +1977,8 @@ var Movie = class {
     return out;
   }
   /**
-   * The deck as a PDF: one page per page of the talk (the page's last stop, fully built; `which: 'stops'` makes a page of every stop), each a
+   * The deck as a PDF: one page per page of the talk (the page's last stop, fully built, unless a stop says `pdf: true` or `pdf: false`;
+   * `which: 'stops'` makes a page of every stop that is not `pdf: false`), each a
    * JPEG at the canvas size. Needs `composition.stops`. A transparent background comes out black: give the movie a `background`.
    */
   async exportPDF(opts = {}) {
@@ -1981,6 +1994,7 @@ var Movie = class {
       quality: opts.quality ?? 0.92,
       as: "blob",
       motionBlur: opts.motionBlur,
+      pdf: true,
       onImage: opts.onImage
     });
     const pages = await Promise.all(images.map(async (i) => ({
@@ -3215,7 +3229,11 @@ function deck(options) {
     const id = `page-${i + 1}`;
     const label = page.name ? `"${page.name}"` : `pages[${i}]`;
     const isLast = i === pages.length - 1;
-    const local = page.stops ?? [isLast ? page.duration : page.duration - overlap];
+    const entries = (page.stops ?? [isLast ? page.duration : page.duration - overlap]).map((e, k) => {
+      if (e && typeof e === "object") chunkUQBGW5DO_cjs.warnUnknownOptions(`deck() page ${label} stops[${k}]`, e, ["at", "pdf"]);
+      return typeof e === "object" && e !== null ? e : { at: e };
+    });
+    const local = entries.map((e) => e.at);
     local.forEach((s, k) => {
       if (!(typeof s === "number" && Number.isFinite(s) && s > 0 && s <= page.duration + 1e-9)) throw new Error(`deck(): page ${label} has stop ${String(s)}, outside the page (0 to ${page.duration} s)`);
       if (k > 0 && s <= local[k - 1]) throw new Error(`deck(): page ${label} stops must be in order, earliest first (got ${local.join(", ")})`);
@@ -3229,6 +3247,7 @@ function deck(options) {
         if (page.notes !== void 0) stop.notes = page.notes;
       }
       if (k === local.length - 1 && page.advance !== void 0) stop.advance = page.advance;
+      if (entries[k].pdf !== void 0) stop.pdf = entries[k].pdf;
       stops.push(stop);
     });
     if (transition && !isLast) {
@@ -3293,6 +3312,7 @@ exports.measureText = measureText;
 exports.normalizeStops = normalizeStops;
 exports.orbit = orbit;
 exports.particles = particles;
+exports.pictureStops = pictureStops;
 exports.react = react;
 exports.resolveLoader = resolveLoader;
 exports.splitText = splitText;