RenderMan API  23.0
RixSampleFilter Class Referenceabstract

#include <RixSampleFilter.h>

Inheritance diagram for RixSampleFilter:
RixShadingPlugin

Public Member Functions

virtual int GetInterface () const override
 
virtual void Filter (RixSampleFilterContext &fCtx, RtPointer instanceData)=0
 
- Public Member Functions inherited from RixShadingPlugin
virtual int GetVersion () const
 
virtual int Init (RixContext &ctx, RtUString const pluginPath)=0
 
virtual void Finalize (RixContext &ctx)=0
 
virtual RixSCParamInfo const * GetParamTable ()=0
 
virtual void Synchronize (RixContext &ctx, RixSCSyncMsg syncMsg, RixParameterList const *syncParams)=0
 
virtual void CreateInstanceData (RixContext &rixCtx, RtUString const handle, RixParameterList const *parameterList, InstanceData *instanceData)
 
virtual void SynchronizeInstanceData (RixContext &rixCtx, RtUString const handle, RixParameterList const *instanceParams, uint32_t const editHints, InstanceData *instanceData)
 

Protected Member Functions

 RixSampleFilter ()
 
virtual ~RixSampleFilter ()
 
- Protected Member Functions inherited from RixShadingPlugin
 RixShadingPlugin (int version)
 
virtual ~RixShadingPlugin ()
 

Additional Inherited Members

- Public Types inherited from RixShadingPlugin
enum  SynchronizeHints { k_None = 0x00000000, k_All = 0xFFFFFFFF }
 
- Protected Attributes inherited from RixShadingPlugin
int m_version
 

Detailed Description

RixSampleFilter plugins sit between the integrator and the framebuffer and filter the shaded camera samples. While everything they do could be done directly within an integrator, using RixSampleFilter plugins adds composibility. It's also probably the better place for applying non-physical effects.

Definition at line 55 of file RixSampleFilter.h.

Constructor & Destructor Documentation

◆ RixSampleFilter()

RixSampleFilter::RixSampleFilter ( )
inlineprotected

Definition at line 70 of file RixSampleFilter.h.

◆ ~RixSampleFilter()

virtual RixSampleFilter::~RixSampleFilter ( )
inlineprotectedvirtual

Definition at line 71 of file RixSampleFilter.h.

Member Function Documentation

◆ Filter()

virtual void RixSampleFilter::Filter ( RixSampleFilterContext fCtx,
RtPointer  instanceData 
)
pure virtual

Filter is the primary entrypoint for this class. Filters the shaded samples from the integrator before they are accumulated into the framebuffer. This will be invoked by the rendering threads and should be thread-safe and re-entrant.

◆ GetInterface()

virtual int RixSampleFilter::GetInterface ( ) const
inlineoverridevirtual

Reimplemented from RixShadingPlugin.

Definition at line 58 of file RixSampleFilter.h.


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