Abstract interface for image files.
More...
#include <iimage_plugin.h>
|
| typedef Interface_declare< id1, ... > | Self |
| | Own type. More...
|
| |
| typedef Uuid_t< id1, ... > | IID |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| 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 bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
| |
| static bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface. More...
|
| |
◆ get_gamma()
| virtual Float32 mi::neuraylib::IImage_file::get_gamma |
( |
| ) |
const |
|
pure virtual |
Returns the gamma value of the image.
◆ get_is_cubemap()
| virtual bool mi::neuraylib::IImage_file::get_is_cubemap |
( |
| ) |
const |
|
pure virtual |
Indicates whether the image represents a cubemap.
- Returns
if the image represents a cubemap, false otherwise.
◆ get_layers_size()
| virtual Uint32 mi::neuraylib::IImage_file::get_layers_size |
( |
Uint32 |
level | ) |
const |
|
pure virtual |
Returns the number of layers of the image.
- Parameters
-
| level | The mipmap level (always 0 if the image is not a mipmap). |
- Returns
- The number of layers of the image.
◆ get_miplevels()
| virtual Uint32 mi::neuraylib::IImage_file::get_miplevels |
( |
| ) |
const |
|
pure virtual |
Returns number of miplevels.
◆ get_resolution_x()
| virtual Uint32 mi::neuraylib::IImage_file::get_resolution_x |
( |
Uint32 |
level | ) |
const |
|
pure virtual |
Returns the resolution of the image in x direction.
- Parameters
-
| level | The mipmap level (always 0 if the image is not a mipmap). |
- Returns
- The resolution of the image in x direction.
◆ get_resolution_y()
| virtual Uint32 mi::neuraylib::IImage_file::get_resolution_y |
( |
Uint32 |
level | ) |
const |
|
pure virtual |
Returns the resolution of the image in y direction.
- Parameters
-
| level | The mipmap level (always 0 if the image is not a mipmap). |
- Returns
- The resolution of the image in y direction.
◆ get_type()
| virtual const char * mi::neuraylib::IImage_file::get_type |
( |
| ) |
const |
|
pure virtual |
Returns the pixel type of the image (or the requested channel).
See Types for a list of supported pixel types.
◆ read()
Read pixels from the image file into a tile.
This method will never be called if this instance was obtained from mi::neuraylib::IImage_plugin::open_for_writing().
- Parameters
-
| z | The z layer (for 3d textures or cubemaps). |
| level | The mipmap level (always 0 if the image is not a mipmap). |
- Returns
- The tile with the read data, or
NULL in case of failures.
◆ write()
| virtual bool mi::neuraylib::IImage_file::write |
( |
const ITile * |
tile, |
|
|
Uint32 |
z, |
|
|
Uint32 |
level |
|
) |
| |
|
pure virtual |
Write pixels from a tile into the image file.
This method will never be called if this instance was obtained from mi::neuraylib::IImage_plugin::open_for_reading().
- Parameters
-
| tile | The tile to read the data from. |
| z | The z layer (for 3d textures or cubemaps). |
| level | The mipmap level (always 0 if the image is not a mipmap). |
- Returns
true if the tile was successfully written, false otherwise.
Public Member Functions inherited from mi::base::IInterface