RenderMan API  23.0
RixDisplayFilterContext Class Referenceabstract

#include <RixDisplayFilter.h>

Inheritance diagram for RixDisplayFilterContext:
RixContext

Public Member Functions

virtual bool Read (RixChannelId id, int x, int y, RtColorRGB &value) const =0
 
virtual bool Read (RixChannelId id, int x, int y, float &value) const =0
 
virtual bool Read (RixChannelId id, int x, int y, int &value) const =0
 
virtual bool Write (RixChannelId id, int x, int y, RtColorRGB value)=0
 
virtual bool Write (RixChannelId id, int x, int y, float value)=0
 
virtual bool Write (RixChannelId id, int x, int y, int value)=0
 
virtual bool ReadRegion (RixChannelId id, int regionMinX, int regionMaxX, int regionMinY, int regionMaxY, RtColorRGB *values) const =0
 
virtual bool ReadRegion (RixChannelId id, int regionMinX, int regionMaxX, int regionMinY, int regionMaxY, float *values) const =0
 
virtual bool IsEnabled (RtConstPointer instance, RtPointer *instanceData) const =0
 
- Public Member Functions inherited from RixContext
virtual RixInterfaceGetRixInterface (RixInterfaceId id) const =0
 
virtual ~RixContext ()
 Destructor is for internal use only. More...
 

Public Attributes

int xmin
 
int xmax
 
int ymin
 
int ymax
 

Protected Member Functions

 RixDisplayFilterContext ()
 
virtual ~RixDisplayFilterContext ()
 

Detailed Description

Definition at line 82 of file RixDisplayFilter.h.

Constructor & Destructor Documentation

◆ RixDisplayFilterContext()

RixDisplayFilterContext::RixDisplayFilterContext ( )
inlineprotected

Definition at line 129 of file RixDisplayFilter.h.

◆ ~RixDisplayFilterContext()

virtual RixDisplayFilterContext::~RixDisplayFilterContext ( )
inlineprotectedvirtual

Definition at line 130 of file RixDisplayFilter.h.

Member Function Documentation

◆ IsEnabled()

virtual bool RixDisplayFilterContext::IsEnabled ( RtConstPointer  instance,
RtPointer instanceData 
) const
pure virtual

Determine whether or not the given instance of a sample filter is active. If so, the corresponding instanceData pointer is returned.

◆ Read() [1/3]

virtual bool RixDisplayFilterContext::Read ( RixChannelId  id,
int  x,
int  y,
RtColorRGB value 
) const
pure virtual

Read and write access to the pixel data. In multi-camera scenarios, some channel ids may be invalid depending on whether they are output for the current camera being filtered.

◆ Read() [2/3]

virtual bool RixDisplayFilterContext::Read ( RixChannelId  id,
int  x,
int  y,
float &  value 
) const
pure virtual

◆ Read() [3/3]

virtual bool RixDisplayFilterContext::Read ( RixChannelId  id,
int  x,
int  y,
int &  value 
) const
pure virtual

◆ ReadRegion() [1/2]

virtual bool RixDisplayFilterContext::ReadRegion ( RixChannelId  id,
int  regionMinX,
int  regionMaxX,
int  regionMinY,
int  regionMaxY,
RtColorRGB values 
) const
pure virtual

Read a completely arbitrary rectangular region of pixels into a user-provided buffer. The rectangle requested through this call may be outside of the area currently being filtered (though results will be more non-deterministic due to threading) and may even extended outside of the image. Zeroes will be returned where the region extends past the image boundaries.

◆ ReadRegion() [2/2]

virtual bool RixDisplayFilterContext::ReadRegion ( RixChannelId  id,
int  regionMinX,
int  regionMaxX,
int  regionMinY,
int  regionMaxY,
float *  values 
) const
pure virtual

◆ Write() [1/3]

virtual bool RixDisplayFilterContext::Write ( RixChannelId  id,
int  x,
int  y,
RtColorRGB  value 
)
pure virtual

◆ Write() [2/3]

virtual bool RixDisplayFilterContext::Write ( RixChannelId  id,
int  x,
int  y,
float  value 
)
pure virtual

◆ Write() [3/3]

virtual bool RixDisplayFilterContext::Write ( RixChannelId  id,
int  x,
int  y,
int  value 
)
pure virtual

Member Data Documentation

◆ xmax

int RixDisplayFilterContext::xmax

Definition at line 89 of file RixDisplayFilter.h.

◆ xmin

int RixDisplayFilterContext::xmin

Pixel coordinates of the area of the framebuffer to be filtered. This covers the [xmin,xmax)x[ymin,ymax) rectangle.

Definition at line 88 of file RixDisplayFilter.h.

◆ ymax

int RixDisplayFilterContext::ymax

Definition at line 91 of file RixDisplayFilter.h.

◆ ymin

int RixDisplayFilterContext::ymin

Definition at line 90 of file RixDisplayFilter.h.


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