GeezerVison is showing github.com — fix typos (#991) · fastplotlib/fastplotlib@0d754f5
File treeExpand file treeCollapse file tree Open diff view settings Expand file treeCollapse file tree Open diff view settings Collapse file Copy file name to clipboardExpand all lines: docs/source/conf.py +1Lines changed: 1 addition & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
| 134 | 134 | "numpy": ("https://numpy.org/doc/stable", None), | 135 | 135 | "pygfx": ("https://docs.pygfx.org/stable", None), | 136 | 136 | "wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None), | | 137 | + "rendercanvas": ("https://rendercanvas.readthedocs.io/stable/", None), | 137 | 138 | # "fastplotlib": ("https://www.fastplotlib.org/", None), | 138 | 139 | } |
Collapse file Copy file name to clipboardExpand all lines: docs/source/developer_notes/graphics.rst +5-6Lines changed: 5 additions & 6 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -56,15 +56,14 @@ For example let's look at ``LineGraphic`` in ``fastplotlib/graphics/line.py``. E | 56 | 56 | ``"data", "colors", "cmap", "thickness"`` in addition to properties common to all graphics, such as ``"name", "offset", "rotation", and "visible"`` | 57 | 57 |
| 58 | 58 | Now look at the constructor for the ``LineGraphic`` base class ``PositionsGraphic``, it first creates an instance of ``VertexPositions``. | 59 | | -This is a class that manages vertex positions buffer. For the user, it defines the line data, and provides additional useful functionality. | 60 | | -It defines the line, and provides additional useful functionality. | | 59 | +This is a class that manages vertex positions buffer. For the user, it defines the line vertex positions, and provides additional useful functionality. | 61 | 60 | For example, every time that the ``data`` is changed, the new data will be marked for upload to the GPU before the next draw. | 62 | 61 | In addition, event handlers will be called if any event handlers are registered. | 63 | 62 |
| 64 | | -``VertexColors`` behaves similarly, but it can perform additional parsing that can create the colors buffer from different | | 63 | +``VertexColors`` behaves similarly, but it can perform additional parsing that can create or set the colors buffer from different | 65 | 64 | forms of user input. For example if a user runs: ``line_graphic.colors = "blue"``, then ``VertexColors.__setitem__()`` will | 66 | | -create a buffer that corresponds to what ``pygfx.Color`` thinks is "blue". Users can also take advantage of fancy indexing, | 67 | | -ex: ``line_graphics.colors[bool_array] = "red"`` 😊 | | 65 | +set the buffer that corresponds to what ``pygfx.Color`` thinks is "blue", i.e the RGBA array `[0, 0, 1, 1]. Users can also take advantage of fancy indexing, | | 66 | +ex: ``line_graphics.colors[bool_array] = "red"`` 😊 to set the color of specific vertices. | 68 | 67 |
| 69 | 68 | ``LineGraphic`` also has a ``VertexCmap``, this manages the line ``VertexColors`` instance to parse colormaps, for example: | 70 | 69 | ``line_graphic.cmap = "jet"`` or even ``line_graphic.cmap[50:] = "viridis"``. | @@ -73,4 +72,4 @@ ex: ``line_graphics.colors[bool_array] = "red"`` 😊 | 73 | 72 | callbacks to indicate that the graphic has been deleted (for example, removing references to a graphic from a legend). | 74 | 73 |
| 75 | 74 | Other graphics have properties that are relevant to them, for example ``ImageGraphic`` has ``cmap``, ``vmin``, ``vmax``, | 76 | | -properties unique to images. | | 75 | +properties unique to images. |
|