Abstract interface for a render target. More...

Inheritance diagram for mi::neuraylib::IRender_target:

[legend]

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

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0xd4dff23d, 0x9b42, 0x48d4, 0x80, 0x01, 0x8c, 0x9a, 0x13, 0x51, 0x83, 0x69, neuraylib::IRender_target_base >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, neuraylib::IRender_target_base >	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< 0xd4dff23d, 0x9b42, 0x48d4, 0x80, 0x01, 0x8c, 0x9a, 0x13, 0x51, 0x83, 0x69, neuraylib::IRender_target_base >
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 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()

Member Function Documentation

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)