HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PXL_DeepCompressor Class Referenceabstract

#include <PXL_DeepCompressor.h>

Classes

class  Factory
 

Public Member Functions

 PXL_DeepCompressor ()
 
virtual ~PXL_DeepCompressor ()
 
virtual PXL_DeepChannelListPtr channels () const =0
 Return the channels as a result of the compress() operation. More...
 
PXL_DeepSampleListPtr merge (const PXL_DeepSampleListPtr *slist, int nsamples) const
 
PXL_DeepSampleListPtr merge (const UT_Array< PXL_DeepSampleListPtr > &slist) const
 
PXL_DeepSampleListPtr compress (const PXL_DeepSampleListPtr &slist) const
 Compress a single sample list, returning a new sample list. More...
 
void dump (const char *msg="") const
 

Protected Member Functions

virtual const char * className () const =0
 
virtual PXL_DeepSampleListPtr doMerge (const PXL_DeepSampleListPtr *slist, int nsamples) const =0
 
virtual PXL_DeepSampleListPtr doCompress (const PXL_DeepSampleListPtr &samples) const =0
 Compress a single sample list, returning a new sample list. More...
 
virtual void doDump () const
 Dump any optional information to stdout. More...
 

Detailed Description

Combines a set of deep sample lists to create a single new deep sample list.

Deep compressors take multiple sample lists and combine them, possibly compressing them into a single deep sample list. The compressor may sit between the renderer and a deep image writer. Or it may be used to create MIP Maps for deep images.

When used by a renderer, compressors have the ability to add or modify channels.

Factory compressors include:

Name = "default Options:

  • zbias

Definition at line 46 of file PXL_DeepCompressor.h.

Constructor & Destructor Documentation

PXL_DeepCompressor::PXL_DeepCompressor ( )
virtual PXL_DeepCompressor::~PXL_DeepCompressor ( )
virtual

Member Function Documentation

virtual PXL_DeepChannelListPtr PXL_DeepCompressor::channels ( ) const
pure virtual

Return the channels as a result of the compress() operation.

virtual const char* PXL_DeepCompressor::className ( ) const
protectedpure virtual
PXL_DeepSampleListPtr PXL_DeepCompressor::compress ( const PXL_DeepSampleListPtr slist) const
inline

Compress a single sample list, returning a new sample list.

Definition at line 107 of file PXL_DeepCompressor.h.

virtual PXL_DeepSampleListPtr PXL_DeepCompressor::doCompress ( const PXL_DeepSampleListPtr samples) const
protectedpure virtual

Compress a single sample list, returning a new sample list.

virtual void PXL_DeepCompressor::doDump ( ) const
protectedvirtual

Dump any optional information to stdout.

virtual PXL_DeepSampleListPtr PXL_DeepCompressor::doMerge ( const PXL_DeepSampleListPtr slist,
int  nsamples 
) const
protectedpure virtual

Merge multiple deep sample lists into a single deep sample list. For example, this is done when creating MIP maps.

void PXL_DeepCompressor::dump ( const char *  msg = "") const
PXL_DeepSampleListPtr PXL_DeepCompressor::merge ( const PXL_DeepSampleListPtr slist,
int  nsamples 
) const
inline

Compress the samples provided into a single PXL_DeepSampleListPtr. The samples array will contain pixel.myPixelResolution.x() * pixel.myPixelResolution.y() entries.

Definition at line 95 of file PXL_DeepCompressor.h.

PXL_DeepSampleListPtr PXL_DeepCompressor::merge ( const UT_Array< PXL_DeepSampleListPtr > &  slist) const
inline

Definition at line 100 of file PXL_DeepCompressor.h.


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