optris::ImageInfo Class Reference

Encapsulates all relevant information about a false color image. More...

#include <ImageInfo.h>

Collaboration diagram for optris::ImageInfo:

Public Member Functions
OTC_SDK_API	ImageInfo (ColorFormat colorFormat, WidthAlignment widthAlignment) noexcept
	Constructor.
ColorFormat	getColorFormat () const noexcept
	Returns the color format of the image.
int	getChannels () const noexcept
	Returns the number of color channels.
int	getOffsetRed () const noexcept
	Returns the offset of the red color byte.
int	getOffsetGreen () const noexcept
	Returns the offset of the green color byte.
int	getOffsetBlue () const noexcept
	Returns the offset of the blue color byte.
OTC_SDK_API int	resize (int width, int height)
	Resizes the image to the given dimension.
int	getWidth () const noexcept
	Returns the image width in pixels.
int	getStride () const noexcept
	Returns the image stride in bytes.
int	getHeight () const noexcept
	Returns the image height in pixels.
int	getSize () const noexcept
	Returns the image size in pixels.
WidthAlignment	getWidthAlignment () const noexcept
	Returns the width alignment of the image.
int	getWidthPaddingInBytes () const noexcept
	Returns width padding in bytes.

Detailed Description

Encapsulates all relevant information about a false color image.

Constructor & Destructor Documentation

ImageInfo()

OTC_SDK_API optris::ImageInfo::ImageInfo ( ColorFormat colorFormat, WidthAlignment widthAlignment )

noexcept

Constructor.

Parameters

[in]	colorFormat	of the image.
[in]	widthAlignment	of the image.

Member Function Documentation

getChannels()

int optris::ImageInfo::getChannels ( ) const

inlinenoexcept

Returns the number of color channels.

Returns

number of color channels.

getColorFormat()

ColorFormat optris::ImageInfo::getColorFormat ( ) const

inlinenoexcept

Returns the color format of the image.

Returns

color format of the image.

getHeight()

int optris::ImageInfo::getHeight ( ) const

inlinenoexcept

Returns the image height in pixels.

Returns

image height in pixels.

getOffsetBlue()

int optris::ImageInfo::getOffsetBlue ( ) const

inlinenoexcept

Returns the offset of the blue color byte.

Returns

offset of the blue color byte.

getOffsetGreen()

int optris::ImageInfo::getOffsetGreen ( ) const

inlinenoexcept

Returns the offset of the green color byte.

Returns

offset of the green color byte.

getOffsetRed()

int optris::ImageInfo::getOffsetRed ( ) const

inlinenoexcept

Returns the offset of the red color byte.

Returns

offset of the red color byte.

getSize()

int optris::ImageInfo::getSize ( ) const

inlinenoexcept

Returns the image size in pixels.

Returns

image size in pixels.

getStride()

int optris::ImageInfo::getStride ( ) const

inlinenoexcept

Returns the image stride in bytes.

The stride is the image width in bytes including potential padding.

Returns

image stride in bytes.

getWidth()

int optris::ImageInfo::getWidth ( ) const

inlinenoexcept

Returns the image width in pixels.

Returns

image width in pixels.

getWidthAlignment()

WidthAlignment optris::ImageInfo::getWidthAlignment ( ) const

inlinenoexcept

Returns the width alignment of the image.

Returns

width alignment of the image.

getWidthPaddingInBytes()

int optris::ImageInfo::getWidthPaddingInBytes ( ) const

inlinenoexcept

Returns width padding in bytes.

Returns

width padding in bytes.

resize()

OTC_SDK_API int optris::ImageInfo::resize	(	int	width,
		int	height )

Resizes the image to the given dimension.

Returns

resulting image size in bytes.

---

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

• ImageInfo.h