👀 p5.grain.readonly (v0.6.0)

[meezwhite]

This (small) version release adds the shouldUpdate argument to tinkerPixels to make it possible to loop through pixels in read-only mode where updatePixels() is skipped.

Read-only mode example

In the following example, we loop through the pixels of the main canvas and determine the min, max average pixel values. Since pixel-manipulation is not necessary for this, we pass false to the shouldUpdate argument, which will internally skip updatePixels().

let minAvg = 255;
let maxAvg = 0;
tinkerPixels((index, total) => {
    // determine min, max average pixel values
    const avg = round((pixels[index] + pixels[index+1] + pixels[index+2])/3);
    minAvg = min(minAvg, avg);
    maxAvg = max(maxAvg, avg);
}, false); // <-- shouldUpdate = false

Low impact breaking change

Unless you are explicitly using the alternative syntax for graphics buffers tinkerPixels(callback, pg) instead of pg.tinkerPixels(callback), you don't need to worry about breaking changes.

Old (alternative) syntax for graphics buffers:

tinkerPixels((index, total) => {
    // ...
}, pg);

New (alternative) syntax for graphics buffers:

tinkerPixels((index, total) => {
    // ...
}, true, pg); // <-- shouldUpdate = true

However, we recommend using the common syntax for graphics buffers if possible:

// will execute updatePixels()
pg.tinkerPixels((index, total) => {
    // ...
});

// will skip updatePixels()
pg.tinkerPixels((index, total) => {
    // ...
}, false); // <-- shouldUpdate = false

Roadmap

You can check out the rough Roadmap here and you're welcome to collaborate on p5.grain. 🫶

Have fun creating! ✨

This update enabled further implementation of custom pixel-manipulation functions, where read-only looping through pixels is needed.

Have fun looping through your pixels with tinkerPixels in read-only mode!

---

This discussion was created from the release v0.6.0.