RenderMan API  23.0
RixDisplayFilter Class Referenceabstract

#include <RixDisplayFilter.h>

Inheritance diagram for RixDisplayFilter:
RixShadingPlugin

Public Member Functions

virtual int GetInterface () const override
 
virtual void Filter (RixDisplayFilterContext &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

 RixDisplayFilter ()
 
virtual ~RixDisplayFilter ()
 
- 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

RixDisplayFilter plugins sit between the framebuffer and the display system. They provide an opportunity to do some post-processing (such as compositing, color grading, etc.) on the raw pixel data before it goes off to a file or viewer. If rendering in incremental mode, note that the RixDisplayFilter may be invoked repeatedly on the same region.

Definition at line 55 of file RixDisplayFilter.h.

Constructor & Destructor Documentation

◆ RixDisplayFilter()

RixDisplayFilter::RixDisplayFilter ( )
inlineprotected

Definition at line 70 of file RixDisplayFilter.h.

◆ ~RixDisplayFilter()

virtual RixDisplayFilter::~RixDisplayFilter ( )
inlineprotectedvirtual

Definition at line 71 of file RixDisplayFilter.h.

Member Function Documentation

◆ Filter()

virtual void RixDisplayFilter::Filter ( RixDisplayFilterContext fCtx,
RtPointer  instanceData 
)
pure virtual

Filter is the primary entrypoint for this class. Filters the pixels from the framebuffer before they are output to the disply drivers. This will be invoked by the rendering threads and should be thread-safe and re-entrant.

◆ GetInterface()

virtual int RixDisplayFilter::GetInterface ( ) const
inlineoverridevirtual

Reimplemented from RixShadingPlugin.

Definition at line 58 of file RixDisplayFilter.h.


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