sd_read_preview: Read the current preview frame
In sd2R: Stable Diffusion Image Generation
sd_read_preview R Documentation
Read the current preview frame
Description
Reads the latest preview PPM written by the running generation and returns
it as an sd_image list. Returns NULL if no preview exists yet (e.g.
generation has not produced a frame). Optionally writes a PNG copy.
Usage
sd_read_preview(path, png_path = NULL)
Arguments
path
The preview PPM path passed to sd_preview_start.
png_path
Optional path; if set, the frame is also written there as
PNG via sd_save_image.
Value
An sd_image list (width, height, channel,
data), or NULL if unavailable.
See Also
sd_preview_start
sd2R documentation built on June 19, 2026, 9:08 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| sd_read_preview | R Documentation |
Read the current preview frame
Description
Reads the latest preview PPM written by the running generation and returns
it as an sd_image list. Returns NULL if no preview exists yet (e.g.
generation has not produced a frame). Optionally writes a PNG copy.
Usage
sd_read_preview(path, png_path = NULL)
Arguments
path |
The preview PPM path passed to |
png_path |
Optional path; if set, the frame is also written there as
PNG via |
Value
An sd_image list (width, height, channel,
data), or NULL if unavailable.
See Also
sd_preview_start
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.