Apple Developer Connection
Advanced Search
Member Login Log In | Not a Member? Contact ADC
ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference

 


FxBaseEffect.h

Introduction

Defines the FxBaseEffect protocol.

Discussion

This header defines the parent protocol inherited by all effect protocols: FxGenerator, FxFilter, and FxTransition.



Protocols

FxBaseEffect
Specifies the methods that all plug-ins need to implement.


#defines


kFxPropertyKey_EquivalentSMPTEWipeCode


Key for properties dictionary

#define kFxPropertyKey_EquivalentSMPTEWipeCode @"EquivalentSMPTEWipeCode" 
Discussion

The value for this key is an integer NSNumber defining a fall-back SMPTE wipe code to be used for EDL creation. The default value is 0, meaning there is no equivalent wipe code.


kFxPropertyKey_MayRemapTime


Key for properties dictionary

#define kFxPropertyKey_MayRemapTime @"MayRemapTime" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not this plug-in may try to sample its input image(s) at any time other than the output time. The default value is YES.


kFxPropertyKey_PixelIndependent


Key for properties dictionary

#define kFxPropertyKey_PixelIndependent @"PixelIndependent" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not each pixel of this plug-in's output image depends only on the value of the corresponding pixel in the input image(s) and on no other pixels. This flag is used for performance optimization and for determining whether or not the plug-in can operate on single fields as well as complete interleaved frames. The default value is NO.


kFxPropertyKey_PreservesAlpha


Key for properties dictionary

#define kFxPropertyKey_PreservesAlpha @"PreservesAlpha" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not this plug-in promises to leave the alpha channel values of its input image(s) untouched. The default value is NO.


kFxPropertyKey_SupportsR408


Key for properties dictionary

#define kFxPropertyKey_SupportsR408 @"SupportsR408" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not this plug-in supports the r408 pixel format. The default value is NO.


kFxPropertyKey_SupportsR4fl


Key for properties dictionary

#define kFxPropertyKey_SupportsR4fl @"SupportsR4fl" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not this plug-in supports the r4fl pixel format. The default value is NO.


kFxPropertyKey_SupportsRowBytes


Key for properties dictionary

#define kFxPropertyKey_SupportsRowBytes @"SupportsRowBytes" 
Discussion

The value for this key is a Boolean NSNumber indicating whether or not this plug-in can support FxBitmaps with rowBytes != (width * depth / 8 * activeChannels). The default value is NO.




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