libfacade 1.1
A library for manipulating PNG images with payloads.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
facade::png::GrayscalePixel< _Base, _Bits > Class Template Reference

A grayscale pixel object, based on the facade::png::Sample class. More...

#include <png.hpp>

Inheritance diagram for facade::png::GrayscalePixel< _Base, _Bits >:
facade::png::Sample< _Base, _Bits > facade::png::AlphaGrayscalePixel< _Base >

Public Member Functions

 GrayscalePixel ()
 
 GrayscalePixel (_Base value)
 
 GrayscalePixel (const GrayscalePixel &other)
 
- Public Member Functions inherited from facade::png::Sample< _Base, _Bits >
 Sample ()
 
 Sample (Base value)
 
 Sample (const Sample &other)
 
Base operator* () const
 Syntactic sugar to get the value of this sample.
 
Sampleoperator= (Base value)
 Syntactic sugar to assign the value of this sample.
 
Base value () const
 Get the value retained by this sample.
 
void set_value (Base value)
 Assign the given value to this sample.
 

Additional Inherited Members

- Public Types inherited from facade::png::Sample< _Base, _Bits >
using Base = _Base
 The base type used by this sample.
 
- Static Public Attributes inherited from facade::png::Sample< _Base, _Bits >
static const std::size_t Bits = _Bits
 The size, in bits, of this sample.
 
static const std::size_t Max = (1 << Bits) - 1
 The maximum value that can be used with this sample.
 

Detailed Description

template<typename _Base = std::uint8_t, std::size_t _Bits = sizeof(_Base)*8>
class facade::png::GrayscalePixel< _Base, _Bits >

A grayscale pixel object, based on the facade::png::Sample class.

Template Parameters
_BaseThe base type that contains the sample value. Can be std::uint8_t or std::uint16_t.
_BitsThe size, in bits, of the desired sample. Can be 1, 2, 4, 8 or 16.
See also
facade::png::Sample
facade::png::GrayscalePixel1Bit
facade::png::GrayscalePixel2Bit
facade::png::GrayscalePixel4Bit
facade::png::GrayscalePixel8Bit
facade::png::GrayscalePixel16Bit

Constructor & Destructor Documentation

◆ GrayscalePixel() [1/3]

template<typename _Base = std::uint8_t, std::size_t _Bits = sizeof(_Base)*8>
facade::png::GrayscalePixel< _Base, _Bits >::GrayscalePixel ( )
inline

◆ GrayscalePixel() [2/3]

template<typename _Base = std::uint8_t, std::size_t _Bits = sizeof(_Base)*8>
facade::png::GrayscalePixel< _Base, _Bits >::GrayscalePixel ( _Base  value)
inline

◆ GrayscalePixel() [3/3]

template<typename _Base = std::uint8_t, std::size_t _Bits = sizeof(_Base)*8>
facade::png::GrayscalePixel< _Base, _Bits >::GrayscalePixel ( const GrayscalePixel< _Base, _Bits > &  other)
inline

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