pygfx.objects.Points

class pygfx.objects.Points(geometry: Geometry | None = None, material: Material | None = None, *, visible: bool = True, render_order: float = 0, render_mask: str | int = 'auto', name: str = '')

Bases: WorldObject

A point cloud.

An object consisting of points represented by vertices (3D positions).

The picking info of a Points object (the result of renderer.get_pick_info()) will for most materials include vertex_index (int) and point_coord (tuple of 2 float coordinates in logical pixels).

Parameters:

geometry (Geometry) – The data defining the shape of the object. Must contain at least a “positions” buffer. Depending on the usage of the material, can also include buffers “texcoords”, “colors”, “sizes”, “edge_colors”, “rotations”.
material (Material) – The data defining the appearance of the object.
visible (bool) – Whether the object is visible.
render_order (int) – The render order (when applicable for the renderer’s blend mode).
render_mask (str) – Determines the render passes that the object is rendered in. It’s recommended to let the renderer decide, using “auto”.
position (Vector) – The position of the object in the world. Default (0, 0, 0).