neuray API Programmer's Manual

mi::neuraylib::IRender_target_opengl Class Reference

[Rendering and Picking]

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.

mi::base::Interface_declare\< ..., neuraylib::IRender_target_base \>Mixin class template for deriving new interface declarations. Abstract interface for a render target (base class).Abstract interface for a render target (base class). mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

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

Member Functions

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.