FilterInterface Class Reference | C4D R23.110 C++ SDK - 中文文档编制,帮助,手册,教程

#include <filter.h>

Inheritance diagram for FilterInterface:

[ legend ]

详细描述

FilterInterface allows interfacing with the render filter.

公共成员函数
MAXON_METHOD Result < void >	Set (const InternedId ¶meter, const 数据 &data)
MAXON_METHOD Result < void >	Execute (const FilterImageRef &input, FilterImageRef output)
MAXON_METHOD Result < void >	SetProgressMonitor (const FilterProgressMonitorFunction progressMonitor, void *userPtr)

私有成员函数
	MAXON_INTERFACE ( FilterInterface , MAXON_REFERENCE_NORMAL , "net.maxon.renderfilter.filter.interface")

成员函数文档编制

◆ MAXON_INTERFACE()

MAXON_INTERFACE	(	FilterInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.renderfilter.filter.interface"
	)

private

◆ Set()

MAXON_METHOD Result <void> Set

(

const InternedId &

参数 ,

const 数据 &

data

)

Sets Filter parameter

参数

[in]	参数	Parameter to set
[in]	data	数据 for parameter

◆ Execute()

MAXON_METHOD Result <void> Execute

(

const FilterImageRef &

input ,

FilterImageRef

output

)

Executes the filter standalone.

参数

[in]	input	The input Filter Image
[in]	output	The target Filter Image

◆ SetProgressMonitor()

MAXON_METHOD Result <void> SetProgressMonitor

(

const FilterProgressMonitorFunction

progressMonitor ,

void *

userPtr

)

Sets a progress monitor function pointer that gets invoked during the filter execution. Only a single callback function can be registered, the next call to SetProgressMonitor overwrites the old one. The monitor function pointer gets called with provided userPtr and a progress in the range [0, 1]. Returning false within the monitor will cancel the filter execution.

参数

[in]	progressMonitor	The progress monitor function
[in]	userPtr	A custom user ptr that gets passed to the function pointer.