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

Abstract interface for a render target which is specialized for rendering to an OpenGL buffer. More...

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

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x1d4f071e, 0x93b3, 0x4fc8, 0x80, 0x7a, 0xda, 0xf7, 0xfd, 0x73, 0x3a, 0x6b, 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< 0x1d4f071e, 0x93b3, 0x4fc8, 0x80, 0x7a, 0xda, 0xf7, 0xfd, 0x73, 0x3a, 0x6b, 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 which is specialized for rendering to an OpenGL buffer.

The following restrictions apply:

  • Not all render modes need to support such a render target. If a render mode does not support this type of render target rendering will fail.
  • A render mode which supports this render target may restrict support to only render the "result" canvas.

Member Function Documentation

virtual const ICanvas_opengl* mi::neuraylib::IRender_target_opengl::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_opengl* mi::neuraylib::IRender_target_opengl::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.