#include <RixDisplayFilter.h>

Inherits RixContext.

Public Member Functions
virtual bool	Read (RixChannelId id, int x, int y, RtColorRGB &value) const =0
	Read and write access to the pixel data. More...

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
	Read a completely arbitrary rectangular region of pixels into a user-provided buffer. More...

virtual bool	ReadRegion (RixChannelId id, int regionMinX, int regionMaxX, int regionMinY, int regionMaxY, float *values) const =0

virtual bool	IsEnabled (void const instance, void *instanceData) const =0
	Determine whether or not the given instance of a sample filter is active. More...

virtual RixInterface *	GetRixInterface (RixInterfaceId id) const =0
	Get the specified interface from this context. More...

Public Attributes
int	xmin
	Pixel coordinates of the area of the framebuffer to be filtered. More...

int	xmax

int	ymin

int	ymax

Protected Member Functions
	RixDisplayFilterContext ()

	~RixDisplayFilterContext () override

Constructor & Destructor Documentation

RixDisplayFilterContext::RixDisplayFilterContext ( )

inlineprotected

RixDisplayFilterContext::~RixDisplayFilterContext ( )

inlineoverrideprotected

Member Function Documentation

virtual RixInterface* RixContext::GetRixInterface ( RixInterfaceId id) const

pure virtualinherited

Get the specified interface from this context.

The generic interface that is returned must be cast to the appropriate type before use.

Referenced by RixIES::ReadIESProfile(), RixBXLookupLobeByName(), RixDebugBasis(), RixGetSceneColorSpace(), RixIsHoldout(), and RixIsMatte().

virtual bool RixDisplayFilterContext::IsEnabled	(	void const *	instance,
		void **	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.

Parameters

[in]	instance	Blind data pointer of display filter instance. This pointer is returned by RixParameterList::EvalParam.
[out]	instanceData	The instanced data for the display filter instance.

Returns: true when the instance is active

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.

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

pure virtual

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

pure virtual

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.

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

pure virtual

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

pure virtual

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

pure virtual

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

pure virtual

Member Data Documentation

int RixDisplayFilterContext::xmax

int RixDisplayFilterContext::xmin

Pixel coordinates of the area of the framebuffer to be filtered.

This covers the [xmin,xmax)x[ymin,ymax) rectangle.

int RixDisplayFilterContext::ymax

int RixDisplayFilterContext::ymin

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

RixDisplayFilter.h

Public Member Functions

Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation