Add a note about get_pixels() on the documetation for the Py5Graphics & Py5Image copy() methods

[villares]

I've known for a long time that if you call get_pixels() with the position and dimensions of a rectangle it will return a Py5Image with that region's content. But somehow I keep forgetting it and doing convoluted stuff, like creating a new image and using the copy() method... I wonder if we could help people who want to grab a part of a bigger image to be reminded of the simpler option (that is, using get_pixels()) by adding a link to the other method's pages...

• https://py5coding.org/reference/py5image_copy.html (add a reference here to...)
• https://py5coding.org/reference/py5image_get_pixels.html (...this page which has a great example)
• https://py5coding.org/reference/py5graphics_copy.html
• https://py5coding.org/reference/py5graphics_get_pixels.html

[hx2A]

I forget about this also, and will use np_pixels instead.

I'm up for improving the documentation, but what should the two get_pixels() pages say that they don't already say about this already?

[villares]

Oh, the change is to the copy() pages, not to the get_pixel() pages...
Could we have something similar to this? Too much?

For the sketch.copy() page:

If you want to create a new image with the contents of a rectangular region of the screen, check out get_pixels(x, y, w, h) where x, y, w, h, are the position and dimensions of the area to be copied. It will return a Py5Image object.

For the Py5Graphics.copy() page:

If you want to create a new image with the contents of a rectangular region of a Py5Graphics object, check out the .get_pixels(x, y, w, h) method, where x, y, w, h, are the position and dimensions of the area to be copied. It will return a Py5Image object.

For the Py5Image.copy() page:

If you want to create a new image with the contents of a rectangular region of a Py5Image object you can use the .get_pixels(x, y, w, h) method, where x, y, w, h, are the position and dimensions of the area to be copied. It will return a Py5Image object.

Writing this made me look out for other "related entries" notes in the reference, and I noticed that at Processing.org we have this "related" section that is maybe missing on our documentation?

https://processing.org/reference/mousePressed.html

https://py5coding.org/reference/sketch_is_mouse_pressed.html

[hx2A]

That text works. Would you like to make a PR for this?

Good point about "related entries". Other libraries such as numpy have this also. Technically this would not be difficult to implement but it would take time to decide what is related to what. Perhaps we can do this programmatically and then make refinements manually?

[villares]

Cool, I think would like to do it!

We should take the time to plan the "related entries" thing!

Do you think we could/should programmatically tap into the "related" selection from the Processing reference?

Would you like to have a CSV with the relations? I was thinking about strategies for building one an then we could refine/edit it...

How are you thinking about the page/rendering implementation?

[hx2A]

Do you think we could/should programmatically tap into the "related" selection from the Processing reference?

Oh, yes, excellent idea. I didn't think of that. We can get that information programmatically. Also, for each py5 documentation page we can scan the descriptions for links to other pages. Those should be included automatically.

If we did the above two things, we'd be at least 80% of the way there.

[villares]

Also, for each py5 documentation page we can scan the descriptions for links to other pages. Those should be included automatically.

yeah, I was thinking about that too!

[villares]

I'm going to close this. We could create an issue about the "related entries" later.