RenderMan API  23.0
RixSampleFilterContext Class Referenceabstract

#include <RixSampleFilter.h>

Inheritance diagram for RixSampleFilterContext:
RixContext

Public Member Functions

virtual bool Read (RixChannelId id, int sample, RtColorRGB &value) const =0
 
virtual bool Read (RixChannelId id, int sample, float &value) const =0
 
virtual bool Read (RixChannelId id, int sample, int &value) const =0
 
virtual bool Write (RixChannelId id, int sample, RtColorRGB value)=0
 
virtual bool Write (RixChannelId id, int sample, float value)=0
 
virtual bool Write (RixChannelId id, int sample, 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 int GetAttribute (int sample, RtUString const name, void *result, int resultLen, RixInterface::Type *resultType, int *resultCount) 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 numSamples
 
int numAllSamples
 With extras add by RixDisplayServices::AddSample() More...
 
RtPoint2 const * screen
 
float const * shutter
 
RtRayGeometry const * rays
 
int numGrps
 
RixShadingContext const ** shadeCtxs
 
float const * depths
 
int const * originals
 

Protected Member Functions

 RixSampleFilterContext ()
 
virtual ~RixSampleFilterContext ()
 

Detailed Description

Definition at line 82 of file RixSampleFilter.h.

Constructor & Destructor Documentation

◆ RixSampleFilterContext()

RixSampleFilterContext::RixSampleFilterContext ( )
inlineprotected

Definition at line 167 of file RixSampleFilter.h.

◆ ~RixSampleFilterContext()

virtual RixSampleFilterContext::~RixSampleFilterContext ( )
inlineprotectedvirtual

Definition at line 168 of file RixSampleFilter.h.

Member Function Documentation

◆ GetAttribute()

virtual int RixSampleFilterContext::GetAttribute ( int  sample,
RtUString const  name,
void *  result,
int  resultLen,
RixInterface::Type resultType,
int *  resultCount 
) const
pure virtual

Similar to RixRenderState::GetAttribute(), but looks up an attribute for a single ray sample. Additional return value of -2 indicates the ray was a miss.

◆ IsEnabled()

virtual bool RixSampleFilterContext::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 RixSampleFilterContext::Read ( RixChannelId  id,
int  sample,
RtColorRGB value 
) const
pure virtual

Read and write access to sample data. Returns true on success. 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 RixSampleFilterContext::Read ( RixChannelId  id,
int  sample,
float &  value 
) const
pure virtual

◆ Read() [3/3]

virtual bool RixSampleFilterContext::Read ( RixChannelId  id,
int  sample,
int &  value 
) const
pure virtual

◆ ReadRegion() [1/2]

virtual bool RixSampleFilterContext::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 RixSampleFilterContext::ReadRegion ( RixChannelId  id,
int  regionMinX,
int  regionMaxX,
int  regionMinY,
int  regionMaxY,
float *  values 
) const
pure virtual

◆ Write() [1/3]

virtual bool RixSampleFilterContext::Write ( RixChannelId  id,
int  sample,
RtColorRGB  value 
)
pure virtual

◆ Write() [2/3]

virtual bool RixSampleFilterContext::Write ( RixChannelId  id,
int  sample,
float  value 
)
pure virtual

◆ Write() [3/3]

virtual bool RixSampleFilterContext::Write ( RixChannelId  id,
int  sample,
int  value 
)
pure virtual

Member Data Documentation

◆ depths

float const* RixSampleFilterContext::depths

Extra samples added by the integrator (see numAllSamples above) may have their own depths along the ray. It can also be helpful to know the index of the original ray/sample to which it was added.

Definition at line 119 of file RixSampleFilter.h.

◆ numAllSamples

int RixSampleFilterContext::numAllSamples

With extras add by RixDisplayServices::AddSample()

Definition at line 86 of file RixSampleFilter.h.

◆ numGrps

int RixSampleFilterContext::numGrps

Shading groups. Sample filters may use these to inquire about shading information at the end of the camera rays. May be null.

Definition at line 112 of file RixSampleFilter.h.

◆ numSamples

int RixSampleFilterContext::numSamples

Definition at line 85 of file RixSampleFilter.h.

◆ originals

int const* RixSampleFilterContext::originals

Definition at line 120 of file RixSampleFilter.h.

◆ rays

RtRayGeometry const* RixSampleFilterContext::rays

The camera rays that were traced. Origin and direction are defined in terms of camera space with the camera centered at the origin and looking down the +Z axis. May be null.

Definition at line 107 of file RixSampleFilter.h.

◆ screen

RtPoint2 const* RixSampleFilterContext::screen

The screen samples represent samples in screen space with subpixel precision. For typical wide screen images, these will be in the [-aspect,aspect)x[-1,1) rectangle. The exact range depends on the combination of RiFormat, RiFrameAspectRatio, RiScreenWindow, and RiCropWindow settings.

Definition at line 94 of file RixSampleFilter.h.

◆ shadeCtxs

RixShadingContext const** RixSampleFilterContext::shadeCtxs

Definition at line 113 of file RixSampleFilter.h.

◆ shutter

float const* RixSampleFilterContext::shutter

The shutter samples are time samples in the [0,1) range, with a density distribution according to the the shaped "shutteropening" parameter on the RiCamera line. These are interpreted relative to shutter open at 0 and shutter close at 1. May be null.

Definition at line 101 of file RixSampleFilter.h.


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