DD::Image::RawGeneralTile Class Reference

#include <RawGeneralTile.h>

Inheritance diagram for DD::Image::RawGeneralTile:

Classes
class	LinePointers

Public Types
typedef const float *	RowPtr

Public Member Functions
	RawGeneralTile (Iop &input, const ChannelSet &chans, bool mt=false, InterestRatchet *ir=nullptr)
	RawGeneralTile (Iop &input, const Box &box, const ChannelSet &chans, bool mt=false, InterestRatchet *ir=nullptr)
	RawGeneralTile (Iop &input, int x, int y, int r, int t, const ChannelSet &chans, bool mt=false, InterestRatchet *ir=nullptr)
LinePointers	operator[] (Channel z) const
Public Member Functions inherited from DD::Image::GeneralTile
int	x () const
int	y () const
int	r () const
int	t () const
int	w () const
int	h () const
int	clampy (int y) const
int	clampx (int x) const
	operator const Box & () const
const DD::Image::Box &	box () const
const ChannelSet &	channels () const
bool	is_zero (Channel z, int y) const
bool	valid () const
	GeneralTile (Iop &input, const Box &box, const ChannelSet &chans, bool forceUnpacked=false, bool mt=false, InterestRatchet *ir=nullptr)
	~GeneralTile ()
float	at (int x, int y, Channel z)
bool	aborted () const
void	load_range (int y, int t)

Static Public Member Functions
static const float *	NilRow ()

Protected Member Functions
	RawGeneralTile (bool loadOnDemand, Iop &input, const Box &box, const ChannelSet &chans, bool mt=false, InterestRatchet *ir=nullptr)
Protected Member Functions inherited from DD::Image::GeneralTile
	GeneralTile (bool loadOnDemand, Iop &input, const Box &box, const ChannelSet &chans, bool forceUnpacked=false, bool mt=false, InterestRatchet *ir=nullptr)

Friends
class	LinePointers
template<class TileType >
class	TSamplerImpl

Additional Inherited Members
Static Protected Member Functions inherited from DD::Image::GeneralTile
static Box	getRequestBox (Iop &input)
Protected Attributes inherited from DD::Image::GeneralTile
Iop &	_input
PlanarI *	_planarI
LocalPlaneCache *	_ipc
ChannelSet	_channels
Box	_box
RowCacheTile *	_rowCacheTile
bool	_ipcIsShared
bool	_valid
bool	_wantPacked
std::set< ChannelSet >	_allPlanes

Detailed Description

Derivative of the GeneralTile which provides a two-level operator[] which will returns a raw pointer type.

Use of this means that the data from the input will have to be unpacked if it is provided packed, so it is probably best avoided and provided solely for compatibility

Member Typedef Documentation

RowPtr

typedef const float* DD::Image::RawGeneralTile::RowPtr

pointer to within an individual row

Constructor & Destructor Documentation

RawGeneralTile() [1/4]

DD::Image::RawGeneralTile::RawGeneralTile ( Iop &  input, const ChannelSet &  chans, bool  mt = false, InterestRatchet *  ir = nullptr  )

inline

load the entire requested area of /input/, for /channels/; if /mt/ is true then it may spawn threads to render the area in parallel. the InterestRatchet /ir/ might be passed down to the underlying RowCacheTile, if it uses one.

RawGeneralTile() [2/4]

DD::Image::RawGeneralTile::RawGeneralTile ( Iop &  input, const Box &  box, const ChannelSet &  chans, bool  mt = false, InterestRatchet *  ir = nullptr  )

inline

load the area /box/ on /input/, for /channels/; if /mt/ is true then it may spawn threads to render the area in parallel. the InterestRatchet /ir/ might be passed down to the underlying RowCacheTile, if it uses one.

RawGeneralTile() [3/4]

DD::Image::RawGeneralTile::RawGeneralTile ( Iop &  input, int  x, int  y, int  r, int  t, const ChannelSet &  chans, bool  mt = false, InterestRatchet *  ir = nullptr  )

inline

load the area (x, y, r, t) on /input/, for /channels/; if /mt/ is true then it may spawn threads to render the area in parallel. the InterestRatchet /ir/ might be passed down to the underlying RowCacheTile, if it uses one.

RawGeneralTile() [4/4]

DD::Image::RawGeneralTile::RawGeneralTile ( bool  loadOnDemand, Iop &  input, const Box &  box, const ChannelSet &  chans, bool  mt = false, InterestRatchet *  ir = nullptr  )

inlineprotected

Constructor. This version expects an additional loadOnDemand argument. If set to True, the tile properties will be initialised but image data will not be available immediately after this call. It will instead be provided on demand as pixels are read from the tile. This can be useful for cases such as sampling where the tile defines a possible area that may be read from, but the exact pixels which are needed are not known when the tile is constructed.

Member Function Documentation

operator[]()

LinePointers DD::Image::RawGeneralTile::operator[] ( Channel  z ) const

inline

given a channel, return something that acts like an array of pointers to all the loaded lines

NilRow()

static const float * DD::Image::RawGeneralTile::NilRow ( )

inlinestatic

return an empty row pointer