Linear access properties. More...

#include <cvb/vpat.hpp>

Inherits ValueAccessBase< LinearAccessData >.

Classes
class	Column
	A single column. More...

class	Row
	A single row. More...

Public Member Functions
	LinearAccessData () noexcept
	Creates a default linear access data set. More...

LinearAccessData	NewMoved (const Cvb::Rect< int > newAoi) const noexcept
	Creates a new, moved linear access object. More...

std::uint8_t *	BasePtr () const noexcept
	Linear access base pointer. More...

std::intptr_t	XInc () const noexcept
	X-increment for linear access. More...

std::intptr_t	YInc () const noexcept
	Y-increment for linear access. More...

CVB_FORCE_INLINE int	Width () const noexcept
	Gets the pixel width of the underlying plane. More...

bool	Valid () const noexcept
	Gets whether this linear access object is valid. More...

	operator bool () const noexcept
	Gets whether this linear access object is valid. More...

CVB_FORCE_INLINE const void *	operator() (int x, int y) const noexcept
	Coordinate pixel access operator. More...

CVB_FORCE_INLINE void *	operator() (int x, int y) noexcept
	Coordinate pixel access operator. More...

CVB_FORCE_INLINE const void *	operator[] (int idx) const noexcept
	Index pixel access operator. More...

CVB_FORCE_INLINE void *	operator[] (int idx) noexcept
	Index pixel access operator. More...

Row	RowAt (int y) const noexcept
	Gets the LinearAccessData::Row at y. More...

Column	ColumnAt (int x) const noexcept
	Gets the LinearAccessData::Column at x. More...

Public Member Functions inherited from ValueAccessBase< LinearAccessData >
const Type &	Value (int x, int y) const noexcept
	Gets a pixel value at a given position. More...

Type &	Value (int x, int y) noexcept
	Gets a settable pixel value at a given position. More...

const Type &	Value (Point2D< int > position) const noexcept
	Gets a pixel value at a given position. More...

Type &	Value (Point2D< int > position) noexcept
	Gets a settable pixel value at a given position. More...

Static Public Member Functions
template<class PLANE_T >
static LinearAccessData	FromPlane (const PLANE_T &plane) noexcept
	Tries to get a valid LinearAccessData from the given plane. More...

static LinearAccessData	FromVpat (const Vpat &access, Cvb::Size2D< int > size, Cvb::DataType dataType) noexcept
	Tries to get a valid LinearAccessData trait from the given vpat. More...

static LinearAccessData	FromPtr (std::uint8_t *basePtr, std::intptr_t xInc, std::intptr_t yInc, int width) noexcept
	Creates LinearAccessData from the given pointer and increments. More...

Related Functions
(Note that these are not member functions.)
bool	operator!= (const LinearAccessData &lhs, const LinearAccessData &rhs) noexcept
	Inequality operator. More...

bool	operator== (const LinearAccessData &lhs, const LinearAccessData &rhs) noexcept
	Equality operator. More...

bool	IsInterleaved (size_t bytesPerPixel, const LinearAccessData &access0, const LinearAccessData &access1) noexcept

template<class... ACCESSES>
bool	IsInterleaved (size_t bytesPerPixel, const LinearAccessData &access0, const LinearAccessData &access1, const ACCESSES &... accs) noexcept

Detailed Description

Linear access properties.

Constructor & Destructor Documentation

◆ LinearAccessData()

LinearAccessData ( )

inlinedefaultnoexcept

Creates a default linear access data set.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ BasePtr()

std::uint8_t * BasePtr ( ) const

inlinenoexcept

Linear access base pointer.

Returns: The base pointer.

Exceptions

Does	not throw any exception.

Remember, that the increments to be added to the base pointer, are given in bytes, not in pixels. BasePtr by design points to the pixel at location (0,0).

◆ ColumnAt()

Column ColumnAt ( int x ) const

inlinenoexcept

Gets the LinearAccessData::Column at x.

Precondition: x must be between 0 and less than the allowed width.

Parameters

[in] x Pixel column.

Returns: Column object at line x.

◆ FromPlane()

LinearAccessData FromPlane ( const PLANE_T & plane )

inlinestaticnoexcept

Tries to get a valid LinearAccessData from the given plane.

Can be extended to support custom plane types T by implementing Cvb::PlaneTraits<T>.

Template Parameters

PLANE_T The type of the plane to get the access from.

Parameters

[in] plane Plane to access.

Returns: Valid LinearAccessData if linear access possible; invalid one otherwise.

◆ FromPtr()

static LinearAccessData FromPtr	(	std::uint8_t *	basePtr,
		std::intptr_t	xInc,
		std::intptr_t	yInc,
		int	width
	)

inlinestaticnoexcept

Creates LinearAccessData from the given pointer and increments.

Parameters

[in]	basePtr	Base address of the memory.
[in]	xInc	std::intptr_t X increment in bytes.
[in]	yInc	std::intptr_t Y increment in bytes.
[in]	width	int The number of elements in the plane in x direction.

Returns: Valid LinearAccessData if inputs are valid.

◆ FromVpat()

LinearAccessData FromVpat	(	const Vpat &	access,
		Cvb::Size2D< int >	size,
		Cvb::DataType	dataType
	)

