neuray API Programmer's Manual

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

mi::​neuraylib::​Annotation_wrapper
A wrapper around the interfaces for MDL annotations
mi::​neuraylib::​Argument_editor
A wrapper around the interface for MDL material instances and function calls
mi::​base::​Atom32
A 32-bit unsigned counter with atomic arithmetic, increments, and decrements
mi::​math::​Bbox< T, DIM>
Axis-aligned N-dimensional bounding box class template of fixed dimension
mi::​math::​Bbox_struct< T, DIM>
Storage class for an axis-aligned N-dimensional bounding box class template of fixed dimension
mi::​base::​Lock::​Block
Utility class to acquire a lock that is released by the destructor
mi::​base::​Recursive_lock::​Block
Utility class to acquire a lock that is released by the destructor
mi::​neuraylib::​Bsdf_buffer
Example implementation of the abstract interface mi::neuraylib::IBsdf_buffer
mi::​neuraylib::​Bsdf_isotropic_data
Example implementation of the abstract interface mi::neuraylib::IBsdf_isotropic_data
mi::​bridge::​Client_job< i_id1, i_id2, i_id3, i_id4, i_id5, i_id6, i_id7, i_id8, i_id9, i_id10, i_id11, I>
This mixin class provides a default implementation for some of the methods needed by mi::bridge::IClient_job
mi::​math::​Color
Standard RGBA color class with floating point elements and operations
mi::​math::​Color_struct
Generic storage class template for an RGBA color representation storing four floating points elements
mi::​base::​Condition
Conditions allow threads to signal an event and to wait for such a signal, respectively
mi::​base::​Default_allocator
A default allocator implementation based on global new and delete
mi::​neuraylib::​Definition_wrapper
A wrapper around the interface for MDL function definitions
mi::​base::​Handle< Interface>
Handle class template for interfaces, automatizing the lifetime control via reference counting
mi::​neuraylib::​IAllocator
The Allocator interface class supports allocating and releasing memory dynamically and querying the amount of extra memory used in the integrating application
mi::​base::​IAllocator
The IAllocator interface class supports allocating and releasing memory dynamically
mi::​neuraylib::​IAnnotation
An annotation is similar to a direct call expression, but without return type
mi::​neuraylib::​IAnnotation_block
An annotation block is an array of annotations
mi::​neuraylib::​IAnnotation_definition
An annotation definition
mi::​neuraylib::​IAnnotation_list
An ordered collection of annotation blocks identified by name or index
mi::​bridge::​IApplication
This class represents a Bridge application
mi::​bridge::​IApplication_session_handler
Abstract interface that can be used to control which sessions to a Bridge application are established, based on credentials supplied by the client
mi::​IArray
This interface represents static arrays, i.e., arrays with a fixed number of elements
mi::​neuraylib::​IAttribute_container
An attribute container is a database element that stores attributes and no other data
mi::​neuraylib::​IAttribute_set
The attribute set comprises all attributes attached to a database element
mi::​neuraylib::​IAttribute_vector
Interface representing an attribute vector for triangle meshes, polygon meshes, and subdivision surfaces
mi::​neuraylib::​IBaker
Allows to bake a varying or uniform expression of a compiled material into a texture or constant
mi::​IBbox3
This interface represents bounding boxes
mi::​IBoolean
This interface represents bool
mi::​IBoolean_2
This interface represents a vector of two bool
mi::​IBoolean_2_2
This interface represents a 2 x 2 matrix of bool
mi::​IBoolean_2_3
This interface represents a 2 x 3 matrix of bool
mi::​IBoolean_2_4
This interface represents a 2 x 4 matrix of bool
mi::​IBoolean_3
This interface represents a vector of three bool
mi::​IBoolean_3_2
This interface represents a 3 x 2 matrix of bool
mi::​IBoolean_3_3
This interface represents a 3 x 3 matrix of bool
mi::​IBoolean_3_4
This interface represents a 3 x 4 matrix of bool
mi::​IBoolean_4
This interface represents a vector of four bool
mi::​IBoolean_4_2
This interface represents a 4 x 2 matrix of bool
mi::​IBoolean_4_3
This interface represents a 4 x 3 matrix of bool
mi::​IBoolean_4_4
This interface represents a 4 x 4 matrix of bool
mi::​bridge::​IBridge_client
API component that serves as entry point for the client-side Bridge API
mi::​bridge::​IBridge_server
API component that serves as entry point for the server-side Bridge API
mi::​bridge::​IBridge_snapshot_context
Context to import, export, or remove snapshots
mi::​neuraylib::​IBsdf_buffer
Abstract interface for a buffer of BSDF values
mi::​neuraylib::​IBsdf_isotropic_data
Abstract interface for isotropic BSDF data
mi::​neuraylib::​IBsdf_measurement
A scene element that stores measured BSDF data
mi::​neuraylib::​IBuffer
Abstract interface for a simple buffer with binary data
mi::​neuraylib::​ICache_manager
Represents an instance of the cache manager
mi::​neuraylib::​ICache_manager_factory
This factory allows to create cache manager instances
mi::​rtmp::​ICall_event_handler
Superclass of all handlers of call events
mi::​neuraylib::​ICamera
The camera defines the viewpoint from which the scene is rendered
mi::​neuraylib::​ICanvas
Abstract interface for a canvas represented by a rectangular array of tiles
mi::​neuraylib::​ICanvas_base
Abstract interface for a canvas (base class)
mi::​neuraylib::​ICanvas_cuda
Abstract interface for a canvas with CUDA device memory storage
mi::​neuraylib::​ICanvas_opengl
Abstract interface for a canvas that represents an OpenGL buffer
mi::​neuraylib::​ICanvas_parameters
Abstract interface for render target canvas parameters
mi::​http::​ICGIRequest_handler
CGI request handlers are responsible for handling HTTP requests
mi::​neuraylib::​IChild_process_resolver
A filter used to decide if a command string to start a child process is eligible for execution
mi::​bridge::​IClient_job
Represents the client-side part of a job that can be executed by the Bridge server
mi::​bridge::​IClient_job_progress
Provides detailed information about the progress of a Bridge job
mi::​bridge::​IClient_measure_bandwidth_callback
Abstract interface for bandwidth measurement events
mi::​neuraylib::​IClient_node_callback
Abstract interface for signaling changed cluster members
mi::​bridge::​IClient_session
Represents the client side of a Bridge session
mi::​bridge::​IClient_session_state_callback
Abstract interface for callbacks for session state changes
mi::​bridge::​IClient_video_context
Client-side video context that receives and decodes video frames from the corresponding server-side video context
mi::​neuraylib::​ICluster_descriptor
This interface describes a cluster and its properties
mi::​neuraylib::​ICluster_filter
A filter used to decide whether a cluster is eligible to be joined
mi::​neuraylib::​ICluster_manager_cluster
Represents a cluster which was reserved through the cluster manager
mi::​neuraylib::​ICluster_manager_configuration
An API component which can be used to create a connection to a cluster manager
mi::​neuraylib::​ICluster_manager_connection
Represents a connection to a cluster manager
mi::​neuraylib::​ICluster_manager_node
Provides information about a node which is part of a node pool or reserved cluster
mi::​neuraylib::​ICluster_notification_callback
Abstract interface for giving notifications about errors and status changes
mi::​neuraylib::​ICluster_pool_information
Represents a pool of nodes managed though the cluster manager
mi::​neuraylib::​ICluster_property_callback
Abstract interface for signaling changed cluster properties
mi::​IColor
This interface represents RGBA colors
mi::​IColor3
This interface represents RGB colors
mi::​neuraylib::​ICompiled_material
This interface represents a compiled material
mi::​ICompound
This interface represents compounds, i.e., vectors, matrices, colors, spectrums, and bounding boxes
mi::​rtmp::​IConnect_event_handler
Superclass of all handlers of connect events
mi::​http::​IConnection
The connection class represents a connection from a client to the server
mi::​rtmp::​IConnection
The connection class represents a connection from a client to the server
mi::​IConst_pointer
This interface represents const pointers
mi::​neuraylib::​ICurve
A curve used by freeform surfaces
mi::​neuraylib::​ICurve_segment
A curve segment used by freeform surfaces
mi::​IData
This interface is the base interface of all types
mi::​IData_collection
This interface represents collections
mi::​http::​IData_handler
A data handler may be added to a connection
mi::​IData_simple
This interface represents simple types
mi::​neuraylib::​IDatabase
This interface is used to interact with the distributed database
mi::​neuraylib::​IDatabase_configuration
This interface is used to query and change the database configuration
mi::​neuraylib::​IDebug_configuration
This interface represents an interface to set debug options
mi::​neuraylib::​IDecal
Decals are sticker-like objects that can be applied to other geometry objects
mi::​neuraylib::​Identifier< name, Int_type>
Handle class for type-safety
mi::​neuraylib::​Identifier_struct< name, Int_type>
Handle class for type-safety
mi::​neuraylib::​IDeserialized_function_name
Represents a deserialized function name
mi::​neuraylib::​IDeserialized_module_name
Represents a deserialized module name
mi::​neuraylib::​IDeserializer
Source for deserializing objects from byte streams
mi::​neuraylib::​IDictionary
The dictionary is a data structure that stores a mapping from a fixed set of keys to a their modifiable values
mi::​IDifference
This interface represents mi::Difference
mi::​IDynamic_array
This interface represents dynamic arrays, i.e., arrays with a variable number of elements
mi::​bridge::​IElement_set
Used to specify a set of elements by name
mi::​IEnum
This interface represents enums
mi::​IEnum_decl
An enum declaration is used to describe enum types
mi::​neuraylib::​IExport_api
This interface is used to export files
mi::​neuraylib::​IExport_result
This interface represents the result of an export operation
mi::​neuraylib::​IExport_result_ext
This interface represents the result of an export operation
mi::​neuraylib::​IExporter
Abstract interface for exporters
mi::​neuraylib::​IExpression
The interface to MDL expressions
mi::​neuraylib::​IExpression_call
An indirect call expression
mi::​neuraylib::​IExpression_constant
A constant expression
mi::​neuraylib::​IExpression_direct_call
A direct call expression
mi::​neuraylib::​IExpression_factory
The interface for creating expressions
mi::​neuraylib::​IExpression_list
An ordered collection of expressions identified by name or index
mi::​neuraylib::​IExpression_parameter
A parameter reference expression
mi::​neuraylib::​IExpression_temporary
A temporary reference expression
mi::​neuraylib::​IExtension_api
This interface is used to extent the neuray API
mi::​http::​IFactory
The factory can be used to instantiate the built-in HTTP classes
mi::​rtmp::​IFactory
The factory can be used to instantiate the built-in RTMP server
mi::​neuraylib::​IFactory
This API component allows the creation, assignment, and cloning of instances of types
mi::​neuraylib::​IFibers
Interface representing a collection of fibers
mi::​IFloat32
This interface represents mi::Float32
mi::​IFloat32_2
This interface represents a vector of two Float32
mi::​IFloat32_2_2
This interface represents a 2 x 2 matrix of Float32
mi::​IFloat32_2_3
This interface represents a 2 x 3 matrix of Float32
mi::​IFloat32_2_4
This interface represents a 2 x 4 matrix of Float32
mi::​IFloat32_3
This interface represents a vector of three Float32
mi::​IFloat32_3_2
This interface represents a 3 x 2 matrix of Float32
mi::​IFloat32_3_3
This interface represents a 3 x 3 matrix of Float32
mi::​IFloat32_3_4
This interface represents a 3 x 4 matrix of Float32
mi::​IFloat32_4
This interface represents a vector of four Float32
mi::​IFloat32_4_2
This interface represents a 4 x 2 matrix of Float32
mi::​IFloat32_4_3
This interface represents a 4 x 3 matrix of Float32
mi::​IFloat32_4_4
This interface represents a 4 x 4 matrix of Float32
mi::​IFloat64
This interface represents mi::Float64
mi::​IFloat64_2
This interface represents a vector of two Float64
mi::​IFloat64_2_2
This interface represents a 2 x 2 matrix of Float64
mi::​IFloat64_2_3
This interface represents a 2 x 3 matrix of Float64
mi::​IFloat64_2_4
This interface represents a 2 x 4 matrix of Float64
mi::​IFloat64_3
This interface represents a vector of three Float64
mi::​IFloat64_3_2
This interface represents a 3 x 2 matrix of Float64
mi::​IFloat64_3_3
This interface represents a 3 x 3 matrix of Float64
mi::​IFloat64_3_4
This interface represents a 3 x 4 matrix of Float64
mi::​IFloat64_4
This interface represents a vector of four Float64
mi::​IFloat64_4_2
This interface represents a 4 x 2 matrix of Float64
mi::​IFloat64_4_3
This interface represents a 4 x 3 matrix of Float64
mi::​IFloat64_4_4
This interface represents a 4 x 4 matrix of Float64
mi::​rtmp::​IFrame_event_handler
Superclass of all handlers of frame events
mi::​neuraylib::​IFreeform_surface
Interface representing a freeform surface
mi::​neuraylib::​IFunction_call
This interface represents a function call
mi::​neuraylib::​IFunction_definition
This interface represents a function definition
mi::​neuraylib::​IFunctor_base
Base class for functors
mi::​neuraylib::​IGeneral_configuration
This interface is used to query and change the general configuration
mi::​neuraylib::​IGeometry_simplifier
Functor to simplify a triangle mesh
mi::​neuraylib::​IGpu_description
This interface describes a GPU
mi::​neuraylib::​IGroup
A group is a container for other scene elements
mi::​neuraylib::​IHead_node_callback
Abstract interface for signaling a change of the cluster application head node
mi::​neuraylib::​IHost_callback
Abstract interface to report cluster status changes
mi::​neuraylib::​IHost_properties
This interface contains information about a local or remote host
mi::​neuraylib::​IImage
This interface represents a pixel image file
mi::​neuraylib::​IImage_api
This interface provides various utilities related to canvases and buffers
mi::​neuraylib::​IImage_file
Abstract interface for image files
mi::​neuraylib::​IImage_plugin
Abstract interface for image plugins
mi::​neuraylib::​IImpexp_base
Abstract base interface common for importers and exporters
mi::​neuraylib::​IImpexp_state
This interface represents states that are passed to recursive calls of importers and exporters
mi::​neuraylib::​IImport_api
This interface is used to import files
mi::​neuraylib::​IImport_result
This interface represents the result of an import operation
mi::​neuraylib::​IImport_result_ext
This interface represents the result of an import operation
mi::​neuraylib::​IImporter
Abstract interface for importers
mi::​bridge::​IIncremental_snapshot_context
Context for incremental snapshots
mi::​neuraylib::​IInstance
An instance is a scene element that adds a transformation and attributes to another scene element
mi::​base::​IInterface
The basic extensible interface
mi::​bridge::​IIray_bridge_application
The Iray Bridge application
mi::​bridge::​IIray_bridge_client
API component that serves as entry point for the client-side Iray Bridge API
mi::​bridge::​IIray_bridge_server
API component that serves as entry point for the server-side Iray Bridge API
mi::​bridge::​IIray_bridge_session
Represents a session (connection) to an Iray Bridge Server
mi::​bridge::​IIray_bridge_snapshot_callback
Abstract interface for snapshot events
mi::​bridge::​IIray_bridge_snapshot_context
Context for creating Iray Bridge snapshots
mi::​bridge::​IIray_bridge_snapshot_handler
The IIray_bridge_snapshot_handler can be used to control snapshot creation for an Iray bridge server application
mi::​neuraylib::​IIrradiance_probes
Irradiance probes are used to render the irradiance at certain locations in the scene
mi::​neuraylib::​IJob_execution_context
Provides information about the context in which a job is executed
mi::​neuraylib::​ILibrary_authenticator
This interface is used for authenticating the application against the library
mi::​neuraylib::​ILight
Point, spot, directional and area lighting
mi::​neuraylib::​ILightprofile
This interface represents light profiles
mi::​neuraylib::​ILink_unit
Represents a link-unit of an MDL backend
mi::​base::​ILogger
The ILogger interface class supports logging of messages
mi::​neuraylib::​ILogging_configuration
This interface is used for configuring the logging for the
mi::​neuraylib::​ILpe_analysis_result
This interface represents the return value of mi::neuraylib::IRendering_configuration::analyze_light_path_expressions()
mi::​neuraylib::​ILpe_check_result
This interface represents the return value of mi::neuraylib::IRendering_configuration::check_light_path_expressions()
mi::​neuraylib::​IManifest
Represents the manifest in an MDL archive
mi::​IMap
This interface represents maps, i.e., a key-value based data structure
mi::​neuraylib::​IMaterial_instance
This interface represents a material instance
mi::​neuraylib::​IMdl_archive_api
This API component provides functionality related to MDL archives
mi::​neuraylib::​IMdl_backend
MDL backends allow to transform compiled material instances or function calls into target code
mi::​neuraylib::​IMdl_backend_api
This interface can be used to obtain the MDL backends
mi::​neuraylib::​IMdl_compatibility_api
Provides access to various functions to inspect the compatibility between MDL modules and archives
mi::​neuraylib::​IMdl_configuration
This interface can be used to query and change the MDL configuration
mi::​neuraylib::​IMdl_discovery_api
Interface for the discovery API
mi::​neuraylib::​IMdl_discovery_result
Interface for the discovery result
mi::​neuraylib::​IMdl_distiller_api
Provides access to various functionality related to MDL distilling
mi::​neuraylib::​IMdl_entity_resolver
The entity resolver is used to resolve MDL modules and resources in such modules
mi::​neuraylib::​IMdl_evaluator_api
Provides access to various functions for the evaluation of MDL expressions
mi::​neuraylib::​IMdl_execution_context
The execution context can be used to query status information like error and warning messages concerning the operation it was passed into
mi::​neuraylib::​IMdl_factory
Factory for various MDL interfaces and functions
mi::​neuraylib::​IMdl_i18n_configuration
This interface is used to query and change MDL internationalization settings
mi::​neuraylib::​IMdl_impexp_api
API component for MDL related import and export operations
mi::​neuraylib::​IMdl_info
Abstract interface for a discovery graph node
mi::​neuraylib::​IMdl_lightprofile_info
Interface for lightprofile files
mi::​neuraylib::​IMdl_loading_wait_handle
Interface of a loading wait handle
mi::​neuraylib::​IMdl_loading_wait_handle_factory
Interface of a loading wait handle factory
mi::​neuraylib::​IMdl_measured_bsdf_info
Interface for measured bsdf files
mi::​neuraylib::​IMdl_module_builder
The module builder allows to create new MDL modules
mi::​neuraylib::​IMdl_module_info
Interface for a graph node representing an MDL module
mi::​neuraylib::​IMdl_module_transformer
The module transformer allows to apply certain transformations on an MDL module
mi::​neuraylib::​IMdl_package_info
Interface for a graph node representing an MDL package
mi::​neuraylib::​IMdl_resolved_module
Describes a resolved module (or a failed attempt)
mi::​neuraylib::​IMdl_resolved_resource
Describes an ordered set of resolved resource elements
mi::​neuraylib::​IMdl_resolved_resource_element
Describes an ordered set of resolved resource entities
mi::​neuraylib::​IMdl_resource_info
Interface for resources
mi::​neuraylib::​IMdl_texture_info
Interface for texture files
mi::​neuraylib::​IMdl_xliff_info
Interface for xliff files
mi::​neuraylib::​IMdle_api
Provides access to functions related to the creation of encapsulated MDL modules (MDLE)
mi::​neuraylib::​IMdle_deserialization_callback
Callback to map references to MDLE modules during deserialization
mi::​neuraylib::​IMdle_serialization_callback
Callback to map references to MDLE modules during serialization
mi::​neuraylib::​IMessage
Message interface
mi::​neuraylib::​IModule
This interface represents an MDL module
mi::​neuraylib::​INetwork_configuration
This interface is used to query and change the networking configuration
mi::​neuraylib::​INetwork_statistics
This interface is used to inquire statistics about the network usage etc
mi::​neuraylib::​INeuray
This is an object representing the
mi::​neuraylib::​INode_manager_client
The node manager client allows to start or join clusters built from worker nodes
mi::​neuraylib::​INode_manager_cluster
The interface to a cluster created and managed by the node manager
mi::​neuraylib::​INode_manager_factory
Factory to create node manager client and worker instances
mi::​neuraylib::​INode_manager_worker
The node manager worker class allows to set properties and announce them to other nodes
mi::​base::​Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, I>
Mixin class template for deriving new interface declarations
mi::​base::​Interface_implement< I>
Mixin class template for deriving interface implementations
mi::​base::​Interface_implement_2< I1, I2>
Mixin class template for deriving interface implementations from two interfaces
mi::​base::​Interface_implement_singleton< I>
Mixin class template for deriving singleton interface implementations, where the reference count is fixed to one
mi::​base::​Interface_merger< MAJOR, MINOR>
This mixin merges the implementation of one interface with a second interface
mi::​INumber
This interface represents simple numeric types
mi::​neuraylib::​IOn_demand_mesh
Interface representing an on-demand mesh
mi::​neuraylib::​IOn_demand_mesh_callback
Abstract interface for callbacks used by on-demand meshes
mi::​neuraylib::​IOptions
A scene element that stores scene-specific settings
mi::​neuraylib::​IParticles
Interface representing a collection of particles
mi::​rtmp::​IPause_event_handler
Superclass of all handlers of pause events
mi::​neuraylib::​IPick_array
This interface represents the return value of a pick operation
mi::​neuraylib::​IPick_result
This interface represents a single object hit by a pick operation
mi::​rtmp::​IPlay_event_handler
Superclass of all handlers of play events
mi::​neuraylib::​IPlugin
The basic interface to be implemented by neuray API plugins
mi::​neuraylib::​IPlugin_api
This abstract interface gives access to the neuray API to plugins
mi::​neuraylib::​IPlugin_configuration
This interface is used to load plugins and to query information about loaded plugins
mi::​base::​IPlugin_descriptor
Represents a plugin
mi::​IPointer
This interface represents mutable pointers
mi::​neuraylib::​IPolygon_connectivity
A connectivity class for polygon mesh geometry and their attributes
mi::​neuraylib::​IPolygon_mesh
Interface representing a polygon mesh
mi::​neuraylib::​IProgress_callback
Abstract interface to report progress of a long-running operation back to the caller
mi::​neuraylib::​IProjector
Projectors are functions that generate texture coordinates for a particular texture space
mi::​neuraylib::​IProxy
The Proxy is an element that can be used to represent a sub-tree of scene elements on a Bridge server without ever having to load those elements on the client
mi::​neuraylib::​IQueue_manager_api
An API component which can be used to create a connection to a queue manager
mi::​neuraylib::​IQueue_manager_connection
Represents a connection to a queue manager server
mi::​neuraylib::​IReader
A reader supports binary block reads and string-oriented line reads that zero-terminate the result
mi::​neuraylib::​IReader_writer_base
Base interface for readers and writers
mi::​neuraylib::​IReady_callback
Abstract interface to report completion of an asynchronous operation back to the caller
mi::​IRef
A reference is an object that acts as a pointer to other database elements
mi::​neuraylib::​IRender_context
This interface is used for doing actual rendering and picking
mi::​neuraylib::​IRender_counters
Performance counters for render modes
mi::​rtmp::​IRender_event_handler
Superclass of all handlers of render events
mi::​neuraylib::​IRender_target
Abstract interface for a render target
mi::​neuraylib::​IRender_target_base
Abstract interface for a render target (base class)
mi::​neuraylib::​IRender_target_cuda
A render target which is specialized for rendering to CUDA device memory
mi::​neuraylib::​IRender_target_opengl
Abstract interface for a render target which is specialized for rendering to an OpenGL buffer
mi::​neuraylib::​IRendering_configuration
This interface is used to query and change the rendering configuration
mi::​http::​IRequest
This interface holds all the parameters of a request
mi::​http::​IRequest_handler
Request handlers are responsible for handling HTTP requests
mi::​http::​IResponse
This interface holds all the parameters of a response
mi::​http::​IResponse_handler
Response handlers can be used to modify responses generated by request handlers
mi::​neuraylib::​IScene
The scene is the top-level element describing a subset of DB elements to be rendered
mi::​neuraylib::​IScene_element
Common base interface for all scene elements
mi::​neuraylib::​IScheduling_configuration
This interface is used to query and change the scheduling configuration
mi::​neuraylib::​IScope
A scope is the context which determines the visibility of database elements
mi::​neuraylib::​ISection_object
Section objects are used to cull parts of the scene
mi::​neuraylib::​ISerializable
All serializable objects have to be derived from this interface
mi::​neuraylib::​ISerialized_function_name
Represents a serialized function name
mi::​neuraylib::​ISerializer
Target for serializing objects to byte streams
mi::​rtmp::​IServer
The server builds a framework for the handlers
mi::​http::​IServer
The server builds a framework for the handlers
mi::​bridge::​IServer_job
Represents the server-side part of a job that can be executed by the Bridge server
mi::​bridge::​IServer_job_info
Provides additional information about a bridge job
mi::​bridge::​IServer_job_list
A list of IServer_job instances
mi::​bridge::​IServer_session
Represents the server side of a Bridge session
mi::​bridge::​IServer_session_state_callback
Abstract interface for callbacks for session state changes
mi::​bridge::​IServer_transaction
Database transactions started on the client will be automatically mirrored to the server and exposed as instances of this class to executing Bridge jobs
mi::​bridge::​IServer_transaction_callback
Abstract interface for callbacks for transaction commit or abort events
mi::​bridge::​IServer_transaction_list
A list of IServer_transaction instances
mi::​bridge::​IServer_video_context
Server-side video context that generates and encodes video frames for the corresponding client-side video context
mi::​neuraylib::​IShutdown_cluster_callback
Abstract interface for signaling a request to shutdown a cluster
mi::​neuraylib::​IShutdown_node_managers_callback
Abstract interface for signaling a request to shutdown all clients and workers
mi::​neuraylib::​ISimple_mesh
Interface representing the geometry of on-demand meshes
mi::​ISint16
This interface represents mi::Sint16
mi::​ISint32
This interface represents mi::Sint32
mi::​ISint32_2
This interface represents a vector of two Sint32
mi::​ISint32_2_2
This interface represents a 2 x 2 matrix of Sint32
mi::​ISint32_2_3
This interface represents a 2 x 3 matrix of Sint32
mi::​ISint32_2_4
This interface represents a 2 x 4 matrix of Sint32
mi::​ISint32_3
This interface represents a vector of three Sint32
mi::​ISint32_3_2
This interface represents a 3 x 2 matrix of Sint32
mi::​ISint32_3_3
This interface represents a 3 x 3 matrix of Sint32
mi::​ISint32_3_4
This interface represents a 3 x 4 matrix of Sint32
mi::​ISint32_4
This interface represents a vector of four Sint32
mi::​ISint32_4_2
This interface represents a 4 x 2 matrix of Sint32
mi::​ISint32_4_3
This interface represents a 4 x 3 matrix of Sint32
mi::​ISint32_4_4
This interface represents a 4 x 4 matrix of Sint32
mi::​ISint64
This interface represents mi::Sint64
mi::​ISint8
This interface represents mi::Sint8
mi::​ISize
This interface represents mi::Size
mi::​neuraylib::​ISoftware_package
Represents a software package installed on the pool of nodes
mi::​ISpectrum
This interface represents spectrums
mi::​rtmp::​IStream
Representing an RTMP stream
mi::​rtmp::​IStream_event_handler
Superclass of all handlers of create stream events
mi::​neuraylib::​IStream_position
Represents the position in a data stream
mi::​IString
A simple string class
mi::​neuraylib::​IStruct_category
Represents the optional struct category for struct types
mi::​neuraylib::​IStruct_category_list
An ordered collection of struct categories identified by name or index
mi::​IStructure
This interface represents structures, i.e., a key-value based data structure
mi::​IStructure_decl
A structure declaration is used to describe structure types
mi::​neuraylib::​ISubdivision_surface
Interface representing a subdivision surface
mi::​neuraylib::​ISurface
A surface of a freeform surface
mi::​neuraylib::​ITarget_argument_block
Represents an argument block of a class-compiled material compiled for a specific target
mi::​neuraylib::​ITarget_code
Represents target code of an MDL backend
mi::​neuraylib::​ITarget_resource_callback
A callback interface to allow the user to handle resources when creating new mi::neuraylib::ITarget_argument_block objects for class-compiled materials when the arguments contain textures not known during compilation
mi::​neuraylib::​ITarget_value_layout
Represents the layout of an mi::neuraylib::ITarget_argument_block with support for nested elements
mi::​neuraylib::​ITessellator
Functor to tessellate a polygon mesh into a triangle mesh
mi::​neuraylib::​ITexture
Textures add image processing options to images
mi::​neuraylib::​ITexture_surface
A texture surface associated with freeform surfaces
mi::​neuraylib::​ITile
Abstract interface for a tile
mi::​neuraylib::​ITimer
This is an abstract interface class for a timer
mi::​neuraylib::​ITimer_class_factory
The registration of a timer class requires a factory which constructs an instance during deserialization
mi::​neuraylib::​ITimer_configuration
This class is used to start and stop timers
mi::​neuraylib::​ITransaction
A transaction provides a consistent view on the database
mi::​neuraylib::​ITriangle_connectivity
A connectivity class for triangle mesh geometry and their attributes
mi::​neuraylib::​ITriangle_mesh
Interface representing a triangle mesh
mi::​neuraylib::​IType
The interface to MDL types
mi::​neuraylib::​IType_alias
The type of kind alias
mi::​neuraylib::​IType_array
The type of kind array
mi::​neuraylib::​IType_atomic
An atomic type
mi::​neuraylib::​IType_bool
The type of kind bool
mi::​neuraylib::​IType_bsdf
The type of kind bsdf
mi::​neuraylib::​IType_bsdf_measurement
The type of kind bsdf_measurement
mi::​neuraylib::​IType_color
The type of kind color
mi::​neuraylib::​IType_compound
A compound type
mi::​neuraylib::​IType_df
The type of distribution functions
mi::​neuraylib::​IType_double
The type of kind double
mi::​neuraylib::​IType_edf
The type of kind edf
mi::​neuraylib::​IType_enum
A type of kind enum
mi::​neuraylib::​IType_factory
The interface for creating types
mi::​neuraylib::​IType_float
The type of kind float
mi::​neuraylib::​IType_hair_bsdf
The type of kind bsdf
mi::​neuraylib::​IType_int
The type of kind int
mi::​neuraylib::​IType_light_profile
The type of kind light_profile
mi::​neuraylib::​IType_list
An ordered collection of types identified by name or index
mi::​neuraylib::​IType_matrix
The type of kind matrix
mi::​neuraylib::​IType_reference
The reference types
mi::​neuraylib::​IType_resource
A string valued resource type
mi::​neuraylib::​IType_string
The type of kind string
mi::​neuraylib::​IType_struct
The type of kind struct
mi::​neuraylib::​IType_texture
The type of kind texture
mi::​neuraylib::​IType_vdf
The type of kind vdf
mi::​neuraylib::​IType_vector
The type of kind vector
mi::​IUint16
This interface represents mi::Uint16
mi::​IUint32
This interface represents mi::Uint32
mi::​IUint32_2
This interface represents a vector of two Uint32
mi::​IUint32_2_2
This interface represents a 2 x 2 matrix of Uint32
mi::​IUint32_2_3
This interface represents a 2 x 3 matrix of Uint32
mi::​IUint32_2_4
This interface represents a 2 x 4 matrix of Uint32
mi::​IUint32_3
This interface represents a vector of three Uint32
mi::​IUint32_3_2
This interface represents a 3 x 2 matrix of Uint32
mi::​IUint32_3_3
This interface represents a 3 x 3 matrix of Uint32
mi::​IUint32_3_4
This interface represents a 3 x 4 matrix of Uint32
mi::​IUint32_4
This interface represents a vector of four Uint32
mi::​IUint32_4_2
This interface represents a 4 x 2 matrix of Uint32
mi::​IUint32_4_3
This interface represents a 4 x 3 matrix of Uint32
mi::​IUint32_4_4
This interface represents a 4 x 4 matrix of Uint32
mi::​IUint64
This interface represents mi::Uint64
mi::​IUint8
This interface represents mi::Uint8
mi::​neuraylib::​IUser_class
Abstract interface for user-defined classes
mi::​neuraylib::​IUser_class_factory
Abstract interface for user class factories
mi::​IUuid
This interface represents UUIDs
mi::​neuraylib::​IValue
The interface to MDL values
mi::​neuraylib::​IValue_array
A value of type array
mi::​neuraylib::​IValue_atomic
An atomic value
mi::​neuraylib::​IValue_bool
A value of type boolean
mi::​neuraylib::​IValue_bsdf_measurement
A BSDF measurement value
mi::​neuraylib::​IValue_color
A value of type color
mi::​neuraylib::​IValue_compound
A compound value
mi::​neuraylib::​IValue_double
A value of type double
mi::​neuraylib::​IValue_enum
A value of type enum
mi::​neuraylib::​IValue_factory
The interface for creating values
mi::​neuraylib::​IValue_float
A value of type float
mi::​neuraylib::​IValue_int
A value of type integer
mi::​neuraylib::​IValue_invalid_df
An invalid distribution function value
mi::​neuraylib::​IValue_light_profile
A light profile value
mi::​neuraylib::​IValue_list
An ordered collection of values identified by name or index
mi::​neuraylib::​IValue_matrix
A value of type matrix
mi::​neuraylib::​IValue_resource
Base class for resource values
mi::​neuraylib::​IValue_string
A value of type string
mi::​neuraylib::​IValue_string_localized
A value of type string which can be used to obtain the original, non-localized value of a localized string
mi::​neuraylib::​IValue_struct
A value of type struct
mi::​neuraylib::​IValue_texture
A texture value
mi::​neuraylib::​IValue_vector
A value of type vector
mi::​neuraylib::​IVersion
Abstract interface for accessing version information
mi::​neuraylib::​IVideo_codec_factory
API component that allow creation of installed video encoders and decoders
mi::​neuraylib::​IVideo_data
A buffer for video data representing a frame
mi::​neuraylib::​IVideo_decoder
Abstract interface for video decoders
mi::​neuraylib::​IVideo_encoder
Abstract interface for video encoders
mi::​bridge::​IVideo_frame
Represents the data for a single video frame
mi::​neuraylib::​IVideo_plugin
Abstract interface for video encoder plugins
mi::​bridge::​IVideo_sink
Abstract interface to receive video frames produced by the corresponding server-side video context
mi::​bridge::​IVideo_source
Abstract interface to generate video frames that are transmitted to the corresponding client-side video context
mi::​IVoid
This interface represents the void type
mi::​neuraylib::​IVolume
Interface representing a top-level volume
mi::​neuraylib::​IVolume_data
Interface representing a volume data set
mi::​neuraylib::​IVolume_info
Basic information about one of the data sets contained in a volume data file
mi::​http::​IWeb_socket
The WebSocket connection class represents a connection that is built on top of an HTTP connection
mi::​http::​IWeb_socket_data_handler
A WebSocket data handler that can be installed to a WebSocket connection to handle data arriving at the WebSocket
mi::​http::​IWeb_socket_handler
WebSocket handlers are responsible for handling WebSocket requests
mi::​http::​IWeb_socket_state_handler
A WebSocket state handler that can be installed to a WebSocket connection to handle events of the WebSocket
mi::​neuraylib::​IWelder
Functor to weld a triangle mesh
mi::​neuraylib::​IWorker_node_callback
Abstract interface for signaling changed cluster members
mi::​neuraylib::​IWorker_node_descriptor
This interface describes a worker node and its properties
mi::​neuraylib::​IWorker_node_filter
A filter used to decide whether a worker node is eligible to be included in a cluster
mi::​neuraylib::​IWorker_node_property_callback
Abstract interface for signaling changed worker node properties
mi::​neuraylib::​IWorker_process_started_callback
Abstract interface for indicating that a worker process has been fully started
mi::​neuraylib::​IWriter
A writer supports binary block writes and string-oriented line writes that accept a zero-terminated string as argument
mi::​base::​Lock
Non-recursive lock class
mi::​base::​Log_stream
Adapts mi::base::ILogger to a standard streaming interface
mi::​math::​Matrix< T, ROW, COL>
NxM-dimensional matrix class template of fixed dimensions
mi::​math::​Matrix_struct< T, ROW, COL>
Storage class for a NxM-dimensional matrix class template of fixed dimensions
mi::​math::​Matrix_struct< T, 1, 1>
Specialization for 1x1-matrix
mi::​math::​Matrix_struct< T, 1, 2>
Specialization for 1x2-matrix
mi::​math::​Matrix_struct< T, 1, 3>
Specialization for 1x3-matrix
mi::​math::​Matrix_struct< T, 1, 4>
Specialization for 1x4-matrix
mi::​math::​Matrix_struct< T, 2, 1>
Specialization for 2x1-matrix
mi::​math::​Matrix_struct< T, 2, 2>
Specialization for 2x2-matrix
mi::​math::​Matrix_struct< T, 2, 3>
Specialization for 2x3-matrix
mi::​math::​Matrix_struct< T, 2, 4>
Specialization for 2x4-matrix
mi::​math::​Matrix_struct< T, 3, 1>
Specialization for 3x1-matrix
mi::​math::​Matrix_struct< T, 3, 2>
Specialization for 3x2-matrix
mi::​math::​Matrix_struct< T, 3, 3>
Specialization for 3x3-matrix
mi::​math::​Matrix_struct< T, 3, 4>
Specialization for 3x4-matrix
mi::​math::​Matrix_struct< T, 4, 1>
Specialization for 4x1-matrix
mi::​math::​Matrix_struct< T, 4, 2>
Specialization for 4x2-matrix
mi::​math::​Matrix_struct< T, 4, 3>
Specialization for 4x3-matrix
mi::​math::​Matrix_struct< T, 4, 4>
Specialization for 4x4-matrix
mi::​base::​Message_details
Structured details to log messages
mi::​base::​numeric_traits< T>
Helper class to deduce properties of numeric types defined in this API
mi::​base::​numeric_traits< Float32>
Numeric traits specialization for mi::Float32
mi::​base::​numeric_traits< Float64>
Numeric traits specialization for mi::Float64
mi::​base::​numeric_traits< Sint16>
Numeric traits specialization for mi::Sint16
mi::​base::​numeric_traits< Sint32>
Numeric traits specialization for mi::Sint32
mi::​base::​numeric_traits< Sint64>
Numeric traits specialization for mi::Sint64
mi::​base::​numeric_traits< Sint8>
Numeric traits specialization for mi::Sint8
mi::​base::​numeric_traits< Uint16>
Numeric traits specialization for mi::Uint16
mi::​base::​numeric_traits< Uint32>
Numeric traits specialization for mi::Uint32
mi::​base::​numeric_traits< Uint64>
Numeric traits specialization for mi::Uint64
mi::​base::​numeric_traits< Uint8>
Numeric traits specialization for mi::Uint8
mi::​base::​numeric_traits_base< T>
Base class for the helper class to deduce properties of numeric types defined in this API
mi::​math::​functor::​Operator_and_and
Functor for the logical and operator, &&
mi::​math::​functor::​Operator_divide
Functor for the division operator, /
mi::​math::​functor::​Operator_equal_equal
Functor for the equality comparison operator, ==
mi::​math::​functor::​Operator_greater
Functor for the greater-than comparison operator, >
mi::​math::​functor::​Operator_greater_equal
Functor for the greater-than-or-equal comparison operator, >=
mi::​math::​functor::​Operator_less
Functor for the less-than comparison operator, <
mi::​math::​functor::​Operator_less_equal
Functor for the less-than-or-equal comparison operator, <=
mi::​math::​functor::​Operator_minus
Functor for the minus operator, -, unary and binary
mi::​math::​functor::​Operator_multiply
Functor for the multiplication operator, *
mi::​math::​functor::​Operator_not
Functor for the logical not operator, !
mi::​math::​functor::​Operator_not_equal
Functor for the inequality comparison operator, !=
mi::​math::​functor::​Operator_or_or
Functor for the logical or operator, ||
mi::​math::​functor::​Operator_plus
Functor for the plus operator, +
mi::​math::​functor::​Operator_post_decr
Functor for the post-decrement operator, --
mi::​math::​functor::​Operator_post_incr
Functor for the post-increment operator, ++
mi::​math::​functor::​Operator_pre_decr
Functor for the pre-decrement operator, --
mi::​math::​functor::​Operator_pre_incr
Functor for the pre-increment operator, ++
mi::​math::​functor::​Operator_xor
Functor for the xor operator, ^
mi::​base::​Plugin
The abstract base class for plugins
mi::​base::​Std_allocator< T>::​rebind< T1>
Rebind helper struct to define a new class instance of this allocator template instantiated for the new value type T1
mi::​base::​Recursive_lock
Recursive lock class
mi::​neuraylib::​Resource_data
The data structure providing access to resources for generated code
mi::​bridge::​Server_job< i_id1, i_id2, i_id3, i_id4, i_id5, i_id6, i_id7, i_id8, i_id9, i_id10, i_id11, I>
This mixin class provides a default implementation for some of the methods needed by mi::bridge::IServer_job
mi::​neuraylib::​Shading_state_environment
The MDL environment state structure inside the MDL SDK is a representation of the renderer state in the context of an environment lookup as defined in section 19 "Renderer state" in the MDL specification
mi::​neuraylib::​Shading_state_material_impl< with_derivatives>
The MDL material state structure inside the MDL SDK is a representation of the renderer state as defined in section 19 "Renderer state" in the MDL specification
mi::​math::​Spectrum
Spectrum with floating point elements and operations
mi::​math::​Spectrum_struct
Generic storage class template for a Spectrum representation storing three floating point elements
mi::​base::​Std_allocator< T>
An adaptor class template that implements a standard STL allocator
mi::​neuraylib::​Tag
A tag represents a unique identifier for database elements in the database
mi::​neuraylib::​Tag_struct
A tag represents a unique identifier for database elements in the database
mi::​neuraylib::​Target_function_description
Description of target function
mi::​neuraylib::​Target_value_layout_state
Structure representing the state during traversal of the nested layout
mi::​neuraylib::​tct_deriv< T>
A template struct with derivatives
mi::​neuraylib::​Texture_handler_base
The texture handler structure that is passed to the texturing functions
mi::​neuraylib::​Texture_handler_deriv_base
The texture handler structure that is passed to the texturing functions with derivative support
mi::​neuraylib::​Texture_handler_vtable_impl< with_derivatives>
The runtime for bitmap texture access for the generated target code can optionally be implemented in form of a vtable as specified by this structure
mi::​neuraylib::​Timer_class_factory< T>
This mixin class provides a default implementation of the mi::neuraylib::ITimer_class_factory interface
mi::​neuraylib::​Triangle_point_indices
A triangle defined by three point indices, starting at index 0
mi::​neuraylib::​Triangle_point_indices_struct
A triangle defined by three point indices, starting at index 0
mi::​Type_traits< I>
Type traits relating interfaces, corresponding primitive types, and their type names
mi::​bridge::​Update_job
Base class for Bridge jobs that only update elements without executing anything
mi::​neuraylib::​User_class< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, I>
This mixin class should be used to implement the IUser_class interface
mi::​neuraylib::​User_class_factory< T>
This mixin class provides a default implementation of the IUser_class_factory interface
mi::​base::​Uuid
A 128 bit representation of a universally unique identifier (UUID or GUID)
mi::​base::​Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11>
Class template for a compile-time representation of universally unique identifiers (UUIDs or GUIDs)
mi::​math::​Vector< T, DIM>
Fixed-size math vector class template with generic operations
mi::​math::​Vector_struct< T, DIM>
Generic storage class template for math vector representations storing DIM elements of type T
mi::​math::​Vector_struct< T, 1>
Specialization for dimension 1 to create x member
mi::​math::​Vector_struct< T, 2>
Specialization for dimension 2 to create x and y member
mi::​math::​Vector_struct< T, 3>
Specialization for dimension 3 to create x, y, and z members
mi::​math::​Vector_struct< T, 4>
Specialization for dimension 4 to create x, y, z, and w members