DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::ICanvas Class Referenceabstract

Abstract interface for a canvas represented by a rectangular array of tiles. More...

#include <icanvas.h>

Inheritance diagram for mi::neuraylib::ICanvas:

Public Member Functions

virtual const ITileget_tile (Uint32 layer=0) const =0
 Returns the tile for the given layer. More...
 
virtual ITileget_tile (Uint32 layer=0)=0
 Returns the tile for the given layer. More...
 
- Public Member Functions inherited from mi::neuraylib::ICanvas_base
virtual Uint32 get_resolution_x () const =0
 Returns the resolution of the canvas in x direction. More...
 
virtual Uint32 get_resolution_y () const =0
 Returns the resolution of the canvas in y direction. More...
 
virtual const char * get_type () const =0
 Returns the pixel type used by the canvas. More...
 
virtual Uint32 get_layers_size () const =0
 Returns the number of layers this canvas has. More...
 
virtual Float32 get_gamma () const =0
 Returns the gamma value. More...
 
virtual void set_gamma (Float32 gamma)=0
 Sets the gamma value. 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 IInterfaceget_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 IInterfaceget_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< 0x20e5d5de, ... >
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< 0x649fc7bd, ... >
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< 0x20e5d5de, ... >
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< 0x649fc7bd, ... >
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 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

Member Function Documentation

 get_tile() [1/2]

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

Returns the tile for the given layer.

Parameters
layerThe layer of the pixel in the canvas.
Returns
The tile that contains the pixel, or NULL in case of invalid parameters.

 get_tile() [2/2]

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

Returns the tile for the given layer.

Parameters
layerThe layer of the pixel in the canvas.
Returns
The tile that contains the pixel, or NULL in case of invalid parameters.