We provide several examples for the use of the Iray SDK API that illustrate -- in a tutorial manner -- the important interfaces and concepts.

See the Getting Started Section for a description of how the example programs can be compiled.

If your variant of the Iray library requires an authentication key you need to replace the file examples/authentication.h that only contains a dummy key with the file that contains a valid authentication key. Failure to supply a valid authentication key will cause mi::neuraylib::INeuray::start() to abort with error code -2.

Getting Started with the Iray SDK

Example for Starting and Shutting Down the Iray SDK API
Starts and shuts down the Iray SDK API.
Example for Configuration of the Iray SDK API
Configures the Iray SDK API.
Example for Rendering
Imports a scene file and renders its content.
Example for Progressive rendering
Renders a scene progressively.
Example for Networking modes
Starts the Iray SDK API in networking mode.
Example for Scene Creation
Programmatically creates a scene via the API.
Example for MDL
Demonstrates working with MDL materials and functions.
Example for Triangle meshes
Demonstrates working with geometry in the form of triangle meshes.
Example for Polygon meshes
Demonstrates working with geometry in the form of polygon meshes.
Example for Subdivision surfaces
Demonstrates working with geometry in the form of subdivision surfaces.
Example for Freeform surfaces
Demonstrates working with geometry in the form of freeform surfaces.
Example for On-demand meshes
Demonstrates working with geometry in the form of on-demand meshes.
Example for Fibers
Demonstrates creating and editing fibers.
Example for Particles
Demonstrates creating and editing particles.
Example for Volumes
Demonstrates creating and editing volumes.
Example for the HTTP server
Serves a rendered image via the HTTP server.
Example for the RTMP server
Demonstrates an interactive video streaming server.
Example for User-defined classes
Demonstrates writing of user-defined classes.
Example for Plugins
Provides additional functionality via plugins.
Example for Importers
Implements an importer for a custom file format.
Example for Exporters
Implements an exporter for a custom file format.
Example for Image Exporters
Implements an image exporter for the Photoshop image file format.
Example for the Bridge
Renders a scene using the Bridge.
Example for the Node Manager
Demonstrates the use of the node manager.
Example for a Queue Manager Client
Demonstrates the use of the queue manager.

Index of Topics Explained in the Example Programs