pygfx.objects.Image¶

class pygfx.objects.Image(geometry=None, material=None, *, visible=True, render_order=0, render_mask='auto')¶

Bases: WorldObject

A 2D image.

The geometry for this object consists only of geometry.grid: a texture with the 2D data.

If no colormap is applied to the material, the data are interpreted as colors in sRGB space. To use physical space instead, set the texture’s colorspace property to "physical".

The picking info of an Image (the result of renderer.get_pick_info()) will for most materials include index (tuple of 2 int), and pixel_coord (tuple of float subpixel coordinates).

Parameters:

geometry (Geometry) – The data defining the shape of the object.
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).