Public Member Functions | Private Member Functions | Private Attributes
rcg::Image Class Reference

The image class encapsulates image information. More...

#include <image.h>

List of all members.

Public Member Functions

uint64_t getFrameID () const
size_t getHeight () const
uint64_t getPixelFormat () const
const uint8_t * getPixels () const
 Pointer to pixel information of the image.
uint64_t getTimestampNS () const
size_t getWidth () const
size_t getXOffset () const
size_t getXPadding () const
size_t getYOffset () const
size_t getYPadding () const
 Image (const Buffer *buffer, std::uint32_t part)
 Copies the image information of the buffer.
bool isBigEndian () const

Private Member Functions

 Image (class Image &)
Imageoperator= (const Image &)

Private Attributes

bool bigendian
uint64_t frameid
size_t height
std::unique_ptr< uint8_t[]> pixel
uint64_t pixelformat
uint64_t timestamp
size_t width
size_t xoffset
size_t xpadding
size_t yoffset
size_t ypadding

Detailed Description

The image class encapsulates image information.

It can be created from a buffer or a buffer part in case of a mult part buffer and provides a part of its information. It can be used to temporarily store the image so that the buffer can be freed.

NOTE: A GenTLException is thrown in case of a severe error.

Definition at line 55 of file image.h.

Constructor & Destructor Documentation

Image::Image ( const Buffer buffer,
std::uint32_t  part 

Copies the image information of the buffer.

bufferBuffer object to copy the data from.
partPart number from which the image should be created.

Definition at line 46 of file

rcg::Image::Image ( class Image ) [private]

Member Function Documentation

uint64_t rcg::Image::getFrameID ( ) const [inline]

Definition at line 84 of file image.h.

size_t rcg::Image::getHeight ( ) const [inline]

Definition at line 79 of file image.h.

uint64_t rcg::Image::getPixelFormat ( ) const [inline]

Definition at line 85 of file image.h.

const uint8_t* rcg::Image::getPixels ( ) const [inline]

Pointer to pixel information of the image.

Pointer to pixels.

Definition at line 74 of file image.h.

uint64_t rcg::Image::getTimestampNS ( ) const [inline]

Definition at line 76 of file image.h.

size_t rcg::Image::getWidth ( ) const [inline]

Definition at line 78 of file image.h.

size_t rcg::Image::getXOffset ( ) const [inline]

Definition at line 80 of file image.h.

size_t rcg::Image::getXPadding ( ) const [inline]

Definition at line 82 of file image.h.

size_t rcg::Image::getYOffset ( ) const [inline]

Definition at line 81 of file image.h.

size_t rcg::Image::getYPadding ( ) const [inline]

Definition at line 83 of file image.h.

bool rcg::Image::isBigEndian ( ) const [inline]

Definition at line 86 of file image.h.

Image& rcg::Image::operator= ( const Image ) [private]

Member Data Documentation

bool rcg::Image::bigendian [private]

Definition at line 104 of file image.h.

uint64_t rcg::Image::frameid [private]

Definition at line 102 of file image.h.

size_t rcg::Image::height [private]

Definition at line 97 of file image.h.

std::unique_ptr<uint8_t []> rcg::Image::pixel [private]

Definition at line 93 of file image.h.

uint64_t rcg::Image::pixelformat [private]

Definition at line 103 of file image.h.

uint64_t rcg::Image::timestamp [private]

Definition at line 95 of file image.h.

size_t rcg::Image::width [private]

Definition at line 96 of file image.h.

size_t rcg::Image::xoffset [private]

Definition at line 98 of file image.h.

size_t rcg::Image::xpadding [private]

Definition at line 100 of file image.h.

size_t rcg::Image::yoffset [private]

Definition at line 99 of file image.h.

size_t rcg::Image::ypadding [private]

Definition at line 101 of file image.h.

The documentation for this class was generated from the following files:

Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 18:42:49