mi::neuraylib::ICanvas_parameters Class Reference
[Rendering and Picking]
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.
Public Member Functions
- virtual const IData* get_parameter( Canvas_parameter param) const =0
- Returns a parameter of the current canvas. More...
- template< typename T>const base::Handle < T > get_parameter( const Canvas_parameter param) const
- Returns a parameter of the current canvas.
- virtual Canvas_type get_type() const =0
- Returns the type of the given canvas. More...
Member Functions
- 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.
-
template< typename T>
const base::Handle < T > mi::neuraylib::ICanvas_parameters::get_parameter( const Canvas_parameter param) const [inline] -
Returns a parameter of the current canvas.
- 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.