FxGenerator

Introduction

Specifies the methods a generator plug-in needs to implement.

Discussion

This protocol inherits from the parent protocol FxBaseEffect, whose methods must be implemented by any type of plug-in.

Methods

-frameCleanup

Asks the plug-in to clean up any memory allocated in frameSetup:. Called after renderOutput:.

-frameSetup:hardware:software:

Determines the type of output image the plug-in requires. Called before renderOutput:.

-renderOutput:withInfo:

Renders output from a plug-in image.

Asks the plug-in to clean up any memory allocated in frameSetup:. Called after renderOutput:.

- (BOOL)frameCleanup; 

Return Value

YES if the cleanup is successful; NO otherwise.

Determines the type of output image the plug-in requires. Called before renderOutput:.

- (BOOL)frameSetup:(FxRenderInfo)renderInfo hardware:(BOOL *)canRenderHardware software:(BOOL *)canRenderSoftware;

Parameters

renderInfo

FxRenderInfo structure that defines the render request.

canRenderHardware

Set to YES if the frame can be rendered in hardware.

canRenderSoftware

Set to YES if the frame can be rendered in software.

Return Value

YES if frame setup is successful; NO otherwise.

Renders output from a plug-in image.

- (BOOL)renderOutput:(FxImage *)output withInfo:(FxRenderInfo)renderInfo; 

Parameters

output

Target image for final output.

renderInfo

Information about the render type the application is currently requesting.

Return Value

YES if the ouput image is correctly populated and processing is successful; NO otherwise.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-06-05