NVIDIA Iray SDK API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Rendering and Picking

Interfaces related to rendering and picking, for example, canvases and render contexts. More...

Classes

class  mi::neuraylib::ICanvas_base
 Abstract interface for a canvas (base class). More...
 
class  mi::neuraylib::ICanvas
 Abstract interface for a canvas represented by a rectangular array of tiles. More...
 
class  mi::neuraylib::ICanvas_cuda
 Abstract interface for a canvas with CUDA device memory storage. More...
 
class  mi::neuraylib::ICanvas_opengl
 Abstract interface for a canvas that represents an OpenGL buffer. More...
 
class  mi::neuraylib::IImage_api
 This interface provides various utilities related to canvases and buffers. More...
 
class  mi::neuraylib::IPick_array
 This interface represents the return value of a pick operation. More...
 
class  mi::neuraylib::IPick_result
 This interface represents a single object hit by a pick operation. More...
 
class  mi::neuraylib::IProgress_callback
 Abstract interface to report progress of a long-running operation back to the caller. More...
 
class  mi::neuraylib::IReady_callback
 Abstract interface to report completion of an asynchronous operation back to the caller. More...
 
class  mi::neuraylib::IRender_context
 This interface is used for doing actual rendering and picking. It can be obtained from mi::neuraylib::IScene::create_render_context(). More...
 
class  mi::neuraylib::IRender_counters
 Performance counters for render modes. More...
 
class  mi::neuraylib::ICanvas_parameters
 Abstract interface for render target canvas parameters. More...
 
class  mi::neuraylib::IRender_target_base
 Abstract interface for a render target (base class). More...
 
class  mi::neuraylib::IRender_target
 Abstract interface for a render target. More...
 
class  mi::neuraylib::IRender_target_opengl
 Abstract interface for a render target which is specialized for rendering to an OpenGL buffer. More...
 
class  mi::neuraylib::IScene
 The scene is the top-level element describing a subset of DB elements to be rendered. More...
 
class  mi::neuraylib::ITile
 Abstract interface for a tile. More...
 
class  mi::neuraylib::ITile_cuda
 Abstract interface for a CUDA based tile. More...
 

Enumerations

enum  mi::neuraylib::Canvas_type {
  mi::neuraylib::TYPE_RESULT,
  mi::neuraylib::TYPE_RESULT_IRRADIANCE,
  mi::neuraylib::TYPE_RESULT_IRRADIANCE_PROBE,
  mi::neuraylib::TYPE_ALPHA,
  mi::neuraylib::TYPE_SHADOW,
  mi::neuraylib::TYPE_AMBIENT_OCCLUSION,
  mi::neuraylib::TYPE_RAYLENGTH,
  mi::neuraylib::TYPE_DEPTH,
  mi::neuraylib::TYPE_MATERIAL_TAG,
  mi::neuraylib::TYPE_MATERIAL_ID,
  mi::neuraylib::TYPE_OBJECT_ID,
  mi::neuraylib::TYPE_NORMAL,
  mi::neuraylib::TYPE_TEXTURE_COORDINATE,
  mi::neuraylib::TYPE_BSDF_WEIGHT,
  mi::neuraylib::TYPE_CONVERGENCE_HEATMAP,
  mi::neuraylib::TYPE_POST_TOON,
  mi::neuraylib::TYPE_COUNT,
  mi::neuraylib::TYPE_UNDEFINED = 0xffffffffU
}
 The type of a canvas in an mi::neuraylib::IRender_target_base. More...
 
enum  mi::neuraylib::Canvas_parameter {
  mi::neuraylib::PARAM_COLOR_LPE,
  mi::neuraylib::PARAM_ALPHA_LPE,
  mi::neuraylib::PARAM_INDEX,
  mi::neuraylib::PARAM_EDGE_COLOR,
  mi::neuraylib::PARAM_SCALE,
  mi::neuraylib::PARAM_COUNT,
  mi::neuraylib::PARAM_UNDEFINED = 0xffffffffU
}
 The type of a render target canvas parameter in mi::neuraylib::ICanvas_parameters. More...
 

Detailed Description

Interfaces related to rendering and picking, for example, canvases and render contexts.

Enumeration Type Documentation

The type of a render target canvas parameter in mi::neuraylib::ICanvas_parameters.

See Section “Render target canvases” of the Iray Programmer's Manual for details on which canvas types accept which parameters.

Enumerator
PARAM_COLOR_LPE 

IString color LPE.

PARAM_ALPHA_LPE 

IString alpha channel LPE.

PARAM_INDEX 

ISint32 channel index or canvas index.

PARAM_EDGE_COLOR 

IFloat32_3 edge color.

PARAM_SCALE 

IFloat32 scale, meaning depends on type of canvas.

PARAM_COUNT 

number elements in this enum

PARAM_UNDEFINED 

not a valid parameter

The type of a canvas in an mi::neuraylib::IRender_target_base.

This type dictates what is rendered into any given canvas. Native pixel types are documented below but conversions are possible.

See Section “Render target canvases” of the Iray Programmer's Manual for details.

Enumerator
TYPE_RESULT 

"Color" (includes alpha) or "Rgb_fp" result

TYPE_RESULT_IRRADIANCE 

"Rgb_fp" irradiance instead of standard result

TYPE_RESULT_IRRADIANCE_PROBE 

"Rgb_fp" irradiance probes

TYPE_ALPHA 

"Float32" alpha channel

TYPE_SHADOW 

"Rgb_fp" shadows

TYPE_AMBIENT_OCCLUSION 

"Rgb_fp" ambient occlusion

TYPE_RAYLENGTH 

"Float32" ray length

TYPE_DEPTH 

"Float32" orthogonal distance to sensor

TYPE_MATERIAL_TAG 

"Float32_4" material DB tag

TYPE_MATERIAL_ID 

"Float32_4" material_id attribute

TYPE_OBJECT_ID 

"Float32_4" object_id attribute

TYPE_NORMAL 

"Float32_3" shading normal

TYPE_TEXTURE_COORDINATE 

"Float32_3" texture coordinates

TYPE_BSDF_WEIGHT 

"Float32_3" BSDF weight estimate

TYPE_CONVERGENCE_HEATMAP 

"Float32" convergence heatmap

TYPE_POST_TOON 

"Color" (includes alpha) or "Rgb_fp" toon shading effect

TYPE_COUNT 

number of elements in this enum

TYPE_UNDEFINED 

not a valid canvas type