mi::neuraylib::ICanvas_base Class Reference

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

#include <icanvas.h>

Inheritance diagram for mi::neuraylib::ICanvas_base:

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...
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 IInterface *	get_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 IInterface *	get_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< 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< 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 (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

get_gamma()

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.

The alpha channel (if present) is always linear.

get_layers_size()

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

pure virtual

Returns the number of layers this canvas has.

get_resolution_x()

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

pure virtual

Returns the resolution of the canvas in x direction.

get_resolution_y()

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

pure virtual

Returns the resolution of the canvas in y direction.

get_type()

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

set_gamma()

virtual void mi::neuraylib::ICanvas_base::set_gamma ( Float32  gamma )

pure virtual

Sets the gamma value.

The alpha channel (if present) is always linear.

Note

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