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

  Linux

• (optional) Blender >= 3.0

  Windows

  Linux

  MacOS

---

Beginner's Guide

• CLI
• Tutorials
• Samples

---

API Reference

• xrfeitoria
• xrfeitoria.factory
• xrfeitoria.object
• xrfeitoria.actor
• xrfeitoria.camera
• xrfeitoria.sequence
• xrfeitoria.renderer
• xrfeitoria.utils
• xrfeitoria.data_structure

---

Plugins

• XRFeitoria Blender Addon
• XRFeitoria Unreal Plugin

---

FAQ

• Frequently Asked Questions
  • API