Iray API Reference

This reference documentation is structured into introductory material, tutorials and examples, reference manuals, and auxiliary material.

The Iray SDK API supports the startup and configuration of the Iray library and can issue rendering calls. The Iray SDK API includes also the math API and the base API. The math API provides vector, matrix, bbox, and color classes and math functions. The base API provides basic types, functions on them, assertions, and configurations.

Introduction

• Getting Started
• Library Design
• Iray SDK API Include Files
• Configuration Options
• Version Numbers and Compatibility

Tutorial and Examples

• Tutorial and Example Programs
• Index of Topics Explained in the Example Programs

Reference Manual

• Base API Reference
  • Versioning, Configuration, and Assertions of the base API
  • Basic Types
  • Multithreading Support
  • Interface Framework Technology
  • Memory Management, Logging, and Plugin Support
• Math API Reference
  • Versioning and Assertions of the math API
  • Math Functions
  • Math Vector, Matrix, Bounding Box, and Color Classes
• Iray SDK API Reference
  • Versioning and Assertions of the Iray SDK API
  • Main Iray Interface and C access function
  • API components
  • Configuration Interfaces
  • Types
  • MDL type system
  • MDL compiler
    • MDL Compiler
  • MDL-related interfaces
  • Database Access
  • Importers and Exporters
  • Scene Elements
    • Scene graph structure, which comprises classes such as mi::neuraylib::IInstance, mi::neuraylib::IGroup, and mi::neuraylib::IProxy.
    • Leaf nodes, which comprises classes such as mi::neuraylib::ICamera, mi::neuraylib::ILight, mi::neuraylib::IOptions, mi::neuraylib::ITriangle_mesh, mi::neuraylib::IPolygon_mesh, mi::neuraylib::ISubdivision_surface, mi::neuraylib::IFreeform_surface, mi::neuraylib::IOn_demand_mesh, mi::neuraylib::IFibers, mi::neuraylib::IParticles, and mi::neuraylib::IVolume.
    • MDL-related elements, which comprises classes such as mi::neuraylib::IFunction_call.
    • Miscellaneous, which comprises classes such as mi::neuraylib::IAttribute_container, mi::neuraylib::IBsdf_measurement, mi::neuraylib::IDecal, mi::neuraylib::IImage, mi::neuraylib::IIrradiance_probes, mi::neuraylib::ILightprofile, mi::neuraylib::IProjector, mi::neuraylib::ISection_object, mi::neuraylib::ITexture, and mi::neuraylib::IVolume_data.
  • Rendering and Picking
  • Functors
  • HTTP server
  • RTMP server
  • Extensions and Plugins
  • Iray Bridge
  • Node manager
  • Cluster manager
  • Queue manager

Related Pages

• Bibliography
• Definition: Lexicographic order and comparison
• Release Notes