mi::neuraylib::ICanvas_parameters Class Reference

Abstract interface for render target canvas parameters. More...

#include <irender_target.h>

Inheritance diagram for mi::neuraylib::ICanvas_parameters:

Public Member Functions
virtual Canvas_type	get_type () const =0
	Returns the type of the given canvas. More...
virtual const IData *	get_parameter (Canvas_parameter param) const =0
	Returns a parameter of the current canvas. More...
template<typename T>
base::Handle<const T>	get_parameter (const Canvas_parameter param) const
	Returns a parameter of the current 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< 0x8aafab6f, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x8aafab6f, ... >
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 render target canvas parameters.

This interface holds a set of (potentially null) parameters which control how canvases of a mi::neuraylib::IRender_target_base should be handled.

Member Function Documentation

get_parameter() [1/2]

virtual const IData * mi::neuraylib::ICanvas_parameters::get_parameter ( Canvas_parameter  param ) const

pure virtual

Returns a parameter of the current canvas.

This function is used to query additional parameters associated with render target canvases. If a canvas does not support the desired parameter, the parameter is not set, or the canvas index is out of bounds, this function returns nullptr.

Parameters

param

The requested parameter.

Returns

The parameter as described above.

get_parameter() [2/2]

template<typename T>

base::Handle<const T> mi::neuraylib::ICanvas_parameters::get_parameter ( const Canvas_parameter  param ) const

inline

Returns a parameter of the current canvas.

get_type()

virtual Canvas_type mi::neuraylib::ICanvas_parameters::get_type ( ) const

pure virtual

Returns the type of the given canvas.

Returns

The type of the canvas.