RendererBlender

Inheritance diagram of RendererBlender

Inheritance diagram

class xrfeitoria.renderer.renderer_blender.RendererBlender[source]

Renderer class for Blender.

classmethod add_job(sequence_name: str, output_path: str | Path, resolution: Tuple[int, int], render_passes: List[RenderPass], render_engine: RenderEngineEnumBlender | Literal['cycles', 'eevee', 'workbench'] = 'cycles', render_samples: int = 128, transparent_background: bool = False, arrange_file_structure: bool = True) → None[source]

Add a rendering job with specific settings.

Parameters:

  • output_path (PathLike) – Output path of the rendered images.

  • resolution (Tuple[int, int]) – Resolution of the rendered images.

  • render_passes (List[RenderPass]) – Render passes.

  • scene_name (str, optional) – Name of the scene be rendered. Defaults to ‘XRFeitoria’.

  • render_engine (Union[RenderEngineEnumBlender, Literal['cycles', 'eevee', 'workbench']], optional) – Render engine. Defaults to cycles.

  • render_samples (int, optional) – Render samples. Defaults to 128.

  • transparent_background (bool, optional) – Transparent background. Defaults to False.

  • arrange_file_structure (bool, optional) – Arrange output images to every camera’s folder. Defaults to True.

classmethod clear()

Clear all rendering jobs in the renderer queue.

classmethod render_jobs(use_gpu: bool = True, disable_spinner: bool = False, log_interval: int = 10) → None[source]

Render all jobs in the render queue, and this method will clear the render queue after rendering.

Parameters:

  • use_gpu (bool, optional) – Use GPU to render. Defaults to True.

  • disable_spinner (bool, optional) – If True, the spinner will be disabled. Defaults to environment variable XRFEITORIA__DISABLE_SPINNER or False. The Spinner is a progress bar to show the rendering progress in the console. If you are using a container, you may want to set this to True. You can also set this via environment variable XRFEITORIA__DISABLE_SPINNER=true.

  • log_interval (int, optional) – Log progress every N frames. Defaults to environment variable XRFEITORIA__LOG_INTERVAL or 10. You can also set this via environment variable XRFEITORIA__LOG_INTERVAL=20.