neuray API Programmer's Manual

mi::neuraylib::ICanvas Class Reference

[Mi_neuray_mdl_sdk_misc]

Description

Abstract interface for a canvas represented by a rectangular array of tiles. A canvas represents a two- or three-dimensional array of pixels. The size of this array is given by mi::neuraylib::ICanvas_base::get_resolution_x() and mi::neuraylib::ICanvas_base::get_resolution_y().

Optionally, there can be multiple layers. The number of these layers is given by mi::neuraylib::ICanvas_base::get_layers_size(). The format a layer, i.e., the type of each pixel in that layer, is described by mi::neuraylib::ICanvas_base::get_type().

See also:

mi::neuraylib::ICanvas_base

mi::base::Interface_declare\< ..., neuraylib::ICanvas_base \>Mixin class template for deriving new interface declarations. Abstract interface for a canvas (base class).Abstract interface for a canvas (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 ITile* get_tile( Uint32 layer = 0) const =0
Returns the tile for the given layer. More...
virtual ITile* get_tile( Uint32 layer = 0) =0
Returns the tile for the given layer. More...

Member Functions

virtual const ITile* mi::​neuraylib::​ICanvas::get_tile( Uint32 layer = 0) const [pure virtual]

Returns the tile for the given layer.

Parameters

layer
The layer of the pixel in the canvas.

Returns

The tile that contains the pixel, or NULL in case of invalid parameters.

virtual ITile* mi::​neuraylib::​ICanvas::get_tile( Uint32 layer = 0) [pure virtual]

Returns the tile for the given layer.

Parameters

layer
The layer of the pixel in the canvas.

Returns

The tile that contains the pixel, or NULL in case of invalid parameters.