inlinestaticnoexcept

Tries to get a valid LinearAccessData trait from the given vpat.

Parameters

[in]	access	Base address in conjunction with VPAT.
[in]	size	Image dimensions of the given VPAT access.
[in]	dataType	Data type of the image of the given vpat.

Returns: Valid LinearAccessData if VPAT access is linear; invalid one otherwise.

◆ NewMoved()

LinearAccessData NewMoved ( const Cvb::Rect< int > newAoi ) const

inlinenoexcept

Creates a new, moved linear access object.

Precondition: Valid() == true

Parameters

[in] newAoi Offset and new size in pixels to move this linear access to.

Returns: New LinearAccessData object that is moved by (newAoi.Left(), newAoi.Top()).

◆ operator bool()

operator bool ( ) const

inlineexplicitnoexcept

Gets whether this linear access object is valid.

Returns: true if Scan0() is not nullptr, XInc() and YInc() are unequal 0.

◆ operator()() [1/2]

CVB_FORCE_INLINE const void * operator()	(	int	x,
		int	y
	)		const

inlinenoexcept

Coordinate pixel access operator.

Precondition: Valid() == true

Parameters

[in]	x	X coordinate coefficient in pixels.
[in]	y	Y coordinate coefficient in pixels.

Returns: Const pointer to pixel value.

◆ operator()() [2/2]

CVB_FORCE_INLINE void * operator()	(	int	x,
		int	y
	)

inlinenoexcept

Coordinate pixel access operator.

Precondition: Valid() == true

Parameters

[in]	x	X coordinate coefficient in pixels.
[in]	y	Y coordinate coefficient in pixels.

Returns: Mutable pointer to pixel value.

◆ operator[]() [1/2]

CVB_FORCE_INLINE const void * operator[] ( int idx ) const

inlinenoexcept

Index pixel access operator.

Precondition: Valid() == true

Parameters

[in] idx Pixel index.

Returns: Const pointer to pixel value.

◆ operator[]() [2/2]

CVB_FORCE_INLINE void * operator[] ( int idx )

inlinenoexcept

Index pixel access operator.

Precondition: Valid() == true

Parameters

[in] idx Pixel index.

Returns: Mutable pointer to pixel value.

◆ RowAt()

Row RowAt ( int y ) const

inlinenoexcept

Gets the LinearAccessData::Row at y.

Precondition: y must be between 0 and less than the allowed height.

Parameters

[in] y Pixel row.

Returns: Row object at line y.

◆ Valid()

bool Valid ( ) const

inlinenoexcept

Gets whether this linear access object is valid.

Returns: true if Scan0() is not nullptr, XInc() and YInc() are unequal 0.

◆ Width()

CVB_FORCE_INLINE int Width ( ) const

inlinenoexcept

Gets the pixel width of the underlying plane.

Returns: Pixel width of the working plane.

◆ XInc()

std::intptr_t XInc ( ) const

inlinenoexcept

X-increment for linear access.

Returns: X-increment.

Exceptions

Does	not throw any exception.

◆ YInc()

std::intptr_t YInc ( ) const

inlinenoexcept

Y-increment for linear access.

Returns: Y-increment

Exceptions

Does	not throw any exception.

Friends And Related Function Documentation

◆ IsInterleaved() [1/2]

bool IsInterleaved	(	size_t	bytesPerPixel,
		const LinearAccessData &	access0,
		const LinearAccessData &	access1
	)

Parameters

[in]	bytesPerPixel	The number of bytes required per pixel.
[in]	access0	First LinearAccessData to test.
[in]	access1	Second LinearAccessData to test.

Returns: true if interleaved, false if not

◆ IsInterleaved() [2/2]

bool IsInterleaved	(	size_t	bytesPerPixel,
		const LinearAccessData &	access0,
		const LinearAccessData &	access1,
		const ACCESSES &...	accs
	)

Parameters

[in]	bytesPerPixel	The number of bytes required per pixel.
[in]	access0	First LinearAccessData to test.
[in]	access1	Second LinearAccessData to test.

Returns: true if interleaved, false if not

Parameters

[in] accs Arbitrary number of other Linear Accesses.

◆ operator!=()

bool operator!=	(	const LinearAccessData &	lhs,
		const LinearAccessData &	rhs
	)

Parameters

[in]	lhs	Left hand side operand.
[in]	rhs	Right hand side operand.

Returns: true if lhs and rhs are unequal; false if equal.

◆ operator==()

bool operator==	(	const LinearAccessData &	lhs,
		const LinearAccessData &	rhs
	)

Parameters

[in]	lhs	Left hand side operand.
[in]	rhs	Right hand side operand.

Returns: true if lhs and rhs are equal; false if equal.

Classes

Public Member Functions

Static Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ LinearAccessData()

Member Function Documentation

◆ BasePtr()

◆ ColumnAt()

◆ FromPlane()

◆ FromPtr()

◆ FromVpat()

◆ NewMoved()

◆ operator bool()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ RowAt()

◆ Valid()

◆ Width()

◆ XInc()

◆ YInc()

Friends And Related Function Documentation

◆ IsInterleaved() [1/2]

◆ IsInterleaved() [2/2]

◆ operator!=()

◆ operator==()