Abstract interface for a render target (base class). More...
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... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0x8aafab6e, 0x57d9, 0x4816, 0x87, 0xfe, 0x9f, 0x97, 0x9b, 0xc9, 0xc2, 0xbf >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
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< 0x8aafab6e, 0x57d9, 0x4816, 0x87, 0xfe, 0x9f, 0x97, 0x9b, 0xc9, 0xc2, 0xbf >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
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 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.
|
pure virtual |
Returns the number of canvases to render to.
|
pure virtual |
Returns the name of the given canvas.
| index | The index of the requested canvas. Use get_canvas_count() to inquire the the number of canvases. |
