Using Vantage via App SDK

These guidelines are for users of the App SDK who want to use it render a scene with Chaos Vantage. We will not discuss details on how to write code with the App SDK here - there are separate docs and examples for this included in the SDK package. Rather we will cover how you can add a few lines into existing code t...

Last updated 27 March 2026

0. Who this is for

Note: This document will be updated and extended over time.

1. How to set up a Live link

1.1. The steps

Here are the few simple steps how to set up a Live link between App SDK and Vantage:

Make sure you meet the system requirements for Vantage.
Make sure you use the latest version of App SDK.
Start Vantage and leave it in idle.
Set up the code for Distributed Rendering. In short the steps are:
1. Disable the VFB globally because Vantage doesn't send back images to VFB and its window would remain black.
2. Create an instance of VRayRenderer.
3. Set the inProcess flag (variations in naming in the different language bindings) to exclude the local machine from rendering. This prevents V-Ray from rendering and thus allowing Vantage to use all resources.
4. Explicitly enable DR.
5. Load the scene.
6. Add the remote host for distributed rendering (localhost or the IP of the computer where Vantage is running) with port 20701. If the port number is omitted it defaults to 20207.
7. Start rendering in interactive mode.
Make changes and Vantage will update accordingly.

To see if Vantage has established a successful live link, check if the label in the lower right corner of the viewport displays [LIVE LINK]:

1.2. Code examples

Here is some sample code with our basic interactive example included in the SDK package rewritten using the steps described above. You can also view our new example added in the interactive examples included in the SDK package:

Python

<code data-v-c2b1f83f=""># Import vray module and set the SCENE_PATH environment variable.# ... # Disable the VFB globally because Vantage doesn't send back images to VFB and its window would remain black.# If we only set the RenderOptions flag enableFrameBuffer to be False it will hide the VFB# but the libs associated with it will be loaded anyway.vray.enableFrameBuffer(False) # Create an instance of VRayRenderer with default options.# The renderer is automatically closed after the `with` block.with vray.VRayRenderer() as renderer: # Set the inProcess flag to exclude the local machine from rendering. # This prevents V-Ray from rendering and thus allowing Vantage to use all resources. renderer.inProcess = False # Register a simple log callback. Always useful for debugging. # ... # We have to explicitly enable DR first. renderer.setDREnabled(True) # Load scene from a file. renderer.load(os.path.join(SCENE_PATH, 'intro.vrscene')) # Add remote host for distributed rendering. # If port is omitted it defaults to 20207. # NOTE: Replace this address with the address of a host running # Vantage. renderer.addHosts('127.0.0.1:20701') # Start rendering. renderer.startSync() # Wait for rendering to end. renderer.waitForRenderEnd()</code>

C++

<code data-v-c2b1f83f="">// Include VRay headers and set the SCENE_PATH environment variable.// ... // Load V-Ray SDK library.// The directory containing the vray shared object should be present in// the PATH environment variable.// Disable the VFB globally because Vantage doesn't send back images to VFB and its window would remain black.// If we only set the RendererOptions flag enableFrameBuffer to be false it will hide the VFB// but the libs associated with it will be loaded anyway.VRayInit init(NULL, false); // Create an instance of VRayRenderer with default options.// The renderer is automatically closed at the end of the current scope.VRayRenderer renderer; // Set the inProcess flag to exclude the local machine from rendering.// This prevents V-Ray from rendering and thus allowing Vantage to use all resources.renderer.inProcess = false; // It's recommended to always have a console logrenderer.setOnLogMessage(logMessage); // We have to explicitly enable DR first.renderer.setDREnabled(true); // Load scene from a file.renderer.load("intro.vrscene"); // Add remote host for distributed rendering.// If port is omitted it defaults to 20207.// NOTE: Replace this address with the address of a host running// Vantage.renderer.addHosts("127.0.0.1:20701"); // Start rendering.renderer.startSync(); // Wait for rendering to end.renderer.waitForRenderEnd();</code>

C#.Net

<code data-v-c2b1f83f="">// Use VRay related namespaces and set the SCENE_PATH environment variable.// ... // Disable the VFB globally because Vantage doesn't send back images to VFB and its window would remain black.// If we only set the RendererOptions flag IsFrameBufferEnabled to be false it will hide the VFB// but the libs associated with it will be loaded anyway.VFB.Enable(false);// Create an instance of VRayRenderer with default options.// The renderer is automatically closed after the `using` block.using (VRayRenderer renderer = new VRayRenderer()){ // Set the InProcess flag to exclude the local machine from rendering. // This prevents V-Ray from rendering and thus allowing Vantage to use all resources. renderer.InProcess = false; // Add a listener for any type of log message. // ... // We have to explicitly enable DR first. renderer.SetDREnabled(true); // Load scene from a file. renderer.Load("intro.vrscene"); // Add remote host for distributed rendering. // If port is omitted it defaults to 20207. // NOTE: Replace this address with the address of a host running // Vantage. renderer.AddHosts("127.0.0.1:20701"); // Start rendering. renderer.StartSync(); // Wait for rendering to end. renderer.WaitForRenderEnd();}</code>

Node.js

<code data-v-c2b1f83f="">// Import vray module and set the SCENE_PATH environment variable.// ... // Disable the VFB globally because Vantage doesn't send back images to VFB and its window would remain black.// If we only set the RendererOptions flag enableFrameBuffer to be false it will hide the VFB// but the libs associated with it will be loaded anyway.vray.enableFrameBuffer(false); // Create an instance of VRayRenderer with default options.var renderer = vray.VRayRenderer();// Set the inProcess flag to exclude the local machine from rendering.// This prevents V-Ray from rendering and thus allowing Vantage to use all resources.renderer.inProcess = false;// It's recommended to always have a console log callback.// ...// We have to explicitly enable DR first.renderer.setDREnabled(true);// Load scene from a file asynchronously.renderer.load('intro.vrscene', function(err) { if (err) { // Scene was not loaded. throw err; } // Add remote host for distributed rendering. // If port is omitted it defaults to 20207. // NOTE: Replace this address with the address of a host running // Vantage. renderer.addHosts('127.0.0.1:20701'); // Start rendering. renderer.start(function(err) { if (err) { // Couldn't start rendering. throw err; } // Wait for rendering to end. renderer.waitForRenderEnd(function() { // Closes the renderer. // The renderer object is unusable after closing since its resources // are freed. It should be released for garbage collection. renderer.close(); }); });});</code>

0. Who this is for

1. How to set up a Live link

1.1. The steps

1.2. Code examples

Python

C++

C#.Net

Node.js

Related articles

API Reference Guides

Chaos License Quick Start Guide

Getting Started with App SDK

License Agreements and Copyrights

Release Notes