Render-Automatisierung mit dem V-Ray App SDK: 6 Schritte von der Szene bis zum Output

Das V-Ray App SDK bietet eine API, mit der sich die V-Ray-Engine innerhalb einer Anwendung oder in einem separaten Prozess zum Rendern verwenden und steuern lässt. Laut der offiziellen Dokumentation von Chaos kann die Szene dabei mithilfe von V-Ray-Plugins im Speicher erstellt oder aus einer .vrscene-Datei geladen werden. Dieser Leitfaden erläutert den grundlegenden Renderzyklus des App SDK und zeigt, welcher Render-Modus sich für die verschiedenen Phasen der Szenenarbeit eignet. Da in der Dokumentation keine gültige Softwareversion für das App SDK angegeben ist, orientiert sich die Beschreibung am dort dargestellten allgemeinen Workflow.

1. Umgebung vorbereiten

1. Speicherort der App-SDK-Dateien festlegen. Laut Dokumentation muss die Umgebungsvariable VRAY_SDK definiert sein, damit das SDK verwendet werden kann. Bei Verwendung der Python-Bindings muss der Ordner python zu den Python-Modulsuchpfaden hinzugefügt werden; die Dokumentation zeigt dies anhand von PYTHONPATH. So kann die Anwendung die SDK-Komponenten finden.

2. Das vorbereitete Umgebungs-Skript ausführen oder eine Alternative wählen. Für Windows zeigt die Dokumentation die Verwendung von setenv.bat, für Linux und macOS den Befehl source setenv.sh. Diese Skripte setzen die entsprechenden Umgebungsvariablen. Liegen die SDK-Binärdateien nicht in der /bin-Ordnerstruktur des Produkts, kann laut Dokumentation die Variable VRAY_APPSDK_BIN verwendet werden. Wenn keine Umgebungsvariablen genutzt werden können, lässt sich der Suchpfad auch über die API festlegen.

In diesem Schritt sollte geprüft werden, ob die Ordnerstruktur auf dem Computer mit dem Speicherort übereinstimmt, an dem die Anwendung nach der SDK-Bibliothek sucht. Die Dokumentation listet weder eine bestimmte Betriebssystemkonfiguration noch Hardwareanforderungen auf. Für Einzelheiten zur Einrichtung ist daher die API-Dokumentation der jeweils verwendeten Bindings maßgeblich.

2. Szene erstellen oder laden

1. Den Render-Controller initialisieren. Die Klasse VRayRenderer im App SDK startet und steuert den Renderprozess. Die Szene kann im Speicher aufgebaut werden, indem V-Ray-Plugin-Objekte erstellt und deren Parameter eingestellt werden. Alternativ lässt sich eine .vrscene-Datei laden, das Szenenformat von V-Ray. Laut Dokumentation können beide Methoden auch kombiniert werden.

Welche Methode zur Szenenerstellung passt, hängt von der vorhandenen Produktionspipeline ab. Eine Anwendung kann beispielsweise eigene Szenendaten in V-Ray-Plugins umwandeln oder eine zuvor exportierte .vrscene-Datei öffnen. Das App SDK zwingt nicht zur Verwendung einer bestimmten Modellierungssoftware, sondern ermöglicht eine solche Integration mit der V-Ray-Render-Engine.

1. Nach dem Vorbereiten der Szene den Render-Modus wählen. Die Dokumentation beschreibt zwei grundlegende Optionen:

Beide Modi unterstützen CPU- und GPU-Rendering. Laut Dokumentation sind CUDA und OptiX für NVIDIA sowie Metal und MetalRT ausschließlich für Apple verfügbar. Der Render-Typ wird über die Eigenschaft renderMode des VRayRenderer-Objekts ausgewählt. Als Standardmodus der Klasse nennt die Dokumentation Interactive (CPU). Der passende Modus sollte daher abhängig vom Einsatzzweck der Anwendung und der verfügbaren Systemunterstützung ausdrücklich festgelegt werden.

3. Render starten und Ergebnis abrufen

1. Den Renderprozess starten. Die Methode start() führt den Renderprozess in einem separaten Thread aus und kehrt zurück, ohne auf dessen Abschluss zu warten. So kann die Anwendung während des Renderns andere Aufgaben erledigen oder bereitstehen, um ein Fortschrittsbild abzurufen. Das Python-Beispiel in der Dokumentation lädt eine Szene, startet den Render, wartet auf dessen Ende und speichert das resultierende Bild als PNG:

