FilterContextInterface Class Reference

#include <filter_context.h>

Inheritance diagram for FilterContextInterface:

Public Member Functions
MAXON_METHOD Result< void >	Init (Opt< const DataDictionary & > dict={})
MAXON_METHOD Result< FilterImageRef >	CreateImage (const DataDictionary &imageDesc)
MAXON_METHOD Result< FilterRef >	CreateFilter (const LiteralId &filterType)
MAXON_METHOD Result< FilterCommandQueueRef >	CreateCommandQueue ()
MAXON_METHOD Result< void >	ExecuteCommandQueue (FilterCommandQueueRef commandQueue)

Private Member Functions
	MAXON_INTERFACE (FilterContextInterface, MAXON_REFERENCE_NORMAL, "net.maxon.renderfilter.filtercontext.interface")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( FilterContextInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.renderfilter.filtercontext.interface"    )

private

Init()

MAXON_METHOD Result<void> Init

(

Opt< const DataDictionary & >

dict = {}

)

Initializes the context

Parameters

[in]

dict

(Optional) input parameters

CreateImage()

MAXON_METHOD Result<FilterImageRef> CreateImage

(

const DataDictionary &

imageDesc

)

Creates an image matching the passed image description

Parameters

[in]

imageDesc

The image description

Returns

The created Image

CreateFilter()

MAXON_METHOD Result<FilterRef> CreateFilter

(

const LiteralId &

filterType

)

Creates a filter from a filter type identifier, for example:

maxon::FilterRef filter = filterContext.CreateFilter(maxon::FilterClasses::OIDNFILTERRT.GetId()) iferr_return;

Parameters

[in]

filterType

The type of the filter

Returns

The created Filter

CreateCommandQueue()

MAXON_METHOD Result<FilterCommandQueueRef> CreateCommandQueue

(

)

Creates a command queue

Returns

The created Command Queue

ExecuteCommandQueue()

MAXON_METHOD Result<void> ExecuteCommandQueue

(

FilterCommandQueueRef

commandQueue

)

Executes all the filters inside the command queue

Parameters

[in]

commandQueue

The command queue to execute