Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/source/api/axes/Axes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _api.Axes:

Axes
****

====
Axes
====
.. currentmodule:: fastplotlib.axes

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: Axes_api

Axes

Properties
~~~~~~~~~~
.. autosummary::
:toctree: Axes_api

Axes.auto_grid
Axes.basis
Axes.color
Axes.colors
Axes.grids
Axes.intersection
Axes.offset
Axes.visible
Axes.world_object
Axes.x
Axes.y
Axes.z

Methods
~~~~~~~
.. autosummary::
:toctree: Axes_api

Axes.update
Axes.update_using_bbox
Axes.update_using_camera

66 changes: 66 additions & 0 deletions docs/source/api/axes/Grid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _api.Grid:

Grid
****

====
Grid
====
.. currentmodule:: fastplotlib.axes

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: Grid_api

Grid

Properties
~~~~~~~~~~
.. autosummary::
:toctree: Grid_api

Grid.axis_color
Grid.axis_thickness
Grid.cast_shadow
Grid.children
Grid.geometry
Grid.id
Grid.infinite
Grid.major_color
Grid.major_step
Grid.major_thickness
Grid.material
Grid.minor_color
Grid.minor_step
Grid.minor_thickness
Grid.parent
Grid.receive_shadow
Grid.render_mask
Grid.render_order
Grid.thickness_space
Grid.up
Grid.visible

Methods
~~~~~~~
.. autosummary::
:toctree: Grid_api

Grid.add
Grid.add_event_handler
Grid.clear
Grid.get_bounding_box
Grid.get_bounding_sphere
Grid.get_geometry_bounding_box
Grid.get_world_bounding_box
Grid.get_world_bounding_sphere
Grid.handle_event
Grid.iter
Grid.look_at
Grid.release_pointer_capture
Grid.remove
Grid.remove_event_handler
Grid.set_pointer_capture
Grid.traverse

59 changes: 59 additions & 0 deletions docs/source/api/axes/Grids.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. _api.Grids:

Grids
*****

=====
Grids
=====
.. currentmodule:: fastplotlib.axes

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: Grids_api

Grids

Properties
~~~~~~~~~~
.. autosummary::
:toctree: Grids_api

Grids.cast_shadow
Grids.children
Grids.geometry
Grids.id
Grids.material
Grids.parent
Grids.receive_shadow
Grids.render_mask
Grids.render_order
Grids.up
Grids.visible
Grids.xy
Grids.xz
Grids.yz

Methods
~~~~~~~
.. autosummary::
:toctree: Grids_api

Grids.add
Grids.add_event_handler
Grids.clear
Grids.get_bounding_box
Grids.get_bounding_sphere
Grids.get_geometry_bounding_box
Grids.get_world_bounding_box
Grids.get_world_bounding_sphere
Grids.handle_event
Grids.iter
Grids.look_at
Grids.release_pointer_capture
Grids.remove
Grids.remove_event_handler
Grids.set_pointer_capture
Grids.traverse

74 changes: 74 additions & 0 deletions docs/source/api/axes/Ruler.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
.. _api.Ruler:

Ruler
*****

=====
Ruler
=====
.. currentmodule:: fastplotlib.axes

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: Ruler_api

Ruler

Properties
~~~~~~~~~~
.. autosummary::
:toctree: Ruler_api

Ruler.cast_shadow
Ruler.children
Ruler.color
Ruler.end_pos
Ruler.end_value
Ruler.geometry
Ruler.id
Ruler.label
Ruler.line
Ruler.line_width
Ruler.material
Ruler.min_tick_distance
Ruler.parent
Ruler.points
Ruler.receive_shadow
Ruler.render_mask
Ruler.render_order
Ruler.start_pos
Ruler.start_value
Ruler.text
Ruler.tick_format
Ruler.tick_marker
Ruler.tick_side
Ruler.tick_size
Ruler.ticks
Ruler.ticks_at_end_points
Ruler.up
Ruler.visible

Methods
~~~~~~~
.. autosummary::
:toctree: Ruler_api

Ruler.add
Ruler.add_event_handler
Ruler.clear
Ruler.get_bounding_box
Ruler.get_bounding_sphere
Ruler.get_geometry_bounding_box
Ruler.get_world_bounding_box
Ruler.get_world_bounding_sphere
Ruler.handle_event
Ruler.iter
Ruler.look_at
Ruler.release_pointer_capture
Ruler.remove
Ruler.remove_event_handler
Ruler.set_pointer_capture
Ruler.traverse
Ruler.update

10 changes: 10 additions & 0 deletions docs/source/api/axes/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Axes
****

.. toctree::
:maxdepth: 1

Grid
Grids
Ruler
Axes
3 changes: 3 additions & 0 deletions docs/source/api/graphic_features/TextureArray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ Properties

TextureArray.buffer
TextureArray.col_indices
TextureArray.colorspace
TextureArray.cpu_buffer
TextureArray.row_indices
TextureArray.shape
TextureArray.value

Methods
Expand Down
39 changes: 39 additions & 0 deletions docs/source/api/graphic_features/TextureYUV.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _api.TextureYUV:

TextureYUV
**********

==========
TextureYUV
==========
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: TextureYUV_api

TextureYUV

Properties
~~~~~~~~~~
.. autosummary::
:toctree: TextureYUV_api

TextureYUV.colorrange
TextureYUV.colorspace
TextureYUV.cpu_buffer
TextureYUV.texture
TextureYUV.value

Methods
~~~~~~~
.. autosummary::
:toctree: TextureYUV_api

TextureYUV.add_event_handler
TextureYUV.block_events
TextureYUV.clear_event_handlers
TextureYUV.remove_event_handler
TextureYUV.set_value

2 changes: 2 additions & 0 deletions docs/source/api/graphic_features/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Graphic Features
VertexPointSizes
UniformSize
TextureArray
TextureYUV
tuple
ImageCmap
ImageVmin
ImageVmax
Expand Down
31 changes: 31 additions & 0 deletions docs/source/api/graphic_features/tuple.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _api.tuple:

tuple
*****

=====
tuple
=====
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: tuple_api

tuple

Properties
~~~~~~~~~~
.. autosummary::
:toctree: tuple_api


Methods
~~~~~~~
.. autosummary::
:toctree: tuple_api

tuple.count
tuple.index

1 change: 1 addition & 0 deletions docs/source/api/graphics/Graphic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Properties
Graphic.alpha_mode
Graphic.axes
Graphic.block_events
Graphic.block_handlers
Graphic.deleted
Graphic.event_handlers
Graphic.name
Expand Down
3 changes: 3 additions & 0 deletions docs/source/api/graphics/ImageGraphic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ Properties
ImageGraphic.alpha_mode
ImageGraphic.axes
ImageGraphic.block_events
ImageGraphic.block_handlers
ImageGraphic.cmap
ImageGraphic.cmap_interpolation
ImageGraphic.colorspace
ImageGraphic.cpu_buffer
ImageGraphic.data
ImageGraphic.deleted
ImageGraphic.event_handlers
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/graphics/ImageVolumeGraphic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Properties
ImageVolumeGraphic.alpha_mode
ImageVolumeGraphic.axes
ImageVolumeGraphic.block_events
ImageVolumeGraphic.block_handlers
ImageVolumeGraphic.cmap
ImageVolumeGraphic.cmap_interpolation
ImageVolumeGraphic.data
Expand Down
Loading