import vray

with vray.VRayRenderer() as renderer:
    renderer.load('./intro.vrscene')
    renderer.start()
    renderer.waitForRenderEnd(6000)
    image = renderer.getImage()
    image.save('intro.png')

Der Wert 6000 im Codebeispiel ist ein Beispielargument, das laut Dokumentation an waitForRenderEnd übergeben wird. Er wird nicht als empfohlene oder für jede Szene erforderliche Dauer angegeben. Das Warten sollte im Produktionscode entsprechend der Dokumentation der verwendeten API-Bindings umgesetzt werden.

1. Das Bild auch während des Renderns prüfen und Ressourcen schließen. Laut App-SDK-Dokumentation lassen sich Bilddaten bereits vor Abschluss des Renderns abrufen. Das kann besonders im Interactive-Modus hilfreich sein, um eine Vorschau in der Anwendungsoberfläche anzuzeigen oder den Prozess zu überwachen. Als abgeschlossen gilt das finale Bild laut Dokumentation, wenn der Renderer den Status IDLE_DONE erreicht. Nach Abschluss der Arbeit sollte der Renderer geschlossen werden; im Python-Beispiel übernimmt der with-Block diesen Lebenszyklus.

Die Dokumentation beschreibt außerdem, wie sich Ereignisse bei Statusänderungen des Renderprozesses, bei V-Ray-Meldungen sowie bei Aufgaben- und Fortschrittsmeldungen überwachen lassen. Solche Benachrichtigungen helfen einer Integration dabei, das Verhalten der Anwendung beim Laden, Rendern und Abschließen zu steuern. Die Callbacks werden jedoch in einem separaten Thread ausgeführt; langsamer Anwendungscode kann die Ausführung anderer Callbacks verzögern.

Was ändert sich für Architektur- und Archviz-Workflows?

Das App SDK ist für Teams interessant, die wiederkehrende Render-Schritte in eine Anwendung integrieren oder eine V-Ray-Szene aus einem anderen Prozess heraus steuern möchten. Architekturbüros und Archviz-Studios können den Interactive-Modus zum Testen von Szenen und Inhalten und den Production-Modus für die finale Bildausgabe nutzen. So lässt sich zwischen Vorschau und finalem Output über denselben Renderer wechseln.

Die Quellen enthalten allerdings weder eine Kompatibilitätsmatrix für bestimmte 3D-Programme noch Angaben zu Hardwareanforderungen, Lizenzbedingungen oder Preisen. Bei der Wahl zwischen CPU und GPU lassen sich daher nur die in der Dokumentation genannten Render-Optionen und die Plattformbeschränkungen der jeweiligen GPU-Technologien berücksichtigen; Rückschlüsse auf die Performance sind nicht möglich. Vor der Integration in eine Anwendung sollten die API-Dokumentation der verwendeten Sprach-Bindings und die Ordnerstruktur für die SDK-Bibliotheken geprüft werden.

Häufige Fehler

• Wird VRAY_SDK oder kein geeigneter alternativer Pfad gesetzt, bevor die SDK-Bindings initialisiert werden, können die Bibliotheken möglicherweise nicht gefunden werden.

• Der Aufruf von start() bedeutet nicht, dass der Render abgeschlossen ist. Die Dokumentation beschreibt die Methode als asynchronen Aufruf, der zurückkehrt, ohne zu warten.

• Änderungen an der Szene oder am Renderer während des Renderns im Status PREPARING können abgewiesen werden. Laut Dokumentation gilt dieser Hinweis, wenn statt startSync() die Methode start() verwendet wird.

• Langsame Callbacks für V-Ray-Ereignisse können die Ausführung anderer Callbacks verzögern. Daher sollte geprüft werden, welche Arbeit die Ereignis-Handler ausführen.

• Das Warteargument aus dem Beispielcode als feste Einstellung für jedes Projekt zu verwenden, geht über die Angaben in der Dokumentation hinaus.

Die Dokumentation erklärt nicht, wie bestimmte Render-Einstellungen in der Benutzeroberfläche auszuwählen sind, sondern vermittelt die Grundlagen für das Laden von Szenen und die Render-Steuerung über das App SDK. Für Details zu den Einstellungen innerhalb der Anwendung sollte die API-Referenz der jeweiligen Bindings herangezogen werden.