RenderMan API  23.0
Public Member Functions | Protected Member Functions | List of all members
RixDeepTexture::DeepFile Class Referenceabstract

#include <RixDeepTexture.h>

Public Member Functions

virtual int FileVersion ()=0
 Return the format version of the given file. More...
 
virtual DeepMetadata * GetMetadata ()=0
 
virtual int CountImages ()=0
 Return the number of images in this file. More...
 
virtual int AddImage (const char *name, int numChan, int w, int h, int tileW, int tileH, float *NP, float *Nl, Compression, DataType, DeepImage **result)=0
 Add an image to this file. More...
 
virtual int AddImage (const char *name, int numChan, int w, int h, int tileW, int tileH, float *NP, float *Nl, Compression, DataType, const char *formatType, int formatVersion, DeepImage **result)=0
 
virtual int GetImageByName (const char *, DeepImage **result)=0
 
virtual int GetImageByIndex (int, DeepImage **result)=0
 
virtual int Close ()=0
 Close this file, writing out all modified tiles. More...
 
virtual int Sync ()=0
 

Protected Member Functions

virtual ~DeepFile ()
 Internal only. Use RixDeepTexture::DestroyFile. More...
 

Detailed Description

DeepFile

This object allows the manipulation of the DeepImage contents of a deep texture file. A DeepFile can contain multiple DeepImage objects.

Definition at line 168 of file RixDeepTexture.h.

Constructor & Destructor Documentation

◆ ~DeepFile()

virtual RixDeepTexture::DeepFile::~DeepFile ( )
inlineprotectedvirtual

Internal only. Use RixDeepTexture::DestroyFile.

Definition at line 172 of file RixDeepTexture.h.

Member Function Documentation

◆ AddImage() [1/2]

virtual int RixDeepTexture::DeepFile::AddImage ( const char *  name,
int  numChan,
int  w,
int  h,
int  tileW,
int  tileH,
float *  NP,
float *  Nl,
Compression  ,
DataType  ,
DeepImage **  result 
)
pure virtual

Add an image to this file.

◆ AddImage() [2/2]

virtual int RixDeepTexture::DeepFile::AddImage ( const char *  name,
int  numChan,
int  w,
int  h,
int  tileW,
int  tileH,
float *  NP,
float *  Nl,
Compression  ,
DataType  ,
const char *  formatType,
int  formatVersion,
DeepImage **  result 
)
pure virtual

Add an image to this file. Additionally takes a formattype and formatversion to automatically add to the metadata.

◆ Close()

virtual int RixDeepTexture::DeepFile::Close ( )
pure virtual

Close this file, writing out all modified tiles.

◆ CountImages()

virtual int RixDeepTexture::DeepFile::CountImages ( )
pure virtual

Return the number of images in this file.

◆ FileVersion()

virtual int RixDeepTexture::DeepFile::FileVersion ( )
pure virtual

Return the format version of the given file.

◆ GetImageByIndex()

virtual int RixDeepTexture::DeepFile::GetImageByIndex ( int  ,
DeepImage **  result 
)
pure virtual

Return the nth image from this file. Returns k_ErrNOFILE if the file doesn't exist, or k_ErrNOIMAGE if the indexed image doesn't exist. The resulting pointer is guaranteed to be valid until Close() is called on this file.

◆ GetImageByName()

virtual int RixDeepTexture::DeepFile::GetImageByName ( const char *  ,
DeepImage **  result 
)
pure virtual

If the this contains an image with the given name, return a pointer to it. Returns k_ErrNOIMAGE if the named image doesn't exist. The resulting pointer is guaranteed to be valid until Close() is called on this file.

◆ GetMetadata()

virtual DeepMetadata* RixDeepTexture::DeepFile::GetMetadata ( )
pure virtual

Get a handle to the image-specific metadata. May be null on older files.

◆ Sync()

virtual int RixDeepTexture::DeepFile::Sync ( )
pure virtual

Write out all modified tiles of this file causing the file on disk to reflect any changes that have been made.

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