#include <RixDeepTexture.h>

Public Member Functions
virtual const char *	GetName ()=0
	return the name of this image. More...

virtual int	GetNumChan ()=0
	return the number of channels in this image More...

virtual int	GetWidth ()=0
	return the width of this image in pixels More...

virtual int	GetHeight ()=0
	return the height of this image in pixels More...

virtual int	GetTileWidth ()=0
	return the width of the tiles in this image, in pixels More...

virtual int	GetTileHeight ()=0
	return the height of the tiles in this image, in pixels More...

virtual int	GetNP (float *NP)=0
	copy the projection matrix from this image to NP. More...

virtual int	GetNl (float *Nl)=0
	copy the light-space matrix from this image to Nl. More...

virtual Compression	GetCompression ()=0
	return the compression type of this image. More...

virtual DataType	GetDataType ()=0
	return the data type of this image. More...

virtual DeepMetadata *	GetMetadata ()=0
	Get a handle to the image-specific metadata. More...

virtual int	SetPixelData (int x, int y, int numPoints, float *data)=0
	Copy the given pixel data into pixel x, y of the specified image. More...

virtual int	SetPixel (int x, int y, DeepPixel *pix)=0
	Copy the given pixel into pixel x,y of the specified image. More...

virtual int	GetPixel (int x, int y, DeepPixel *pix)=0
	Copy the pixel at position x,y into the given DeepPixel. More...

virtual int	Eval (int x, int y, float z, float *data)=0
	Look up the pixel's interpolated value at depth z, and put the result in data. More...

virtual int	GetZRange (int x, int y, float min, float max)=0
	Computes the range over which the specified pixel is defined. More...

virtual int	GetMeanDepth (int x, int y, float mean, float alpha)=0
	Computes the mean depth found in the pixel and the overall coverage. More...

Protected Member Functions
virtual	~DeepImage ()
	Internal only. More...

Detailed Description

DeepImage.

This object allows the manipulation of the DeepPixel data contained within this image object.

Constructor & Destructor Documentation

◆ ~DeepImage()

virtual RixDeepTexture::DeepImage::~DeepImage ( )

inlineprotectedvirtual

Internal only.

Member Function Documentation

◆ Eval()

virtual int RixDeepTexture::DeepImage::Eval	(	int	x,
		int	y,
		float	z,
		float *	data
	)

pure virtual

Look up the pixel's interpolated value at depth z, and put the result in data.

Data must point at float storage large enough to encompass the number of channels in the image.

◆ GetCompression()

virtual Compression RixDeepTexture::DeepImage::GetCompression ( )

pure virtual

return the compression type of this image.

◆ GetDataType()

virtual DataType RixDeepTexture::DeepImage::GetDataType ( )

pure virtual

return the data type of this image.

◆ GetHeight()

virtual int RixDeepTexture::DeepImage::GetHeight ( )

pure virtual

return the height of this image in pixels

◆ GetMeanDepth()

virtual int RixDeepTexture::DeepImage::GetMeanDepth	(	int	x,
		int	y,
		float *	mean,
		float *	alpha
	)

pure virtual

Computes the mean depth found in the pixel and the overall coverage.

This is useful for displaying deep images.

◆ GetMetadata()

virtual DeepMetadata* RixDeepTexture::DeepImage::GetMetadata ( )

pure virtual

Get a handle to the image-specific metadata.

May be null on older files.

◆ GetName()

virtual const char* RixDeepTexture::DeepImage::GetName ( )

pure virtual

return the name of this image.

The resulting pointer is guaranteed to be valid until DtexClose() is called on the containing file.

◆ GetNl()

virtual int RixDeepTexture::DeepImage::GetNl ( float * Nl )

pure virtual

copy the light-space matrix from this image to Nl.

◆ GetNP()

virtual int RixDeepTexture::DeepImage::GetNP ( float * NP )

pure virtual

copy the projection matrix from this image to NP.

◆ GetNumChan()

virtual int RixDeepTexture::DeepImage::GetNumChan ( )

pure virtual

return the number of channels in this image

◆ GetPixel()

virtual int RixDeepTexture::DeepImage::GetPixel	(	int	x,
		int	y,
		DeepPixel *	pix
	)

pure virtual

Copy the pixel at position x,y into the given DeepPixel.

The DeepPixel is resized if necessary, and if the number of channels in pix is different than the number of channels in this image, pix is modified to match. Returns k_ErrNOERR if no error, k_ErrRANGE if the requested pixel outside the image, or k_ErrBADFILE if the file is found to be corrupt.

◆ GetTileHeight()

virtual int RixDeepTexture::DeepImage::GetTileHeight ( )

pure virtual

return the height of the tiles in this image, in pixels

◆ GetTileWidth()

virtual int RixDeepTexture::DeepImage::GetTileWidth ( )

pure virtual

return the width of the tiles in this image, in pixels

◆ GetWidth()

virtual int RixDeepTexture::DeepImage::GetWidth ( )

pure virtual

return the width of this image in pixels

◆ GetZRange()

virtual int RixDeepTexture::DeepImage::GetZRange	(	int	x,
		int	y,
		float *	min,
		float *	max
	)

pure virtual

Computes the range over which the specified pixel is defined.

If the pixel is non-empty, the range is returned in min and max and the function returns k_ErrNOERR. If the pixel is empty, k_ErrEMPTY is returned and min and max are undefined.

◆ SetPixel()

virtual int RixDeepTexture::DeepImage::SetPixel	(	int	x,
		int	y,
		DeepPixel *	pix
	)

pure virtual

Copy the given pixel into pixel x,y of the specified image.

pix must have either the same number of channels as img, or one channel. If pix has any unresolved compression state, k_ErrERR is returned. Take care to call pix->FinishPixel before you use SetPixel.

◆ SetPixelData()

virtual int RixDeepTexture::DeepImage::SetPixelData	(	int	x,
		int	y,
		int	numPoints,
		float *	data
	)

pure virtual

Copy the given pixel data into pixel x, y of the specified image.

numPoints indicates how many points there are. data should point to numPoints*(GetNumChan()+1) floats.

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

RixDeepTexture.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~DeepImage()

Member Function Documentation

◆ Eval()

◆ GetCompression()

◆ GetDataType()

◆ GetHeight()

◆ GetMeanDepth()

◆ GetMetadata()

◆ GetName()

◆ GetNl()

◆ GetNP()

◆ GetNumChan()

◆ GetPixel()

◆ GetTileHeight()

◆ GetTileWidth()

◆ GetWidth()

◆ GetZRange()

◆ SetPixel()

◆ SetPixelData()