neuray Services API Programmer's Manual

mi::nservices::Event_helper_neuray Class Reference

[Events]

Description

A helper class to facilitate neuray event creation and sending.

Static Public Member Functions

static mi::Sint32 send_post_render_event( IEvent_context* event_context, const mi::​nservices::​IScene* scene, const mi::neuraylib::ICanvas* canvas, const mi::IString* renderer)
Sends a POST_RENDER event. More...
static mi::Sint32 send_pre_render_event( IEvent_context* event_context, const mi::​nservices::​IScene* scene, const mi::neuraylib::ICanvas_parameters* canvas_params, const mi::IString* canvas_pixel_type, const mi::IString* renderer, const mi::INumber* resolution_x, const mi::INumber* resolution_y)
Sends a PRE_RENDER event. More...

Member Functions

static mi::Sint32 mi::​nservices::​Event_helper_neuray::send_post_render_event( IEvent_context* event_context, const mi::​nservices::​IScene* scene, const mi::neuraylib::ICanvas* canvas, const mi::IString* renderer) [inline, static]

Sends a POST_RENDER event.

Parameters

event_context
The event context to use.
scene
the scene that was rendered.
canvas
the result of the render.
renderer
the name of the renderer used.

Returns

the return value of the last event handler or one of the following errors:

  • NRS_ERROR_MEMORY : out of memory.
  • NRS_ERROR_INVALID_PARAMETERS : event_context is NULL.
  • NRS_ERROR_EVENT_NO_HANDLERS : no handlers registered for this event type.
  • NRS_ERROR_FAILED : internal error.

static mi::Sint32 mi::​nservices::​Event_helper_neuray::send_pre_render_event( IEvent_context* event_context, const mi::​nservices::​IScene* scene, const mi::neuraylib::ICanvas_parameters* canvas_params, const mi::IString* canvas_pixel_type, const mi::IString* renderer, const mi::INumber* resolution_x, const mi::INumber* resolution_y) [inline, static]

Sends a PRE_RENDER event.

Parameters

event_context
The event context to use.
scene
the scene about to be rendered.
canvas_params
canvas_pixel_type
the pixel type of the canvas to render.
renderer
the renderer to use.
resolution_x
the x resolution.
resolution_y
the y resolution.

Returns

the return value of the last event handler or one of the following errors:

  • NRS_ERROR_MEMORY : out of memory.
  • NRS_ERROR_INVALID_PARAMETERS : event_context is NULL.
  • NRS_ERROR_EVENT_NO_HANDLERS : no handlers registered for this event type.
  • NRS_ERROR_FAILED : internal error.