HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Data Structures | Public Types | Public Member Functions | Friends
hi::v1::pixmap_span< T > Class Template Reference

#include <hikogui/image/pixmap_span.hpp>

Data Structures

struct  row_iterator
 
struct  row_range
 

Public Types

using value_type = T
 
using reference = value_type&
 
using const_reference = value_type const&
 
using pointer = value_type *
 
using const_pointer = value_type const *
 
using row_type = std::span<value_type>
 
using const_row_type = std::span<value_type const>
 
using nc_value_type = std::remove_const_t<value_type>
 
using size_type = size_t
 

Public Member Functions

constexpr pixmap_span (pixmap_span const &) noexcept=default
 
constexpr pixmap_span (pixmap_span &&) noexcept=default
 
constexpr pixmap_spanoperator= (pixmap_span const &) noexcept=default
 
constexpr pixmap_spanoperator= (pixmap_span &&) noexcept=default
 
constexpr pixmap_span (value_type *data, size_type width, size_type height, size_type stride) noexcept
 
constexpr pixmap_span (value_type *data, size_type width, size_type height) noexcept
 
template<std::same_as< std::remove_const_t< value_type > > O, typename Allocator >
constexpr pixmap_span (pixmap< O, Allocator > const &other) noexcept
 
template<std::same_as< std::remove_const_t< value_type > > O, typename Allocator >
constexpr pixmap_span (pixmap< O, Allocator > &other) noexcept
 
template<std::same_as< std::remove_const_t< value_type > > O, typename Allocator >
constexpr pixmap_span (pixmap< O, Allocator > &&other)=delete
 
constexpr bool empty () const noexcept
 
constexpr size_type width () const noexcept
 
constexpr size_type height () const noexcept
 
constexpr size_type stride () const noexcept
 
constexpr pointer data () noexcept
 
constexpr const_pointer data () const noexcept
 
constexpr reference operator() (size_type x, size_type y) noexcept
 
constexpr const_reference operator() (size_type x, size_type y) const noexcept
 
constexpr row_type operator[] (size_type y) noexcept
 
constexpr const_row_type operator[] (size_type y) const noexcept
 
constexpr auto rows () noexcept
 
constexpr auto rows () const noexcept
 
constexpr pixmap_span subimage (size_type x, size_type y, size_type new_width, size_type new_height) noexcept
 
constexpr pixmap_span< value_type const > subimage (size_type x, size_type y, size_type new_width, size_type new_height) const noexcept
 

Friends

constexpr friend void copy (pixmap_span src, pixmap_span< std::remove_const_t< value_type > > dst) noexcept
 
constexpr friend void fill (pixmap_span dst, value_type value=value_type{}) noexcept
 

Detailed Description

template<typename T>
class hi::v1::pixmap_span< T >

A non-owning 2D pixel-based image.

Template Parameters
TThe pixel format.

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