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 Filter to the queue

Parameters
[in]filterFilter to enqueue
[in]inputInput Image to the filter
[in]outputOutput 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 Filter to the queue which will operate on a specific region of the image

Parameters
[in]filterFilter to enqueue
[in]inputInput Image to the filter
[in]outputOutput Image of the filter
[in]xStarting point x
[in]yStarting point y
[in]wWidth of region
[in]hHeight of region

◆ DetachFilter()

MAXON_METHOD Result<void> DetachFilter ( FilterRef  filter)

Dequeues filter

Parameters
[in]filterFilter to dequeue