RixDeepTexture Class Reference

#include <RixDeepTexture.h>

Inheritance diagram for RixDeepTexture:

Classes
class	DeepCache
class	DeepFile
class	DeepImage
class	DeepMetadata
class	DeepPixel

Public Types
enum	Compression {   k_CmpNone = 0, k_CmpRLE = 2, k_CmpLZW = 3, k_CmpHUFFMAN = 5,   k_CmpZIP = 6 }
enum	DataType {   k_TypeBYTE = 1, k_TypeSHORT = 2, k_TypeWORD = 3, k_TypeFLOAT = 4,   k_TypeHALF = 5 }
enum	ErrorCodes {   k_ErrNOMETADATA = -14, k_ErrBADCHANNEL = -13, k_ErrREADONLY = -12, k_ErrCAPACITY = -11,   k_ErrTILECOMPRESSION = -10, k_ErrUNFINISHED = -9, k_ErrRANGE = -8, k_ErrNOMEM = -7,   k_ErrEMPTY = -6, k_ErrNOIMAGE = -5, k_ErrUNSUPPORTED = -4, k_ErrBADFILE = -3,   k_ErrNOFILE = -2, k_ErrERR = -1, k_ErrNOERR = 0 }

Public Member Functions
virtual DeepCache *	CreateCache (int numTiles)=0
virtual int	DestroyCache (DeepCache *)=0
virtual int	CreateFile (const char *name, DeepCache *, DeepFile **result)=0
virtual int	IsDeepFile (const char *name, DeepCache *, int *version)=0
virtual int	OpenFile (const char *name, const char *mode, DeepCache *, DeepFile **result)=0
virtual int	DestroyFile (DeepFile *)=0
	Destroy a DeepFile produced by either OpenFile or CreateFile.
virtual DeepPixel *	CreatePixel (int numChan)=0
	Create a DeepPixel for use with DeepImage channel data.
virtual void	DestroyPixel (DeepPixel *)=0
	Destroy a DeepPixel.
Public Member Functions inherited from RixInterface
virtual int	GetVersion () const

Protected Member Functions
	RixDeepTexture ()
	Constructor is for internal use only.
Protected Member Functions inherited from RixInterface
	RixInterface (int version)
	Interfaces should not be constructed by users.
virtual	~RixInterface ()
	Interfaces should not be deleted by users.

Additional Inherited Members
Protected Attributes inherited from RixInterface
int	m_version
	Version number of this interface.

Detailed Description

RixDeepTexture

This interface provides the classes and methods necessary to create, load, and modify Pixar deep texture files. It maintains a tile cache, under the covers, making it possible to work on files without loading them entirely into memory.

The API supports an arbitrary number of images in a single file, each with its own resolution, tile size, and view matrices.

The library can read and write old deep shadow files in addition to newer, more general deep texture files. Deep shadow files are limited to a single sub-image, but otherwise have the same API as the newer interface.

Member Enumeration Documentation

enum RixDeepTexture::ErrorCodes

Enumerator
k_ErrNOMETADATA	Metadata entry was not found.
k_ErrBADCHANNEL	Channel mismatch between pixels or tiles
k_ErrREADONLY	Attempt to modify file loaded as read only
k_ErrCAPACITY	Tried to go past 2GB on a small capacity file
k_ErrTILECOMPRESSION	Error during tile compression.
k_ErrUNFINISHED	Illegal operation on pixel with unresolved compression state
k_ErrRANGE	Out of range parameter.
k_ErrNOMEM	Ran out of memory.
k_ErrEMPTY	Illegal operation on an empty structure
k_ErrNOIMAGE	The specified image was not found.
k_ErrUNSUPPORTED	The specified operation is not supported.
k_ErrBADFILE	File was corrupt.
k_ErrNOFILE	File was not found or was invalid.
k_ErrERR	File was not found or was invalid.
k_ErrNOERR	No worries.

Member Function Documentation

virtual DeepCache* RixDeepTexture::CreateCache ( int  numTiles)

pure virtual

Create a new tile cache. This cache can be associated with one more more images and enables out-of-core DeepFile manipulation.

virtual int RixDeepTexture::CreateFile ( const char *  name, DeepCache *  , DeepFile **  result  )

pure virtual

Open a deep texture file with the given filename, managed by the given cache.

virtual int RixDeepTexture::DestroyCache ( DeepCache *  )

pure virtual

Destroy a cache. This must not be called until all open files associated with the cache have been destroyed.

virtual int RixDeepTexture::IsDeepFile ( const char *  name, DeepCache *  , int *  version  )

pure virtual

Open and file and check whether it appears to be a deep texture. Returns k_ErrNOERR and sets version to the file format version if the named file is a deep texture.

virtual int RixDeepTexture::OpenFile ( const char *  name, const char *  mode, DeepCache *  , DeepFile **  result  )

pure virtual

Open a deep texture file with the given filename, managed by the given cache.

---

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

• RixDeepTexture.h