Iray SDK API nvidia_logo_transpbg.gif Up
mi::bridge::IIray_bridge_snapshot_callback Class Referenceabstract

Abstract interface for snapshot events. More...

#include <iiray_bridge_client.h>

Inheritance diagram for mi::bridge::IIray_bridge_snapshot_callback:

Public Member Functions

virtual void ready (Sint32 error_code, const char *file_name)=0
 Called when the snapshot is done or if there was an error. More...
 
- Public Member Functions inherited from mi::neuraylib::IProgress_callback
virtual void progress (Float64 value, const char *area, const char *message)=0
 The callback method that provides the progress information. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xe36efcd1, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::Interface_declare< 0xa0f0f12b, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xe36efcd1, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xa0f0f12b, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

Abstract interface for snapshot events.

See also
mi::bridge::IIray_bridge_snapshot_context::create_snapshot()

Member Function Documentation

 ready()

virtual void mi::bridge::IIray_bridge_snapshot_callback::ready ( Sint32  error_code,
const char *  file_name 
)
pure virtual

Called when the snapshot is done or if there was an error.

Parameters
error_code0 in case of success, or < 0 in case of failure.
  • 0: The snapshot was successfully created.
  • -1: Network error.
  • -2: Failed to execute server side job to save snapshot.
  • -3: The snapshot was canceled.
  • -4: Illegal characters in path.
  • -5: Failed to save .cb file.
  • -6: Failed to create snapshot.
  • -7: Server application refused the snapshot.
  • <= -8: Unspecified error.
file_nameThe file name that was used for this snapshot if error_code was 0. Otherwise this is a short error message that describes the error.