HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TIL_NullFilter Class Referencefinal

#include <TIL_NullFilter.h>

+ Inheritance diagram for TIL_NullFilter:

Public Member Functions

 TIL_NullFilter ()
 
 ~TIL_NullFilter () override
 
bool isInteractive () const override
 
const char * className () const override
 
bool setOptions (const UT_Options &argstr) override
 
bool apply (PXL_Raster *raster) override
 
bool apply (UT_Array< LayerData > &layersdata, bool upscale, bool firstframe) override
 
void reset () override
 
- Public Member Functions inherited from TIL_RasterFilter
void setAuxPlane (const UT_StringHolder &planename, const PXL_Raster *raster)
 
void setAuxPlane (const UT_StringHolder &planename, const RasterData &aux)
 
const UT_StringArraygetAuxPlaneNames () const
 Get the list of aux plane names. More...
 
const UT_StringHoldergetErrorString () const
 
virtual bool matchesDevice (uint8(&uuid)[16]) const
 
 TIL_RasterFilter ()
 
virtual ~TIL_RasterFilter ()
 

Additional Inherited Members

- Public Types inherited from TIL_RasterFilter
enum  AOVType {
  AT_NONE = 0, AT_BEAUTY, AT_SPECULAR, AT_REFLECT,
  AT_REFRACT, AT_DIFFUSE
}
 
enum  RasterDataTypes { RDT_PXL_RASTER, RDT_VK_BUFFER, RDT_RAW_CUDA }
 
using TIL_RasterFilterPtr = UT_UniquePtr< TIL_RasterFilter >
 
- Static Public Member Functions inherited from TIL_RasterFilter
static void setVulkanResolver (UT_UniquePtr< VulkanResolver >)
 
static VulkanResolvergetVulkanResolver ()
 
static AOVType stringToAOVType (const UT_StringHolder &type)
 
static void registerFactory (UT_UniquePtr< Factory > factory)
 
static void removeFactory (const UT_StringRef &name)
 Remove a factory from the list. More...
 
static void getFilters (UT_Array< const Factory * > &filters)
 Get a list of all the filters. More...
 
static TIL_RasterFilterPtr allocFilter (const UT_StringRef &name)
 
static const UT_StringHolderalbedoToken ()
 
static const UT_StringHoldernormalToken ()
 
static const UT_StringHoldermvectorToken ()
 
static const UT_StringHolderprevfrToken ()
 
- Protected Attributes inherited from TIL_RasterFilter
UT_StringArray myAuxPlaneNames
 
UT_StringMap< RasterDatamyAuxPlanes
 
UT_StringHolder myErrorString
 

Detailed Description

Sample code to install a pass-through Image Filter into Houdini

These filters can be used in:

  • Karma Image Filters
  • The AI Denoise COP
  • The idenoise application For example, after the code is build, the filters should appear when running idenoise -l.

To make this example, you can run:

hcustom -i ~/houdini/dso/img_filter TIL_NullFilter.C

To test the filter, you can try:

% idenoise -d null_filter --options '{"verbose":1,"test":3.2}"' Mandril.pic x.exr
% idenoise -d null_filter --normal N --extra_aovs P --options '{"verbose":1}"' Snail.pic x.exr
Examples:
IMG/TIL_NullFilter.h.

Definition at line 59 of file TIL_NullFilter.h.

Constructor & Destructor Documentation

TIL_NullFilter::TIL_NullFilter ( )
Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 36 of file TIL_NullFilter.C.

TIL_NullFilter::~TIL_NullFilter ( )
override
Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 56 of file TIL_NullFilter.C.

Member Function Documentation

bool TIL_NullFilter::apply ( PXL_Raster raster)
overridevirtual

Overridden methods from the base class

Implements TIL_RasterFilter.

Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 72 of file TIL_NullFilter.C.

bool TIL_NullFilter::apply ( UT_Array< LayerData > &  layersdata,
bool  upscale,
bool  firstframe 
)
overridevirtual

Overridden methods from the base class

Implements TIL_RasterFilter.

Definition at line 89 of file TIL_NullFilter.C.

const char* TIL_NullFilter::className ( ) const
inlineoverridevirtual

Overridden methods from the base class

Implements TIL_RasterFilter.

Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 67 of file TIL_NullFilter.h.

bool TIL_NullFilter::isInteractive ( ) const
inlineoverridevirtual

Since the filters run in a few milliseconds, they can be considered interactive.

Reimplemented from TIL_RasterFilter.

Examples:
IMG/TIL_NullFilter.h.

Definition at line 76 of file TIL_NullFilter.h.

void TIL_NullFilter::reset ( void  )
overridevirtual

Overridden methods from the base class

Reimplemented from TIL_RasterFilter.

Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 99 of file TIL_NullFilter.C.

bool TIL_NullFilter::setOptions ( const UT_Options argstr)
overridevirtual

Overridden methods from the base class

Reimplemented from TIL_RasterFilter.

Examples:
IMG/TIL_NullFilter.C, and IMG/TIL_NullFilter.h.

Definition at line 42 of file TIL_NullFilter.C.


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