Material Definition Language API nvidia_logo_transpbg.gif 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:
mi::base::Interface_declare< 0x649fc7bd, 0xc021, 0x4aff, 0x9e, 0xa4, 0x5b, 0xab, 0x18, 0xb9, 0x25, 0x59 > mi::base::IInterface mi::base::Interface_declare< 0x20e5d5de, 0x1f61, 0x441c, 0x88, 0x88, 0xff, 0x85, 0x89, 0x98, 0x7a, 0xfa, neuraylib::ICanvas_base > mi::neuraylib::ICanvas

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

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 Float32 mi::neuraylib::ICanvas_base::get_gamma ( ) const
pure virtual

Returns the gamma value.

The gamma value should be a positive number. Typical values are 2.2 for LDR pixel types, and 1.0 for HDR pixel types.

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

Returns the number of layers this canvas has.

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
virtual void mi::neuraylib::ICanvas_base::set_gamma ( Float32  gamma)
pure virtual

Sets the gamma value.

Note
This method just sets the gamma value. It does not change the pixel data itself.