v1::pixel_map< T > Class Template Reference

#include <hikogui/pixel_map.hpp>

Public Types
using	value_type = T

Public Member Functions
	pixel_map () noexcept
	Construct an empty pixel-map.
	pixel_map (T *pixels, std::size_t width, std::size_t height, std::size_t stride) noexcept
	Construct an pixel-map from memory received from an API.
	pixel_map (T *pixels, std::size_t width, std::size_t height) noexcept
	Construct an pixel-map from memory received from an API.
	pixel_map (std::size_t width, std::size_t height, std::size_t stride) noexcept
	Construct an pixel-map without a memory association.
	pixel_map (std::size_t width, std::size_t height) noexcept
	Construct an pixel-map without a memory association.
	pixel_map (pixel_map const &other) noexcept
	Copy constructor of other.
	pixel_map (pixel_map &&other) noexcept
	operator bool () const noexcept
std::size_t	width () const noexcept
std::size_t	height () const noexcept
std::size_t	stride () const noexcept
pixel_map &	operator= (pixel_map const &other)
	Disallowing copying so that life-time of selfAllocated pixels is easy to understand.
pixel_map &	operator= (pixel_map &&other) noexcept
extent2	extent () const noexcept
pixel_map	submap (std::size_t x, std::size_t y, std::size_t width, std::size_t height) const noexcept
	Get a (smaller) view of the map.
pixel_map	submap (aarectangle rectangle) const noexcept
pixel_row< T > const	operator[] (std::size_t rowNr) const noexcept
pixel_row< T >	operator[] (std::size_t rowNr) noexcept
pixel_row< T > const	at (std::size_t rowNr) const noexcept
pixel_row< T >	at (std::size_t rowNr) noexcept

Detailed Description

template<typename T>
class v1::pixel_map< T >

A 2D canvas of pixels.

This class may either allocate its own memory, or gives access to memory allocated by another API, such as a Vulkan texture.

Constructor & Destructor Documentation

pixel_map() [1/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( )

inlinenoexcept

Construct an empty pixel-map.

pixel_map() [2/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( T * pixels, std::size_t width, std::size_t height, std::size_t stride )

inlinenoexcept

Construct an pixel-map from memory received from an API.

Parameters

pixels	A pointer to pixels received from the API.
width	The width of the image.
height	The height of the image.
stride	Number of pixel elements until the next row.

pixel_map() [3/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( T * pixels, std::size_t width, std::size_t height )

inlinenoexcept

Construct an pixel-map from memory received from an API.

Parameters

pixels	A pointer to pixels received from the API.
width	The width of the image.
height	The height of the image.

pixel_map() [4/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( std::size_t width, std::size_t height, std::size_t stride )

inlinenoexcept

Construct an pixel-map without a memory association.

Parameters

width	The width of the image.
height	The height of the image.
stride	The number of pixels in a line until the next line.

pixel_map() [5/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( std::size_t width, std::size_t height )

inlinenoexcept

Construct an pixel-map without a memory association.

Parameters

width	The width of the image.
height	The height of the image.

pixel_map() [6/6]

template<typename T >

v1::pixel_map< T >::pixel_map ( pixel_map< T > const & other )

inlinenoexcept

Copy constructor of other.

If the data in other is self allocated a new copy is created. If other is a view, then a new view is creted.

Member Function Documentation

operator=()

template<typename T >

pixel_map & v1::pixel_map< T >::operator= ( pixel_map< T > const & other )

inline

Disallowing copying so that life-time of selfAllocated pixels is easy to understand.

submap()

template<typename T >

pixel_map v1::pixel_map< T >::submap ( std::size_t x, std::size_t y, std::size_t width, std::size_t height ) const

inlinenoexcept

Get a (smaller) view of the map.

Parameters

x	x-offset in the current pixel-map
y	y-offset in the current pixel-map
width	width of the returned image.
height	height of the returned image.

Returns

A new pixel-map that point to the same memory as the current pixel-map.

---

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

• hikogui/src/hikogui/GFX/paged_image.hpp
• hikogui/src/hikogui/pixel_map.hpp