neuray API Programmer's Manual

mi::neuraylib::IRender_target_base Class Reference

[Rendering and Picking]

Description

Abstract interface for a render target (base class). This interface is the base class all render targets.

The render target holds an array of canvases. Each such canvas represents a layer in a framebuffer, e.g., one of them could be used to store the rendered color, another one for the z-buffer, and so on. Each of them can be tiled or not tiled.

A render mode can inquire the number of canvases passed in and the names of those. The names are used to find out the meaning of the canvas, e.g., "result" indicates the final image. The known canvas names and their corresponding pixel types are documented in Section [:ipmlink canvas_names_in_render_targets Canvas names in render targets] of the Iray Programmer's Manual.

Note that it is not guaranteed that all canvases have the same dimensions, though not all render modes have to support this.

See also:

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

Public Member Functions

virtual Uint32 get_canvas_count() const =0
Returns the number of canvases to render to. More...
virtual const char* get_canvas_name( Uint32 index) const =0
Returns the name of the given canvas. More...

Member Functions

virtual Uint32 mi::​neuraylib::​IRender_target_base::get_canvas_count() const [pure virtual]

Returns the number of canvases to render to.

Returns

The number

virtual const char* mi::​neuraylib::​IRender_target_base::get_canvas_name( Uint32 index) const [pure virtual]

Returns the name of the given canvas.

Parameters

index
The index of the requested canvas. Use get_canvas_count() to inquire the the number of canvases.

Returns

The name of the canvas.