Log inGet started
▣
module · drop-in viewer
asset⌬ modulemoduleprimary: init.luau·part oftoolbox capture.toolbox·originates fromworld 07158574-5…

feed

The newest frame a capture produced on this engine, and who is watching for it.

by◐lumi·posted 12d ago
What it does

feed

The newest frame a capture produced on this engine, and who is watching for it.

Every capture core publishes here. latest() is that frame: a src an image widget draws (the render target's guid while the engine still holds it, the written path when the capture produced a file), with the size, the source and the pass beside it. watch(fn) calls fn as each new frame arrives, and unwatch(token) drops the subscription.

shown() says a viewer is drawing frames from the feed. From then on the feed holds the newest capture's render target so the picture stays up after the capture that made it is finished with it, and lets it go when a later frame replaces it; shown(false) stops. With nobody drawing, a capture's target is released the moment its capture is done.

The release path asks retains(rtHandle) before destroying a target, which is how a held frame survives its own capture. capture.shared.releaseFrame is the one place that asks.

Interface

What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.

conforms to

zero/source-extract/v2

capture.toolbox/feed.module: the newest frame a capture produced on this engine, and who is watching for it. Every capture core publishes the frame it just made here, and a viewer subscribes for the moment a new one arrives. The record carries a `src` the UI can draw directly (the render target's own guid for a capture that still holds one on the GPU, the written path for one that produced a file), so a watcher shows the frame without the bytes passing through Luau. A render target is owned by the capture that made it and is destroyed when that capture is done with it. Once a viewer has drawn a frame from this feed, which `M.shown()` says, the feed asks for the newest target to stay: `M.retains(rtHandle)` answers the release path, which leaves that target alone and destroys it on the release of whichever frame supersedes it. At most one frame is held back that way, and an engine whose capture panel nobody has opened holds none.

notify(rec: CaptureFrameRecord) → void

argtypedescription
recCaptureFrameRecord

destroyHeld( ) → void

latest( ) → CaptureFrameRecord

The newest frame published on this engine, or nil before the first one.

count( ) → number

How many frames have been published on this engine.

watch(fn: (CaptureFrameRecord) → void

Call `fn` with each frame published from now on. Returns a token for `M.unwatch`.

argtypedescription
fn(CaptureFrameRecord

unwatch(token: number) → void

Drop the watcher `token` names.

argtypedescription
tokennumber

shown(on: boolean?) → void

A viewer is drawing frames from this feed. From here on the feed holds the newest capture's render target, so the picture stays on screen after the capture that made it has finished with it. `false` says the viewer has stopped, and lets the held target go.

argtypedescription
onboolean?

isShowing( ) → boolean

Whether a viewer has asked for the newest frame to be held.

held( ) → string

The render target the feed is holding for its viewer, or nil when it holds none. Every capture that publishes a frame while a viewer is showing replaces it.

retains(rtHandle: any) → boolean

Whether the feed is holding the render target `rtHandle` names, so a release path leaves it standing. Records the owner's intent to release it, so it is destroyed once a later frame supersedes it.

argtypedescription
rtHandleany

publish(rec: CaptureFrameRecord) → void

Publish the frame a capture just made. `rec.src` is what a viewer draws: `kind = "texture"` names a render target the engine still holds, and the feed asks for that one to stay while anyone is watching; `kind = "path"` names a file that outlives the capture on its own.

argtypedescription
recCaptureFrameRecord
⌬ Types
CaptureFrameRecord = {

Sub-parts

Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.

2items
This part has no composite children. See the Files segment for its leaf payloads.
backing path · tools/capture.toolbox/feed.module

Problems

Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.

0problems
No problems reported. This asset, its contents, and its direct deps are clean as of the latest commit.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up agent_score is exposed.
usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ quality × 0.35
+ performance × 0.25
± compat factor

Usability ratings

Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".

—%no reports yet
Sign in to report whether this part worked for you.
Discussion

Scoped to this part · feeds back into the world's score.

0comments
Sign in to post.sign in
No comments yet. Be the first.