All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BRAY_SampleFilter Class Referenceabstract

#include <BRAY_SampleFilter.h>

+ Inheritance diagram for BRAY_SampleFilter:


class  Factory
class  SampleData
 Sample data for processing. More...

Public Types

using FactoryPtr = UT_UniquePtr< Factory >

Public Member Functions

 BRAY_SampleFilter (const UT_Options *o)
 ~BRAY_SampleFilter () override
virtual void filter (SampleData &data, size_t npixels) const =0
- Public Member Functions inherited from BRAY_FilterBase
 BRAY_FilterBase (const UT_Options *o)
virtual ~BRAY_FilterBase ()
virtual const char * className () const =0
 Return an identifier for this plugin. More...
void initialize (BRAY_FilterInit &init, const UT_StringArray &all_aovs)
SYS_HashType optionsHash () const
 Hash of the options passed to the constructor. More...
virtual bool getAOVs (BRAY_FilterInit &init, const UT_StringArray &available, UT_StringArray &write, UT_StringArray &read)=0
virtual const UT_StringHoldererrorMessage () const
UT_StringHolder makeError (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2
 Convenience method to add an error using printf style formatting. More...
const UT_StringArraywritePlanes () const
const UT_StringArrayreadPlanes () const

Static Public Member Functions

static void listFactories (UT_StringArray &result)
static void registerPlugin (const UT_StringHolder &name, FactoryPtr factory)
static UT_UniquePtr
< BRAY_SampleFilter
instancePlugin (const UT_StringRef &style, const UT_Options *options=nullptr)
static void releasePlugin (UT_UniquePtr< BRAY_SampleFilter > p)
static void freePluginCache ()

Detailed Description

Sample filters take raw samples as generated by the renderer and can adjust the sample data values prior to sending it to pixel filtering.

Definition at line 27 of file BRAY_SampleFilter.h.

Member Typedef Documentation

Constructor & Destructor Documentation

BRAY_SampleFilter::BRAY_SampleFilter ( const UT_Options o)

Definition at line 55 of file BRAY_SampleFilter.h.

BRAY_SampleFilter::~BRAY_SampleFilter ( )

Member Function Documentation

virtual void BRAY_SampleFilter::filter ( SampleData data,
size_t  npixels 
) const
pure virtual

Process the sample data. Each AOV plane of the data will point to a contiguous array of sample data which contains at least npixels of data. The filter should be applied to each pixel in the sample data.

static void BRAY_SampleFilter::freePluginCache ( )

Access to factory

static UT_UniquePtr<BRAY_SampleFilter> BRAY_SampleFilter::instancePlugin ( const UT_StringRef style,
const UT_Options options = nullptr 

Access to factory

static void BRAY_SampleFilter::listFactories ( UT_StringArray result)

Access to factory

static void BRAY_SampleFilter::registerPlugin ( const UT_StringHolder name,
FactoryPtr  factory 

Access to factory

static void BRAY_SampleFilter::releasePlugin ( UT_UniquePtr< BRAY_SampleFilter p)

Access to factory

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