Rendering

Rendering#

pyenki.viewer.render(world: World, /, walls_height: SupportsFloat = 10, width: SupportsInt = 640, height: SupportsInt = 360, selected_object: PhysicalObject | None = None, **camera_config: Unpack[CameraConfig]) → Image#

Renders a world to an RGB image array.

Parameters:

  • world (World) – the world to render.

  • walls_height (float) – the height of the world boundary in cm.

  • width (int) – the width of the image in pixels.

  • height (int) – the height of the image in pixels.

  • selected_object (PhysicalObject | None) – an optional object to select.

  • **camera_config (CameraConfig) – the camera configuration.

Returns:

An array of shape (height, width, 3) and type uint8.

Return type:

Image

pyenki.viewer.save_image(world: World, path: str, /, walls_height: SupportsFloat = 10, width: SupportsInt = 640, height: SupportsInt = 360, selected_object: PhysicalObject | None = None, **camera_config: Unpack[CameraConfig]) → None#

Renders a world to an image file.

Parameters:

  • world (World) – the world to render.

  • path (str) – the file path.

  • walls_height (float) – the height of the world boundary in cm.

  • width (int) – the width of the image in pixels.

  • height (int) – the height of the image in pixels.

  • selected_object (PhysicalObject | None) – an optional object to select.

  • **camera_config (CameraConfig) – the camera configuration.

Contents