Zivid::Resolution Class Reference

Class describing a resolution with a width and a height. More...

#include <Zivid/Resolution.h>

Public Member Functions
ZIVID_CORE_EXPORT	Resolution (size_t width, size_t height)
	Construct a Resolution from width and height.
ZIVID_CORE_EXPORT size_t	width () const
	Get the width value of the resolution.
ZIVID_CORE_EXPORT size_t	height () const
	Get the height value of the resolution.
ZIVID_CORE_EXPORT size_t	size () const
	Get the size (area) that is the product of the width and height.
ZIVID_CORE_EXPORT bool	operator== (const Resolution &other) const
	Comparison operator.
ZIVID_CORE_EXPORT bool	operator!= (const Resolution &other) const
	Comparison operator.
ZIVID_CORE_EXPORT std::string	toString () const
	Get a string representation of the resolution.

Detailed Description

Class describing a resolution with a width and a height.

Constructor & Destructor Documentation

Resolution()

ZIVID_CORE_EXPORT Zivid::Resolution::Resolution	(	size_t	width,
		size_t	height
	)

Construct a Resolution from width and height.

Member Function Documentation

height()

ZIVID_CORE_EXPORT size_t Zivid::Resolution::height

(

)

const

Get the height value of the resolution.

operator!=()

ZIVID_CORE_EXPORT bool Zivid::Resolution::operator!=

(

const Resolution &

other

)

const

Comparison operator.

operator==()

ZIVID_CORE_EXPORT bool Zivid::Resolution::operator==

(

const Resolution &

other

)

const

Comparison operator.

size()

ZIVID_CORE_EXPORT size_t Zivid::Resolution::size

(

)

const

Get the size (area) that is the product of the width and height.

toString()

ZIVID_CORE_EXPORT std::string Zivid::Resolution::toString

(

)

const

Get a string representation of the resolution.

width()

ZIVID_CORE_EXPORT size_t Zivid::Resolution::width

(

)

const

Get the width value of the resolution.

---

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

• Zivid/Resolution.h