API reference

SpatialSession

Owns a Spatial plugin registration for C++ and PySide6 application scopes.

explicit SpatialSession(QObject* host = nullptr, QObject* parent = nullptr)

bool activate(QString* error = nullptr): Activates the registered Spatial plugin; repeated calls are no-ops.
bool deactivate(QString* error = nullptr): Suspends tracked views and releases particle delegation without deleting outputs.
bool isActive() const
SpatialView* createView(QWidget* parent = nullptr): Creates a caller-owned view with the requested parent while active.
bool attachView(SpatialView* view): Tracks an existing caller-owned view, including custom subclasses.
ParticleLayer* createParticleLayer(particles::ParticleBackdrop* backdrop, QObject* parent = nullptr): Creates a caller-owned adapter for a borrowed particle source while active.
bool prepareWindow(windowing::Window* window): Prepares a hidden window without a GPU context; false while inactive.
bool prepareWindow(windowing::Window* window, QSurface::SurfaceType surfaceType)

All inherited Qt members：QObject