Iray Programmer's Manual

Preface
getting-started | Getting started
- Release overview
- Example programs
- How to compile a program
- How to run a program
- Starting and shutting down the Iray API
- A first image
Library design
- API modules
- Shared library
- Naming conventions
- Include files
- Include file compile-time configuration
- Main API access point
- Version numbers and compatibility
- Interfaces
- Reference counting
- Handle class
- Resources
- Strings
- Error handling
- Database, transactions and scopes
  - Transactions
  - Database scopes
- Runtime configuration
Rendering
- Rendering overview
- Rendering and canvases
- Render mode selection
- Progressive rendering of a scene
- Instancing
- Own canvas class
- Asynchronous rendering
- Multiple render contexts
Iray Photoreal
- photoreal-introduction | Introduction
- System requirements
- Limitations
- Matte objects and matte lights
- Refractive objects and IOR handling
- Progressive rendering
- Caustic sampler
- Architectural sampler
- Light portals
- photoreal-options | Rendering options
- Mixed mode rendering and load balancing
- Timeout prevention
- Integrated noise reduction
Iray Interactive
- interactive-introduction | Introduction
- System requirements
- Limitations
- Progressive rendering
- Lighting
- Rendering options
- Path space filtering
- Output format
- Global performance settings
- Comparison with Iray Photoreal
Iray Realtime
- realtime-introduction | Introduction
- System requirements
- Limitations
- Rendering options
Iray Blend
- Introduction
- Rendering options
Scene database
- Overview of the scene database elements
- Creating a scene programmatically
Geometry
- Creating triangle meshes
- Creating polygon meshes
- Creating on-demand meshes
- Creating subdivision surfaces
- Creating freeform surfaces
Materials
- Material Definition Language
- Measured materials
- Editing and creating materials
Decals
Sources of light
- Emission distribution functions
- Light distribution from scene elements
Environment dome and implicit groundplane
- Environment function
- Environment dome
- Implicit groundplane
Camera
- Tonemapping
  - Photographic tonemapper
  - Custom tonemapper
- Bloom filter
- Lens
- Virtual backplate
- Motion blur
Physically plausible scene setup
- Recommendations for geometry preparation
- Recommendations for lights
  - Using photometric lights
  - Using environment and sunlight
- Recommendations for materials
- Recommendations for cameras
Networking
- Networking overview
- Networking modes
- Iray Bridge
Delivering an image from server-based rendering
- Running an HTTP server
- RTMP server
- RTMP client
- Running an RTMP and HTTP server with mouse interaction
Customization
- Extending the database with user-defined classes
- Extending neuray with plugins
- Extending supported file formats with plugins
Appendix
- Supported file formats and URI schemes
- Canvas names in render targets
- Light path expressions
Bibliography

Rendering options

The following sections describe specific attributes on the IOptions class, shown here with their default settings, for ambient occlusion and shadows as well as other miscellaneous parameters.

Ambient shadow and lighting

mi::Sint32 ogl_ambient_shadow_mode = 0

Controls the occlusion test for environment, instant sun and sky and ambient lighting:

0: no occlusion test
1: screen-space ambient occlusion applied to all material layers.

mi::Float32 ogl_ambient_shadow_radius = 1.0

World space distance beyond which occlusions are not considered.

mi::Sint32 ogl_ambient_shadow_ssao_samples = 4

Number of samples used in the screen-space ambient occlusion computation if ogl_ambient_shadow_mode is set to 1.

mi::Color ogl_ambient_intensity = 0

Intensity of ambient lighting.

Antialiasing

mi::Sint32 ogl_antialiasing_mode = 1

Controls the antialiasing method:

0: no antialiasing.
1: FXAA antialiasing improving in particular the appearance of sharp edges.

Shadowmapping

mi::Boolean ogl_shadows = true: Global on/off flag for shadows.
mi::Sint32 ogl_shadowmap_resolution = 2048: Shadowmap resolution. Note: for omnidirectional point lights the resolution in each of the six main directions is 1/3 of this number.