mi::neuraylib::IRender_target_opengl Class Reference

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

#include <irender_target_opengl.h>

Inheritance diagram for mi::neuraylib::IRender_target_opengl:

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...
Public Member Functions inherited from mi::neuraylib::IRender_target_base
virtual Uint32	get_canvas_count () const =0
	Returns the number of canvases to render to. More...
virtual Canvas_type	get_canvas_type (Uint32 index) const =0
	Returns the type of the given canvas. More...
virtual const ICanvas_base *	get_canvas (Uint32 index) const =0
	Returns a canvas by index. More...
virtual ICanvas_base *	get_canvas (Uint32 index)=0
	Returns a canvas by index. More...
virtual const ICanvas_parameters *	get_canvas_parameters (Uint32 index) const =0
	Returns a set of parameters of the given canvas. More...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x1d4f071e, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::Interface_declare< 0x8aafab6e, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x1d4f071e, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x8aafab6e, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. 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

get_canvas() [1/2]

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.

Implements mi::neuraylib::IRender_target_base.

get_canvas() [2/2]

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.

Implements mi::neuraylib::IRender_target_base.