VTK-m  2.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkm::io::RGBPixel< BitDepth > Class Template Reference

#include <PixelTypes.h>

Inheritance diagram for vtkm::io::RGBPixel< BitDepth >:
vtkm::io::BasePixel< BitDepth, 3 > vtkm::Vec< ComponentTypeFromSize< BitDepth >::type, Channels >

Public Types

using Superclass = BasePixel< BitDepth, 3 >
 
using ComponentType = typename Superclass::ComponentType
 
- Public Types inherited from vtkm::io::BasePixel< BitDepth, 3 >
using Superclass = vtkm::Vec< typename ComponentTypeFromSize< BitDepth >::type, Channels >
 
using ComponentType = typename Superclass::ComponentType
 
using BaseType = BasePixel< BitDepth, Channels >
 
- Public Types inherited from vtkm::Vec< ComponentTypeFromSize< BitDepth >::type, Channels >
using ComponentType = ComponentTypeFromSize< BitDepth >::type
 

Public Member Functions

 RGBPixel ()=default
 
 RGBPixel (vtkm::Vec4f_32 tuple)
 
virtual ~RGBPixel ()=default
 
ComponentType Diff (const Superclass &pixel) const override
 
vtkm::Vec4f_32 ToVec4f () const override
 
- Public Member Functions inherited from vtkm::io::BasePixel< BitDepth, 3 >
 BasePixel ()=default
 
 BasePixel (const unsigned char *imageData, const vtkm::Id index)
 Fills in this->Components by calling ConstructPixelFromImage. More...
 
virtual ~BasePixel ()=default
 
virtual ComponentType Diff (const BaseType &pixel) const=0
 Calculates this difference between two pixels as a single value. More...
 
virtual vtkm::Vec4f_32 ToVec4f () const=0
 Generates a Vec4f_32 from the current data available in the pixel. More...
 
void FillImageAtIndexWithPixel (unsigned char *imageData, const vtkm::Id index)
 Takes an output imageData pointer and in index to a location in that dataset and fills in the pixel data at the location. More...
 
- Public Member Functions inherited from vtkm::Vec< ComponentTypeFromSize< BitDepth >::type, Channels >
 Vec ()=default
 
void CopyInto (Vec< ComponentTypeFromSize< BitDepth >::type, Size > &dest) const
 

Static Public Member Functions

static int GetColorType ()
 
- Static Public Member Functions inherited from vtkm::io::BasePixel< BitDepth, 3 >
static constexpr vtkm::IdComponent GetBitDepth ()
 

Protected Member Functions

void print (std::ostream &os) const override
 
- Protected Member Functions inherited from vtkm::io::BasePixel< BitDepth, 3 >
void ConstructPixelFromImage (const unsigned char *imageData, const vtkm::Id index)
 Takes an input imageData pointer and an index to a location in that dataset and fills in this->Components correctly using the provided BIT_DEPTH and NUM_CHANNELS. More...
 

Additional Inherited Members

- Static Public Attributes inherited from vtkm::io::BasePixel< BitDepth, 3 >
static constexpr vtkm::IdComponent BIT_DEPTH
 
static constexpr vtkm::IdComponent NUM_BYTES
 
static constexpr vtkm::IdComponent MAX_COLOR_VALUE
 
static constexpr vtkm::IdComponent NUM_CHANNELS
 
static constexpr vtkm::IdComponent BYTES_PER_PIXEL
 
- Static Public Attributes inherited from vtkm::Vec< ComponentTypeFromSize< BitDepth >::type, Channels >
static constexpr vtkm::IdComponent NUM_COMPONENTS
 

Member Typedef Documentation

◆ ComponentType

template<const vtkm::Id BitDepth>
using vtkm::io::RGBPixel< BitDepth >::ComponentType = typename Superclass::ComponentType

◆ Superclass

template<const vtkm::Id BitDepth>
using vtkm::io::RGBPixel< BitDepth >::Superclass = BasePixel<BitDepth, 3>

Constructor & Destructor Documentation

◆ RGBPixel() [1/2]

template<const vtkm::Id BitDepth>
vtkm::io::RGBPixel< BitDepth >::RGBPixel ( )
default

◆ RGBPixel() [2/2]

template<const vtkm::Id BitDepth>
vtkm::io::RGBPixel< BitDepth >::RGBPixel ( vtkm::Vec4f_32  tuple)
inline

◆ ~RGBPixel()

template<const vtkm::Id BitDepth>
virtual vtkm::io::RGBPixel< BitDepth >::~RGBPixel ( )
virtualdefault

Member Function Documentation

◆ Diff()

template<const vtkm::Id BitDepth>
ComponentType vtkm::io::RGBPixel< BitDepth >::Diff ( const Superclass pixel) const
override

◆ GetColorType()

template<const vtkm::Id BitDepth>
static int vtkm::io::RGBPixel< BitDepth >::GetColorType ( )
static

◆ print()

template<const vtkm::Id BitDepth>
void vtkm::io::RGBPixel< BitDepth >::print ( std::ostream &  os) const
inlineoverrideprotectedvirtual

◆ ToVec4f()

template<const vtkm::Id BitDepth>
vtkm::Vec4f_32 vtkm::io::RGBPixel< BitDepth >::ToVec4f ( ) const
override

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