Gazebo Rendering

API Reference

7.4.2

Encapsulates a raw image buffer and relevant properties. More...

#include <gz/rendering/Image.hh>

Public Member Functions

 Image ()=default
 Default constructor. More...
 
 Image (unsigned int _width, unsigned int _height, PixelFormat _format)
 Constructor. More...
 
 ~Image ()
 Destructor. More...
 
void * Data ()
 Get a pointer to image data. 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...
 
const void * Data () const
 Get a const 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...
 
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]

Image ( )
default

Default constructor.

◆ Image() [2/2]

Image ( unsigned int  _width,
unsigned int  _height,
PixelFormat  _format 
)

Constructor.

Parameters
[in]_widthImage width in pixels
[in]_heightImage height in pixels
[in]_formatImage pixel format

◆ ~Image()

~Image ( )

Destructor.

Member Function Documentation

◆ Data() [1/4]

void* Data ( )

Get a pointer to image data.

Returns
The pointer to image data

◆ Data() [2/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< T >::get().

◆ Data() [3/4]

const void* Data ( ) const

Get a const pointer to image data.

Returns
The const pointer to image data

◆ Data() [4/4]

const T * Data

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< T >::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: