Rendering Engine

This module generates a self-contained browser dashboard for batched rollout stats, labeled rollout traces, and real-time trajectory playback.

class f1tenth_gym_jax.envs.rendering.renderer.WebRenderer(env, render_fps=None, window_width=1200, window_height=760, render_mode='html', output_path=PosixPath('f1tenth_gym_jax_rollout.html'), open_browser=False, trajectory_layout='step_major')

Bases: object

Generate a self-contained browser dashboard for F110 rollout playback.

Parameters:

  • env (F110Env)

  • render_fps (Optional[float])

  • window_width (int)

  • window_height (int)

  • render_mode (str)

  • output_path (pathlib.Path | str)

  • open_browser (bool)

  • trajectory_layout (TrajectoryLayout)

play_pause()

Toggle the default playback state stored in generated dashboards.

Return type:

None

render(trajectory, output_path=None, *, title=None, metadata=None, artifacts=None)

Write a standalone HTML dashboard for a rollout or batched rollouts.

Parameters:

  • trajectory (ndarray) – Rollout states to visualize.

  • output_path (Path | str | None) – Destination HTML path. Uses the renderer default when omitted.

  • title (str | None) – Optional dashboard title.

  • metadata (dict[str, Any] | None) – Optional JSON-serializable metadata included in the payload.

  • artifacts (dict[str, Any] | None) – Optional overlay payload with an overlays list. Supported overlay types are paths and sample_paths.

Return type:

Path

close()

No-op compatibility hook for the former desktop renderer API.

Return type:

None

f1tenth_gym_jax.envs.rendering.renderer.TrajRenderer

alias of WebRenderer