NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::ICanvas_base Class Referenceabstract

Abstract interface for a canvas (base class). More...

Inheritance diagram for mi::neuraylib::ICanvas_base:
Inheritance graph
[legend]

Public Member Functions

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...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x649fc7bd, 0xc021, 0x4aff, 0x9e, 0xa4, 0x5b, 0xab, 0x18, 0xb9, 0x25, 0x59 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x649fc7bd, 0xc021, 0x4aff, 0x9e, 0xa4, 0x5b, 0xab, 0x18, 0xb9, 0x25, 0x59 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Abstract interface for a canvas (base class).

This interface is the base class for all canvases. It holds the common functionality of all different canvas interfaces, i.e., the resolution of the canvas.

See Also
mi::neuraylib::ICanvas

Member Function Documentation

virtual Uint32 mi::neuraylib::ICanvas_base::get_resolution_x ( ) const
pure virtual

Returns the resolution of the canvas in x direction.

virtual Uint32 mi::neuraylib::ICanvas_base::get_resolution_y ( ) const
pure virtual

Returns the resolution of the canvas in y direction.

virtual const char* mi::neuraylib::ICanvas_base::get_type ( ) const
pure virtual

Returns the pixel type used by the canvas.

See Also
Types for a list of supported pixel types