FilterCommandQueueInterface Class Reference

#include <filter_command_queue.h>

Inheritance diagram for FilterCommandQueueInterface:

Detailed Description

A Filter Command queue allows queuing of multiple filter's of the same context.

Public Member Functions
MAXON_METHOD Result< void >	AttachFilter (FilterRef filter, FilterImageRef input, FilterImageRef output)
MAXON_METHOD Result< void >	AttachFilterRect (FilterRef filter, FilterImageRef input, FilterImageRef output, UInt32 x, UInt32 y, UInt32 w, UInt32 h)
MAXON_METHOD Result< void >	DetachFilter (FilterRef filter)

Private Member Functions
	MAXON_INTERFACE (FilterCommandQueueInterface, MAXON_REFERENCE_NORMAL, "net.maxon.renderfilter.filtercommandqueue.interface")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( FilterCommandQueueInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.renderfilter.filtercommandqueue.interface"    )

private

AttachFilter()

MAXON_METHOD Result<void> AttachFilter	(	FilterRef	filter,
		FilterImageRef	input,
		FilterImageRef	output
	)

Enqueues a filter to the filter queue

Parameters

[in]	filter	Filter to enqueue
[in]	input	Input Image to the filter
[in]	output	Output Image of the filter

AttachFilterRect()

MAXON_METHOD Result<void> AttachFilterRect	(	FilterRef	filter,
		FilterImageRef	input,
		FilterImageRef	output,
		UInt32	x,
		UInt32	y,
		UInt32	w,
		UInt32	h
	)

Enqueues a filter to the filter queue which will operate on a specific region of the image

Parameters

[in]	filter	Filter to enqueue
[in]	input	Input Image to the filter
[in]	output	Output Image of the filter
[in]	x	Starting point x
[in]	y	Starting point y
[in]	w	Width of region
[in]	h	Height of region

DetachFilter()

MAXON_METHOD Result<void> DetachFilter

(

FilterRef

filter

)

Dequeues a filter from the filter queue

Parameters

[in]

filter

Filter to dequeue