NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Iray Bridge

The Iray Bridge enables an application to use remote servers to render scenes in a very efficient way requiring minimal changes to the application. More...

Classes

class   mi::neuraylib::IRemote_ready_callback
  Callback interface to report completion of remote asynchronous operations. More...
 
class   mi::neuraylib::IRemote_properties
  The remote cluster properties handler interface. More...
 
class   mi::neuraylib::IRemote_client
  The client of the Iray Bridge. More...
 
class   mi::neuraylib::IRemote_server
  The server of the Iray Bridge. More...
 

Detailed Description

The Iray Bridge enables an application to use remote servers to render scenes in a very efficient way requiring minimal changes to the application.

The Iray Bridge allows pushing a local Iray database to a remote server over a relatively low bandwidth, high latency connection. It uses caching and automatic change detection to efficiently only transmit things not already on the remote server. Caching is done both in memory and on disk. Thus even when switching between scenes or restarting client or server, the cached data on the server is still available. Only mimimal data is pushed when rendering a scene which was rendered before on that server and is still cached.

When loading the plugin cloud_render, a new "iray_cloud" render mode is available. When using that render mode, all necessary database changes are automatically transmitted and the images are rendered on the remote server without requiring local resources. Rendered images are automatically transmitted back and delivered to the render target as when using any other local render mode. Before using the cloud render mode, make sure the configured remote server addres is correct since the plugin automatically tries to establish a connection to the configured server when the render method is called.

The plugin cb_importer is used to import cb-files containing a snapshot of a scene. To create cb-files call mi::neuraylib::IRemote_client::create_remote_snapshot.

Use mi::neuraylib::IRemote_configuration to configure the Iray Bridge. Use mi::neuraylib::IRemote_client and mi::neuraylib::IRemote_server interfaces for interaction with the Iray Bridge.

Note
The disk cache may only be used by one Iray instance at a time.
The disk cache files can be removed while running if no clients are connected. This is useful for example when they get too big.