VTK-m  2.0
Public Member Functions | Protected Member Functions | Private Types | List of all members
vtkm::io::ImageReaderPNG Class Reference

Manages reading images using the PNG format via lodepng. More...

#include <ImageReaderPNG.h>

Inheritance diagram for vtkm::io::ImageReaderPNG:
vtkm::io::ImageReaderBase

Public Member Functions

VTKM_CONT ~ImageReaderPNG () noexcept override
 
 ImageReaderPNG (const ImageReaderPNG &)=delete
 
ImageReaderPNGoperator= (const ImageReaderPNG &)=delete
 
- Public Member Functions inherited from vtkm::io::ImageReaderBase
VTKM_CONT ImageReaderBase (const char *filename)
 
VTKM_CONT ImageReaderBase (const std::string &filename)
 
virtual VTKM_CONT ~ImageReaderBase () noexcept
 
 ImageReaderBase (const ImageReaderBase &)=delete
 
ImageReaderBaseoperator= (const ImageReaderBase &)=delete
 
const VTKM_CONT vtkm::cont::DataSetReadDataSet ()
 
const VTKM_CONT vtkm::cont::DataSetGetDataSet () const
 
const VTKM_CONT std::string & GetPointFieldName () const
 
VTKM_CONT void SetPointFieldName (const std::string &name)
 
const VTKM_CONT std::string & GetFileName () const
 
VTKM_CONT void SetFileName (const std::string &filename)
 

Protected Member Functions

VTKM_CONT void Read () override
 
- Protected Member Functions inherited from vtkm::io::ImageReaderBase
void InitializeImageDataSet (const vtkm::Id &width, const vtkm::Id &height, const ColorArrayType &pixels)
 Resets the DataSet to hold the given pixels. More...
 

Private Types

using Superclass = ImageReaderBase
 

Additional Inherited Members

- Public Types inherited from vtkm::io::ImageReaderBase
using ColorArrayType = vtkm::cont::ArrayHandle< vtkm::Vec4f_32 >
 
- Protected Attributes inherited from vtkm::io::ImageReaderBase
std::string FileName
 
std::string PointFieldName = "color"
 
vtkm::cont::DataSet DataSet
 

Detailed Description

Manages reading images using the PNG format via lodepng.

ImageReaderPNG extends ImageReaderBase and implements reading images in a valid PNG format. It utilizes lodepng's decode file functions to read PNG images that are automatically compressed to optimal sizes relative to the actual bit complexity of the image.

ImageReaderPNG will automatically upsample/downsample read image data to a 16 bit RGB no matter how the image is compressed. It is up to the user to decide the pixel format for input PNGs

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ ~ImageReaderPNG()

VTKM_CONT vtkm::io::ImageReaderPNG::~ImageReaderPNG ( )
overridenoexcept

◆ ImageReaderPNG()

vtkm::io::ImageReaderPNG::ImageReaderPNG ( const ImageReaderPNG )
delete

Member Function Documentation

◆ operator=()

ImageReaderPNG& vtkm::io::ImageReaderPNG::operator= ( const ImageReaderPNG )
delete

◆ Read()

VTKM_CONT void vtkm::io::ImageReaderPNG::Read ( )
overrideprotectedvirtual

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