neuray Services API Programmer's Manual

mi::nservices::IRender_loop_render_counter_callback Class Reference

[Render Loops]

Description

Abstract interface to report when the render loop has reached a specific counter. This can be used to simply trigger a callback at a specific counter and get the render from the loop at that counter.

These callbacks are typically used to retrieve an image that will have previously committed changes applied to it. After editing a scene and commiting the transaction an instance of this interface would be registered with the render loop with a counter_value of 0. The image provided in canvas is guaranteed to have the changes from the transaction.

Public Member Functions

virtual void complete( mi::neuraylib::ICanvas* canvas, mi::Sint32 render_result) =0
This is called when the callback is ready. More...

Member Functions

virtual void mi::​nservices::​IRender_loop_render_counter_callback::complete( mi::neuraylib::ICanvas* canvas, mi::Sint32 render_result) [pure virtual]

This is called when the callback is ready.

Parameters

canvas
a canvas containing the encoded image. This will be NULL if render_result indicates an error.
render_result
the result of the render that generated canvas. This is always supplied even if canvas is NULL.