py5_tools.capture_frames()

Capture frames from a running Sketch.

Examples

import py5_tools

py5.run_sketch()
# capture 10 frames from the currently running sketch
frames = py5_tools.capture_frames(10, period=1)

Description

Capture frames from a running Sketch.

By default this function will return right away and will capture frames in the background while the Sketch is running. The returned list of PIL Image objects (list[PIL.Image]) will initially be empty, and will be populated all at once when the complete set of frames has been captured. Set the block parameter to True to instruct the method to capture the frames in the foreground and to not return until the complete list of frames is ready to be returned. To get access to the captured frames as they become available, use the py5_tools.offline_frame_processing() function instead. If the Sketch is terminated prematurely, the returned list will be empty.

By default the Sketch will be the currently running Sketch, as returned by get_current_sketch(). Use the sketch parameter to specify a different running Sketch, such as a Sketch created using Class mode.

If your Sketch has a post_draw() method, use the hook_post_draw parameter to make this function run after post_draw() instead of draw(). This is important when using Processing libraries that support post_draw() such as Camera3D or ColorBlindness.

Signatures

capture_frames(
    count: float,  # number of Sketch snapshots to capture
    *,
    period: float = 0.0,  # time in seconds between Sketch snapshots (default 0 means no delay)
    sketch: Sketch = None,  # running Sketch
    hook_post_draw: bool = False,  # attach hook to Sketch's post_draw method instead of draw
    block: bool = False  # method returns immediately (False) or blocks until function returns (True)
) -> list[PIL.Image]

Updated on March 06, 2023 02:49:26am UTC