tt::PixelRow< T > Struct Template Reference

#include <TTauri/Foundation/PixelMap.hpp>

Public Member Functions
T const *	data () const noexcept
	Get a pointer to the pixel data.
T *	data () noexcept
	Get a pointer to the pixel data.
T const &	operator[] (ssize_t columnNr) const noexcept
	Get a access to a pixel in the row.
T &	operator[] (ssize_t columnNr) noexcept
	Get a access to a pixel in the row.
T const &	at (ssize_t columnNr) const noexcept
	Get a access to a pixel in the row.
T &	at (ssize_t columnNr) noexcept
	Get a access to a pixel in the row.

Data Fields
T *	pixels
	Pointer to an array of pixels.
ssize_t	width
	Number of pixels in the row.

Detailed Description

template<typename T>
struct tt::PixelRow< T >

A row of pixels.

Member Function Documentation

at() [1/2]

template<typename T >

T const & tt::PixelRow< T >::at ( ssize_t columnNr ) const

inlinenoexcept

Get a access to a pixel in the row.

This function does bound checking.

Parameters

columnNr

The column number in the row.

Returns

a reference to a pixel.

at() [2/2]

template<typename T >

T & tt::PixelRow< T >::at ( ssize_t columnNr )

inlinenoexcept

Get a access to a pixel in the row.

This function does bound checking.

Parameters

columnNr

The column number in the row.

Returns

a reference to a pixel.

data() [1/2]

template<typename T >

T const * tt::PixelRow< T >::data ( ) const

inlinenoexcept

Get a pointer to the pixel data.

data() [2/2]

template<typename T >

T * tt::PixelRow< T >::data ( )

inlinenoexcept

Get a pointer to the pixel data.

operator[]() [1/2]

template<typename T >

T const & tt::PixelRow< T >::operator[] ( ssize_t columnNr ) const

inlinenoexcept

Get a access to a pixel in the row.

Parameters

columnNr

The column number in the row.

Returns

a reference to a pixel.

operator[]() [2/2]

template<typename T >

T & tt::PixelRow< T >::operator[] ( ssize_t columnNr )

inlinenoexcept

Get a access to a pixel in the row.

Parameters

columnNr

The column number in the row.

Returns

a reference to a pixel.

Field Documentation

pixels

template<typename T >

T* tt::PixelRow< T >::pixels

Pointer to an array of pixels.

width

template<typename T >

ssize_t tt::PixelRow< T >::width

Number of pixels in the row.

---

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

• hikogui/src/TTauri/Foundation/PixelMap.hpp