index.rst

Welcome to XRFeitoria's documentation!

XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations. It is a part of the OpenXRLab project.

---

Major Features

• Support rendering photorealistic images with ground-truth annotations.
• Support multiple engine backends, including Unreal Engine and Blender.
• Support assets/camera management, including import, export, and delete.
• Support a CLI tool to render images from a mesh file.

---

Installation

pip install xrfeitoria

# to use visualization tools
pip install xrfeitoria[vis]

Requirements

• Python >= 3.8

• (optional) Unreal Engine >= 5.1

  Windows

• (optional) Blender >= 3.0

  Windows

  Linux

  MacOS

---

src/cli.md src/Tutorials.rst Samples <https://github.com/openxrlab/xrfeitoria/tree/main/samples>

---

apis/xrfeitoria.rst apis/factory.rst apis/object.rst apis/actor.rst apis/camera.rst apis/sequence.rst apis/renderer.rst apis/utils.rst apis/data_structure.rst

---

src/blender-addon.md src/unreal-plugin.md

---

faq.rst