Image Class Reference
Encapsulates a raw image buffer and relevant properties. More...
#include <ignition/rendering/Image.hh>
Public Member Functions | |
| Image ()=default | |
| Default constructor. More... | |
| Image (unsigned int _width, unsigned int _height, PixelFormat _format) | |
| Constructor. More... | |
| ~Image () | |
| Deconstructor. More... | |
| const void * | Data () const |
| Get a const pointer to image data. More... | |
| void * | Data () |
| Get a pointer to image data. More... | |
| template<typename T > | |
| const T * | Data () const |
| Get a const pointer to image data. The returned image buffer will be statically cast to the given template type T. More... | |
| template<typename T > | |
| T * | Data () |
| Get a pointer to image data. The returned image buffer will be statically cast to the given template type T. More... | |
| unsigned int | Depth () const |
| Get image channel depth. More... | |
| PixelFormat | Format () const |
| Get image pixel format. More... | |
| unsigned int | Height () const |
| Get image height in pixels. More... | |
| unsigned int | MemorySize () const |
| Get image channel depth. More... | |
| unsigned int | Width () const |
| Get image width in pixels. More... | |
Detailed Description
Encapsulates a raw image buffer and relevant properties.
Constructor & Destructor Documentation
◆ Image() [1/2]
|
default |
Default constructor.
◆ Image() [2/2]
| Image | ( | unsigned int | _width, |
| unsigned int | _height, | ||
| PixelFormat | _format | ||
| ) |
◆ ~Image()
| ~Image | ( | ) |
Deconstructor.
Member Function Documentation
◆ Data() [1/4]
| const void* Data | ( | ) | const |
Get a const pointer to image data.
- Returns
- The const pointer to image data
◆ Data() [2/4]
| void* Data | ( | ) |
Get a pointer to image data.
- Returns
- The pointer to image data
◆ Data() [3/4]
| const T * Data | ( | ) | const |
Get a const pointer to image data. The returned image buffer will be statically cast to the given template type T.
- Returns
- The const pointer to image data
References shared_ptr::get().
◆ Data() [4/4]
| T * Data | ( | ) |
Get a pointer to image data. The returned image buffer will be statically cast to the given template type T.
- Returns
- The pointer to image data
References shared_ptr::get().
◆ Depth()
| unsigned int Depth | ( | ) | const |
Get image channel depth.
- Returns
- The image channel depth
◆ Format()
| PixelFormat Format | ( | ) | const |
Get image pixel format.
- Returns
- The image pixel format
◆ Height()
| unsigned int Height | ( | ) | const |
Get image height in pixels.
- Returns
- The image height in pixels
◆ MemorySize()
| unsigned int MemorySize | ( | ) | const |
Get image channel depth.
- Returns
- The image channel depth
◆ Width()
| unsigned int Width | ( | ) | const |
Get image width in pixels.
- Returns
- The image width in pixels
The documentation for this class was generated from the following file: