NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::bridge::IIray_bridge_snapshot_callback Class Referenceabstract

Abstract interface for snapshot events. More...

Inheritance diagram for mi::bridge::IIray_bridge_snapshot_callback:
Inheritance graph
[legend]

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...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xe36efcd1, 0xeb3d, 0x4c9c, 0xbc, 0x8d, 0xc0, 0x28, 0xf1, 0xe9, 0xc7, 0xdf, mi::neuraylib::IProgress_callback >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
mi::neuraylib::IProgress_callback
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xe36efcd1, 0xeb3d, 0x4c9c, 0xbc, 0x8d, 0xc0, 0x28, 0xf1, 0xe9, 0xc7, 0xdf, mi::neuraylib::IProgress_callback >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Abstract interface for snapshot events.

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

Member Function Documentation

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_code 0 in case of success, or < 0 in case of failure.
error_code - 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: Unspecified error.
file_name The file name that was used for this snapshot if error_code was 0. Otherwise this is a short error message that describes the error.