MDL SDK API nvidia_logo_transpbg.gif Up
iimage_api.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2022 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_IIMAGE_API_H
8#define MI_NEURAYLIB_IIMAGE_API_H
9
11
12namespace mi {
13
14class IArray;
15
16namespace neuraylib {
17
18class IBuffer;
19class ICanvas;
20class ICanvas_cuda;
21class IReader;
22class ITile;
23
47class IImage_api : public
48 mi::base::Interface_declare<0x4c25a4f0,0x2bac,0x4ce6,0xb0,0xab,0x4d,0x94,0xbf,0xfd,0x97,0xa5>
49{
50public:
52
53
69 const char* pixel_type,
70 Uint32 width,
71 Uint32 height) const = 0;
72
92 const char* pixel_type,
93 Uint32 width,
94 Uint32 height,
95 Uint32 layers = 1,
96 bool is_cubemap = false,
97 Float32 gamma = 0.0f) const = 0;
98
99#ifndef MI_SKIP_WITH_MDL_SDK_DOXYGEN
118#endif // MI_SKIP_WITH_MDL_SDK_DOXYGEN
119 virtual ICanvas_cuda* create_canvas_cuda(
120 Sint32 cuda_device_id,
121 const char* pixel_type,
122 Uint32 width,
123 Uint32 height,
124 Uint32 layers = 1,
125 Float32 gamma = 0.0f) const = 0;
126
139 const ICanvas* canvas, Float32 gamma_override = 0.0f) const = 0;
140
142 virtual ITile* clone_tile( const ITile* tile) const = 0;
143
145 virtual ICanvas* clone_canvas( const ICanvas* canvas) const = 0;
146
148
150
177 Uint32 width,
178 Uint32 height,
179 const ICanvas* canvas,
180 Uint32 canvas_x,
181 Uint32 canvas_y,
182 Uint32 canvas_layer,
183 void* buffer,
184 bool buffer_topdown,
185 const char* buffer_pixel_type,
186 Uint32 buffer_padding = 0) const = 0;
187
214 Uint32 width,
215 Uint32 height,
216 ICanvas* canvas,
217 Uint32 canvas_x,
218 Uint32 canvas_y,
219 Uint32 canvas_layer,
220 const void* buffer,
221 bool buffer_topdown,
222 const char* buffer_pixel_type,
223 Uint32 buffer_padding = 0) const = 0;
224
226
228
248 const ICanvas* canvas,
249 const char* image_format,
250 const char* pixel_type,
251 const char* quality,
252 bool force_default_gamma = false) const = 0;
253
262 const IBuffer* buffer, const char* image_format) const = 0;
263
273 IReader* reader, const char* image_format) const = 0;
274
291 const char* image_format, IReader* reader = 0) const = 0;
292
306 virtual bool supports_format_for_encoding( const char* image_format) const = 0;
307
309
311
327 virtual ITile* convert( const ITile* tile, const char* pixel_type) const = 0;
328
364 virtual ICanvas* convert( const ICanvas* canvas, const char* pixel_type) const = 0;
365
375 virtual void adjust_gamma( ITile* tile, Float32 old_gamma, Float32 new_gamma) const = 0;
376
385 virtual void adjust_gamma( ICanvas* canvas, Float32 new_gamma) const = 0;
386
388
390
397 virtual Uint32 get_components_per_pixel( const char* pixel_type) const = 0;
398
405 virtual Uint32 get_bytes_per_component( const char* pixel_type) const = 0;
406
408
410
422 virtual const char* get_pixel_type_for_channel(
423 const char* pixel_type, const char* selector) const = 0;
424
431 virtual ICanvas* extract_channel( const ICanvas* canvas, const char* selector) const = 0;
432
439 virtual ITile* extract_channel( const ITile* tile, const char* selector) const = 0;
440
442
443};
444 // end group mi_neuray_rendering / mi_neuray_rtmp
446
447} // namespace neuraylib
448
449} // namespace mi
450
451#endif // MI_NEURAYLIB_IIMAGE_API_H
This interface represents static arrays, i.e., arrays with a fixed number of elements.
Definition: iarray.h:37
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
Abstract interface for a simple buffer with binary data.
Definition: ibuffer.h:25
Abstract interface for a canvas represented by a rectangular array of tiles.
Definition: icanvas.h:85
This interface provides various utilities related to canvases and buffers.
Definition: iimage_api.h:49
virtual ICanvas * create_canvas_from_buffer(const IBuffer *buffer, const char *image_format) const =0
Decodes the pixel data of a memory buffer into a canvas.
virtual ICanvas * clone_canvas(const ICanvas *canvas) const =0
Creates a (deep) copy of the passed canvas.
virtual ITile * create_tile(const char *pixel_type, Uint32 width, Uint32 height) const =0
Creates a tile with given pixel type, width, and height.
virtual const char * get_pixel_type_for_channel(const char *pixel_type, const char *selector) const =0
Returns the pixel type of an RGBA channel.
virtual ITile * clone_tile(const ITile *tile) const =0
Creates a copy of the passed tile.
virtual ICanvas * create_canvas(const char *pixel_type, Uint32 width, Uint32 height, Uint32 layers=1, bool is_cubemap=false, Float32 gamma=0.0f) const =0
Creates a canvas with given pixel type, resolution, and layers.
virtual ICanvas * create_canvas_from_reader(IReader *reader, const char *image_format) const =0
Decodes the pixel data from a reader into a canvas.
virtual IArray * create_mipmaps(const ICanvas *canvas, Float32 gamma_override=0.0f) const =0
Creates mipmaps from the given canvas.
virtual IBuffer * create_buffer_from_canvas(const ICanvas *canvas, const char *image_format, const char *pixel_type, const char *quality, bool force_default_gamma=false) const =0
Encodes the pixel data of a canvas into a memory buffer.
virtual ITile * extract_channel(const ITile *tile, const char *selector) const =0
Extracts an RGBA channel from a tile.
virtual ICanvas * extract_channel(const ICanvas *canvas, const char *selector) const =0
Extracts an RGBA channel from a canvas.
virtual ITile * convert(const ITile *tile, const char *pixel_type) const =0
Converts a tile to a different pixel type.
virtual bool supports_format_for_encoding(const char *image_format) const =0
Indicates whether a particular image format is supported for encoding.
virtual Sint32 write_raw_pixels(Uint32 width, Uint32 height, ICanvas *canvas, Uint32 canvas_x, Uint32 canvas_y, Uint32 canvas_layer, const void *buffer, bool buffer_topdown, const char *buffer_pixel_type, Uint32 buffer_padding=0) const =0
Writes raw pixel data to a canvas.
virtual ICanvas * convert(const ICanvas *canvas, const char *pixel_type) const =0
Converts a canvas to a different pixel type.
virtual void adjust_gamma(ITile *tile, Float32 old_gamma, Float32 new_gamma) const =0
Sets the gamma value of a tile and adjusts the pixel data accordingly.
virtual Uint32 get_bytes_per_component(const char *pixel_type) const =0
Returns the number of bytes used per pixel component.
virtual Uint32 get_components_per_pixel(const char *pixel_type) const =0
Returns the number of components per pixel type.
virtual Sint32 read_raw_pixels(Uint32 width, Uint32 height, const ICanvas *canvas, Uint32 canvas_x, Uint32 canvas_y, Uint32 canvas_layer, void *buffer, bool buffer_topdown, const char *buffer_pixel_type, Uint32 buffer_padding=0) const =0
Reads raw pixel data from a canvas.
virtual bool supports_format_for_decoding(const char *image_format, IReader *reader=0) const =0
Indicates whether a particular image format is supported for decoding.
virtual void adjust_gamma(ICanvas *canvas, Float32 new_gamma) const =0
Sets the gamma value of a canvas and adjusts the pixel data accordingly.
A reader supports binary block reads and string-oriented line reads that zero-terminate the result.
Definition: ireader.h:27
Abstract interface for a tile.
Definition: itile.h:36
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:47
float Float32
32-bit float.
Definition: types.h:49
signed int Sint32
32-bit signed integer.
Definition: types.h:44
Mixin class template for deriving new interface declarations.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: example_derivatives.dox:5