neuray API Programmer's Manual

mi::neuraylib::IRender_target Class Reference

[Rendering and Picking]

Description

Abstract interface for a render target. The mi::neuraylib::IRender_target, mi::neuraylib::ICanvas, and mi::neuraylib::ITile classes are abstract interfaces which can to be implemented by the application. For example, this gives the application the ability to tailor the rendering process very specific to its needs. The render target has to be implemented by the application whereas default implementations for canvases and tiles are available from mi::neuraylib::IImage_api.

See also:

mi::neuraylib::IRender_target_base, mi::neuraylib::IRender_context::render(), mi::neuraylib::IRender_context::render_async()

mi::base::Interface_declare\< ..., neuraylib::IRender_target_base \>Mixin class template for deriving new interface declarations. Abstract interface for a render target (base class).Abstract interface for a render target (base class). mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual const ICanvas* get_canvas( Uint32 index) const =0
Returns a canvas by index. More...
virtual ICanvas* get_canvas( Uint32 index) =0
Returns a canvas by index. More...

Member Functions

virtual const ICanvas* mi::​neuraylib::​IRender_target::get_canvas( Uint32 index) const [pure virtual]

Returns a canvas by index.

Parameters

index
The index of the requested canvas. Use mi::neuraylib::IRender_target_base::get_canvas_count() to inquire the number of canvases.

Returns

The requested canvas, or NULL if index is out of bounds.

virtual ICanvas* mi::​neuraylib::​IRender_target::get_canvas( Uint32 index) [pure virtual]

Returns a canvas by index.

Parameters

index
The index of the requested canvas. Use mi::neuraylib::IRender_target_base::get_canvas_count() to inquire the number of canvases.

Returns

The requested canvas, or NULL if index is out of bounds.