TIL_Stitch::IMGTileReader Class Reference

#include <TIL_Stitch.h>

Inheritance diagram for TIL_Stitch::IMGTileReader:

Classes
struct	OpenStyle

Public Member Functions
	IMGTileReader ()
	~IMGTileReader () override
bool	setFile (const char *filename, const IMG_FileParms *options=nullptr, const IMG_Format *fmt=nullptr)
bool	setFile (const char *filename, const UT_Array< const IMG_Format * > &formats, const IMG_FileParms *options=nullptr)
const UT_DimRect &	dataWindow () const override
	Return the data window of the tile in pixels. More...
bool	open () override
	Open tile for reading. More...
bool	canRead (const Scanline *scanline) const override
bool	readScanline (int plane, int xoff, int scanline, Scanline *buffer) override
	Read an AOV from the tile. More...
bool	close () override
	Close tile when finished reading. More...
bool	isValid () const
IMG_FilePtr	stealStream ()
const char *	getFilename () const
Public Member Functions inherited from TIL_Stitch::TileReader
	TileReader ()
virtual	~TileReader ()

Protected Member Functions
bool	init (IMG_FilePtr fp)
bool	initStat ()
virtual void	error (const char *msg) const
Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
	UT_NonCopyable ()=default
	~UT_NonCopyable ()=default
	UT_NonCopyable (const UT_NonCopyable &)=delete
UT_NonCopyable &	operator= (const UT_NonCopyable &)=delete

Protected Attributes
UT_DimRect	myDataWindow
IMG_FilePtr	myFile
OpenStyle	myOpen

Detailed Description

Convenience class to read a tile from a file

Note

this class expects the scanlines to be interleaved (rgbrgb...)

Definition at line 127 of file TIL_Stitch.h.

Constructor & Destructor Documentation

TIL_Stitch::IMGTileReader::IMGTileReader

(

)

TIL_Stitch::IMGTileReader::~IMGTileReader ( )

override

Member Function Documentation

bool TIL_Stitch::IMGTileReader::canRead ( const Scanline *  scanline ) const

overridevirtual

Implements TIL_Stitch::TileReader.

bool TIL_Stitch::IMGTileReader::close ( )

overridevirtual

Close tile when finished reading.

Implements TIL_Stitch::TileReader.

const UT_DimRect& TIL_Stitch::IMGTileReader::dataWindow ( ) const

overridevirtual

Return the data window of the tile in pixels.

Implements TIL_Stitch::TileReader.

virtual void TIL_Stitch::IMGTileReader::error ( const char *  msg ) const

protectedvirtual

const char* TIL_Stitch::IMGTileReader::getFilename ( ) const

inline

Definition at line 175 of file TIL_Stitch.h.

bool TIL_Stitch::IMGTileReader::init ( IMG_FilePtr  fp )

protected

bool TIL_Stitch::IMGTileReader::initStat ( )

protected

bool TIL_Stitch::IMGTileReader::isValid ( ) const

inline

Definition at line 172 of file TIL_Stitch.h.

bool TIL_Stitch::IMGTileReader::open ( )

overridevirtual

Open tile for reading.

Implements TIL_Stitch::TileReader.

bool TIL_Stitch::IMGTileReader::readScanline ( int  plane, int  xoff, int  scanline, Scanline *  buffer  )

overridevirtual

Read an AOV from the tile.

Implements TIL_Stitch::TileReader.

bool TIL_Stitch::IMGTileReader::setFile ( const char *  filename, const IMG_FileParms *  options = nullptr, const IMG_Format *  fmt = nullptr  )

inline

Definition at line 144 of file TIL_Stitch.h.

bool TIL_Stitch::IMGTileReader::setFile ( const char *  filename, const UT_Array< const IMG_Format * > &  formats, const IMG_FileParms *  options = nullptr  )

inline

Definition at line 154 of file TIL_Stitch.h.

IMG_FilePtr TIL_Stitch::IMGTileReader::stealStream ( )

inline

Definition at line 174 of file TIL_Stitch.h.

Member Data Documentation

UT_DimRect TIL_Stitch::IMGTileReader::myDataWindow

protected

Definition at line 181 of file TIL_Stitch.h.

IMG_FilePtr TIL_Stitch::IMGTileReader::myFile

protected

Definition at line 182 of file TIL_Stitch.h.

OpenStyle TIL_Stitch::IMGTileReader::myOpen

protected

Definition at line 183 of file TIL_Stitch.h.

---

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

• TIL/TIL_Stitch.h