neuray API Programmer's Manual

mi::neuraylib::ICanvas_base Class Reference

[Mi_neuray_mdl_sdk_misc]

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

mi::base::Interface_declare\< ..., neuraylib::ICanvas_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< 0x211963f4, 0x31c1, 0x4583, 0x81, 0x4b, 0x5, 0x24, 0x69, 0xa8, 0xc, 0x27, neuraylib::ICanvas_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< ..., neuraylib::ICanvas_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface. Abstract interface for a canvas represented by a rectangular array of tiles.Abstract interface for a canvas represented by a rectangular array of tiles. Abstract interface for a canvas with CUDA device memory storage.Abstract interface for a canvas with CUDA device memory storage. Abstract interface for a canvas that represents an OpenGL buffer.Abstract interface for a canvas that represents an OpenGL buffer.

Public Member Functions

virtual Float32 get_gamma() const =0
Returns the gamma value. More...
virtual Uint32 get_layers_size() const =0
Returns the number of layers this canvas has.
virtual Uint32 get_resolution_x() const =0
Returns the resolution of the canvas in x direction.
virtual Uint32 get_resolution_y() const =0
Returns the resolution of the canvas in y direction.
virtual const char* get_type() const =0
Returns the pixel type used by the canvas. More...
virtual void set_gamma( Float32 gamma) =0
Sets the gamma value. More...

Member Functions

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.

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. The alpha channel (if present) is always linear.

Note:

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