NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IRender_target_base Class Referenceabstract

Abstract interface for a render target. More...

Inheritance diagram for mi::neuraylib::IRender_target_base:
Inheritance graph
[legend]

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

Detailed Description

Abstract interface for a render target.

This interface is the base class for usable render targets. An instance of this interface is passed to the mi::neuraylib::IRender_context::render() or mi::neuraylib::IRender_context::render_async() calls.

Member Function Documentation

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.