This interface represents a pixel image file. More...
Public Member Functions | |
| virtual Sint32 | reset_file (const char *filename)=0 |
Sets the image to a file identified by filename. More... | |
| virtual Sint32 | reset_reader (IReader *reader, const char *image_format)=0 |
| Sets the image to the data provided by a reader. More... | |
| virtual Sint32 | reset_reader (IArray *reader, const char *image_format)=0 |
| Sets the image to the uv-tile data provided by an array of readers. More... | |
| virtual const char * | get_filename (Uint32 uvtile_id=0) const =0 |
| Returns the resolved file name of the file containing the image. More... | |
| virtual const char * | get_original_filename () const =0 |
| Returns the unresolved file as passed to reset_file(). More... | |
| virtual bool | set_from_canvas (const ICanvas *canvas)=0 |
| Sets the pixels of this image based on the passed canvas (without sharing). More... | |
| virtual bool | set_from_canvas (ICanvas *canvas, bool shared=false)=0 |
| Sets the pixels of this image based on the passed canvas (possibly sharing the pixel data). More... | |
| virtual bool | set_from_canvas (const IArray *uvtiles)=0 |
| Sets the pixels of the uv-tiles of this image based on the passed canvases (without sharing). More... | |
| virtual bool | set_from_canvas (IArray *uvtiles, bool shared=false)=0 |
| Sets the pixels of the uv-tiles of this image based on the passed canvases (possibly sharing the pixel data). More... | |
| virtual const ICanvas * | get_canvas (Uint32 level=0, Uint32 uvtile_id=0) const =0 |
| Returns a canvas with the pixel data of the image. More... | |
| virtual const char * | get_type (Uint32 uvtile_id=0) const =0 |
| Returns the pixel type of the image. More... | |
| virtual Uint32 | get_levels (Uint32 uvtile_id=0) const =0 |
| Returns the number of levels in the mipmap pyramid. More... | |
| virtual Uint32 | resolution_x (Uint32 level=0, Uint32 uvtile_id=0) const =0 |
| Returns the horizontal resolution of the image. More... | |
| virtual Uint32 | resolution_y (Uint32 level=0, Uint32 uvtile_id=0) const =0 |
| Returns the vertical resolution of the image. More... | |
| virtual Uint32 | resolution_z (Uint32 level=0, Uint32 uvtile_id=0) const =0 |
| Returns the number of layers of the 3D image. More... | |
| virtual Size | get_uvtile_length () const =0 |
| Returns the number of uv-tiles of the image. More... | |
| virtual Sint32 | get_uvtile_uv (Uint32 uvtile_id, Sint32 &u, Sint32 &v) const =0 |
| Returns the u and v tile indices of the uv-tile at the given index. More... | |
| virtual Uint32 | get_uvtile_id (Sint32 u, Sint32 v) const =0 |
| Returns the uvtile-id corresponding to the tile at u,v. More... | |
| virtual bool | is_uvtile () const =0 |
Returns true if this image represents a uvtile/udim image sequence. More... | |
| virtual void | get_uvtile_uv_ranges (Sint32 &min_u, Sint32 &min_v, Sint32 &max_u, Sint32 &max_v) const =0 |
Returns the ranges of u and v coordinates (or all values zero if is_uvtile() returns false). More... | |
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0xca59b977, 0x30ee, 0x4172, 0x91, 0x53, 0xb7, 0x70, 0x2c, 0x6b, 0x3a, 0x76, neuraylib::IScene_element > | |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, neuraylib::IScene_element > | 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< 0xca59b977, 0x30ee, 0x4172, 0x91, 0x53, 0xb7, 0x70, 0x2c, 0x6b, 0x3a, 0x76, neuraylib::IScene_element > | |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... | |
This interface represents a pixel image file.
It supports different pixel types, 2D and 3D image data, and mipmap levels. Its main usage is in textures, see the mi::neuraylib::ITexture class.
The image coordinate system has its origin in the lower left corner in the case of 2D image data.
Note that editing an existing image has unusual semantics that differ from all other DB elements. Usually, when editing a database element, an identical copy of the database element is created (the existing one cannot be used because it might be needed for other transactions, other scopes, or in case the transaction is aborted). For images, this implies a copy of all the pixel data which is very expensive.
There are only two mutable methods on this interface, reset_file() and set_from_canvas(); all other methods are const. Both methods eventually replace the entire pixel data anyway. Therefore, when an image is edited, the pixel data is not copied, but replaced by a dummy image of size 1x1. This approach saves the unneeded, but expensive copy of the original pixel data. When afterwards one of two methods above is called, the image uses the correct pixel data again.
Note that this also affects the results from methods like resolution_x(), etc. (if you want to know the resolution of an existing image without changing it, you should access the image, not edit it). Furthermore, you might end up with the dummy image if you do not call reset_file() or set_from_canvas() (or if these methods fail).
Note that using the transaction's copy function has the same semantics when used on an image. Thus after copying it is necessary to use either reset_file() or set_from_canvas() on the copy.
|
pure virtual |
Returns a canvas with the pixel data of the image.
Note that it is not possible to manipulate the pixel data.
| level | The desired mipmap level. Level 0 is the highest resolution. |
| uvtile_id | The uv-tile id of the canvas. |
NULL in case of failure, e.g. because of an invalid tile id.
|
pure virtual |
Returns the resolved file name of the file containing the image.
The method returns NULL if there is no file associated with the image, e.g., after default construction, calls to set_from_canvas(), or failures to resolve the file name passed to reset_file().
Returns the number of levels in the mipmap pyramid.
| uvtile_id | The uv-tile id of the canvas to get the number of levels for. |
|
pure virtual |
Returns the unresolved file as passed to reset_file().
The method returns NULL after default construction or calls to set_from_canvas().
|
pure virtual |
Returns the pixel type of the image.
| uvtile_id | The uv-tile id of the canvas to get the pixel type for. |
Returns the uvtile-id corresponding to the tile at u,v.
| u | The u-component of the uv-tile |
| v | The v-component of the uv-tile |
|
pure virtual |
Returns the number of uv-tiles of the image.
|
pure virtual |
Returns the u and v tile indices of the uv-tile at the given index.
| uvtile_id | The uv-tile id of the canvas. |
| u | The u-component of the uv-tile |
| v | The v-component of the uv-tile |
|
pure virtual |
Returns the ranges of u and v coordinates (or all values zero if is_uvtile() returns false).
|
pure virtual |
Returns true if this image represents a uvtile/udim image sequence.
|
pure virtual |
Sets the image to a file identified by filename.
Note that support for a given image format requires an image plugin capable of handling that format.
The filename can include one of the following three uv-tileset markers in the filename: <UDIM>, <UVTILE0>, or <UVTILE1>. The image refers then to a whole uv-tileset, a set of images used together as a single large two-dimensional image. The different markers indicate the different filename conventions that encode where each image file is placed in the uv texture space.
| Marker | Pattern | (0,0) index | Convention to format a (u, v)-index |
|---|---|---|---|
| <UDIM> | DDDD | 1001 | UDIM, expands to the four digit number 1000+(u+1+v∗10) |
| <UVTILE0> | "_u"I"_v"I | _u0_v0 | 0-based uv-tileset, expands to "_u"u"_v"v |
| <UVTILE1> | "_u"I"_v"I | _u1_v1 | 1-based uv-tileset, expands to "_u"(u+1)"_v"(v+1) |
NULL pointer).
|
pure virtual |
Sets the image to the data provided by a reader.
| reader | The reader that provides the data for the image. The reader needs to support absolute access. |
| image_format | The image format of the data, e.g., "jpg". Note that support for a given image format requires an image plugin capable of handling that format. |
NULL pointer).
|
pure virtual |
Sets the image to the uv-tile data provided by an array of readers.
| reader | A static or dynamic array of structures of type Uvtile_reader. Such a structure has the following members:
|
| image_format | The image format of the data, e.g., "jpg". Note that support for a given image format requires an image plugin capable of handling that format. |
NULL pointer).
|
pure virtual |
Returns the horizontal resolution of the image.
| level | The desired mipmap level. Level 0 is the highest resolution. |
| uvtile_id | The uv-tile id of the canvas to get the resolution for. |
|
pure virtual |
Returns the vertical resolution of the image.
| level | The desired mipmap level. Level 0 is the highest resolution. |
| uvtile_id | The uv-tile id of the canvas to get the resolution for. |
|
pure virtual |
Returns the number of layers of the 3D image.
| level | The desired mipmap level. Level 0 is the highest resolution. |
| uvtile_id | The uv-tile id of the canvas to get the resolution for. |
|
pure virtual |
Sets the pixels of this image based on the passed canvas (without sharing).
| canvas | The pixel data to be used by this image. Note that the pixel data is copied, not shared. If sharing is intended use mi::neuraylib::IImage::set_from_canvas(mi::neuraylib::ICanvas*,bool) instead. |
true if the pixel data of this image has been set correctly, and false otherwise.
|
pure virtual |
Sets the pixels of this image based on the passed canvas (possibly sharing the pixel data).
| canvas | The pixel data to be used by this image. |
| shared | If false (the default), the pixel data is copied from canvas and the method does the same as mi::neuraylib::IImage::set_from_canvas(const mi::neuraylib::ICanvas*). If set to true, the image uses the canvas directly (doing reference counting on the canvas pointer). You must not modify the canvas content after this call. |
true if the pixel data of this image has been set correctly, and false otherwise.
|
pure virtual |
Sets the pixels of the uv-tiles of this image based on the passed canvases (without sharing).
| uvtiles | A static or dynamic array of structures of type Uvtile. Such a structure has the following members:
|
true if the pixel data of this image has been set correctly, and false otherwise.
|
pure virtual |
Sets the pixels of the uv-tiles of this image based on the passed canvases (possibly sharing the pixel data).
| uvtiles | A static or dynamic array of structures of type Uvtile. Such a structure has the following members:
|
| shared | If false (the default), the pixel data is copied from canvas and the method does the same as mi::neuraylib::IImage::set_from_canvas(const mi::neuraylib::ICanvas*). If set to true, the image uses the canvases directly (doing reference counting on the canvas pointers). You must not modify the canvas contents after this call. |
true if the pixel data of this image has been set correctly, and false otherwise.