FxPlug SDK 1.2.3 Reference

Reference documentation for the FxPlug SDK 1.2.3.



Functions

+[ Fx3DAPI cameraMatrixAtTime: ]
  +[ FxParameterCreationAPI addAngleSliderWithName:parmId:defaultValue:parameterMin:parameterMax:parmFlags: ]
+[ Fx3DAPI focalLengthAtTime: ]
  +[ FxParameterCreationAPI addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parmFlags: ]
+[ Fx3DAPI is3D ]
  +[ FxParameterCreationAPI addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:parmFlags: ]
+[ Fx3DAPI layerMatrixAtTime: ]
  +[ FxParameterCreationAPI addCustomParameterWithName:parmId:defaultValue:parmFlags: ]
+[ FxBaseEffect addParameters ]
  +[ FxParameterCreationAPI addFloatSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags: ]
+[ FxBaseEffect parameterChanged: ]
  +[ FxParameterCreationAPI addImageReferenceWithName:parmId:parmFlags: ]
+[ FxBaseEffect properties ]
  +[ FxParameterCreationAPI addIntSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags: ]
+[ FxBaseEffect variesOverTime ]
  +[ FxParameterCreationAPI addPointParameterWithName:parmId:defaultX:defaultY:parmFlags: ]
-[ FxBitmap dataPtr ]
  +[ FxParameterCreationAPI addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags: ]
-[ FxBitmap dataPtrForPositionX:Y: ]
  +[ FxParameterCreationAPI addToggleButtonWithName:parmId:defaultValue:parmFlags: ]
-[ FxBitmap initWithCopy: ]
  +[ FxParameterCreationAPI endParameterSubGroup ]
-[ FxBitmap initWithInfo: ]
  +[ FxParameterCreationAPI startParameterSubGroup:parmId:parmFlags: ]
-[ FxBitmap initWithInfo:andData: ]
  +[ FxParameterCreationAPI_v2 addStringParameterWithName:parmId:defaultValue:parmFlags: ]
-[ FxBitmap initWithInfo:andRowBytes:andData: ]
  +[ FxParameterRetrievalAPI getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: ]
-[ FxBitmap rowBytes ]
  +[ FxParameterRetrievalAPI getBoolValue:fromParm:atTime: ]
-[ FxBitmap setDataPtr: ]
  +[ FxParameterRetrievalAPI getCustomParameterValue:fromParm: ]
-[ FxBitmap setRowBytes: ]
  +[ FxParameterRetrievalAPI getFloatValue:fromParm:atTime: ]
+[ FxCustomParameterActionAPI currentTime ]
  +[ FxParameterRetrievalAPI getIntValue:fromParm:atTime: ]
+[ FxCustomParameterActionAPI endAction: ]
  +[ FxParameterRetrievalAPI getParameterFlags:fromParm: ]
+[ FxCustomParameterActionAPI startAction: ]
  +[ FxParameterRetrievalAPI getRedValue:GreenValue:BlueValue:AlphaValue:fromParm:atTime: ]
+[ FxCustomParameterViewHost createViewForParm: ]
  +[ FxParameterRetrievalAPI getRedValue:GreenValue:BlueValue:fromParm:atTime: ]
+[ FxFilter frameCleanup ]
  +[ FxParameterRetrievalAPI getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: ]
+[ FxFilter frameSetup:inputInfo:hardware:software: ]
  +[ FxParameterRetrievalAPI getXValue:YValue:fromParm:atTime: ]
+[ FxFilter getOutputWidth:height:withInput:withInfo: ]
  +[ FxParameterRetrievalAPI_v2 getStringParameterValue:fromParm: ]
+[ FxFilter renderOutput:withInput:withInfo: ]
  +[ FxParameterSettingAPI setBoolValue:toParm:atTime: ]
+[ FxGenerator frameCleanup ]
  +[ FxParameterSettingAPI setCustomParameterValue:toParm: ]
+[ FxGenerator frameSetup:hardware:software: ]
  +[ FxParameterSettingAPI setFloatValue:toParm:atTime: ]
+[ FxGenerator renderOutput:withInfo: ]
  +[ FxParameterSettingAPI setIntValue:toParm:atTime: ]
-[ FxHostCapabilities formatsFloatRGBABitmapsAsARGB ]
  +[ FxParameterSettingAPI setParameterFlags:toParm: ]
-[ FxHostCapabilities glContextPixelFormatAttributes ]
  +[ FxParameterSettingAPI setRedValue:GreenValue:BlueValue:AlphaValue:toParm:atTime: ]
-[ FxHostCapabilities hostID ]
  +[ FxParameterSettingAPI setRedValue:GreenValue:BlueValue:toParm:atTime: ]
-[ FxHostCapabilities hostIsFCE ]
  +[ FxParameterSettingAPI setXValue:YValue:toParm:atTime: ]
-[ FxHostCapabilities hostIsFCP ]
  +[ FxParameterSettingAPI_v2 setStringParameterValue:toParm: ]
-[ FxHostCapabilities hostIsMotion ]
  +[ FxProgressAPI updateProgress: ]
-[ FxHostCapabilities hostVersionNumber ]
  +[ FxProgressAPI userHasCancelled ]
-[ FxHostCapabilities initWithAPIManager: ]
  +[ FxTemporalImageAPI getInputBitmap:withInfo:atTime: ]
-[ FxHostCapabilities notifiesParameterChangedForGenerators ]
  +[ FxTemporalImageAPI getInputTexture:withInfo:atTime: ]
-[ FxHostCapabilities parameterChangedUsableForAllParameters ]
  +[ FxTemporalImageAPI getSourceBitmap:withInfo:atTime: ]
-[ FxHostCapabilities supportsDisabledParameters ]
  +[ FxTemporalImageAPI getSourceTexture:withInfo:atTime: ]
-[ FxHostCapabilities supportsGroupParameters ]
  +[ FxTemporalTransitionImageAPI getTransitionInputImage:forInput:applyFilters:withImageType:withInfo:atTime: ]
-[ FxHostCapabilities supportsHiddenParameters ]
  -[ FxTexture bind ]
-[ FxHostCapabilities supportsTemporalBitmaps ]
  -[ FxTexture createData:withType: ]
-[ FxHostCapabilities timeBase ]
  -[ FxTexture disable ]
-[ FxHostCapabilities upscalesFields ]
  -[ FxTexture draw ]
-[ FxImage bytes ]
  -[ FxTexture enable ]
-[ FxImage colorInfo ]
  -[ FxTexture getTextureCoords:right:bottom:top: ]
-[ FxImage containsPointX:Y: ]
  -[ FxTexture initWithInfo: ]
-[ FxImage depth ]
  -[ FxTexture initWithInfo:andData: ]
-[ FxImage field ]
  -[ FxTexture initWithInfo:andTextureId: ]
-[ FxImage fieldOrder ]
  -[ FxTexture setAsActiveTexture ]
-[ FxImage height ]
  -[ FxTexture setData: ]
-[ FxImage imageInfo ]
  -[ FxTexture setTarget: ]
-[ FxImage imageType ]
  -[ FxTexture setTextureCoords:right:bottom:top: ]
-[ FxImage initWithInfo: ]
  -[ FxTexture setTextureId: ]
-[ FxImage isPremultiplied ]
  -[ FxTexture target ]
-[ FxImage numActiveChannels ]
  -[ FxTexture textureId ]
-[ FxImage origin ]
  +[ FxTimingAPI durationForEffect: ]
-[ FxImage pixelAspect ]
  +[ FxTimingAPI durationOfImageParm:forEffect: ]
-[ FxImage pixelFormat ]
  +[ FxTimingAPI durationOfInputAToTransition: ]
-[ FxImage setBytes: ]
  +[ FxTimingAPI durationOfInputBToTransition: ]
-[ FxImage setDepth: ]
  +[ FxTimingAPI durationOfInputToFilter: ]
-[ FxImage setField: ]
  +[ FxTimingAPI fieldOrderForImageParm:forEffect: ]
-[ FxImage setFieldOrder: ]
  +[ FxTimingAPI fieldOrderForInputAToTransition: ]
-[ FxImage setHeight: ]
  +[ FxTimingAPI fieldOrderForInputBToTransition: ]
-[ FxImage setImageType: ]
  +[ FxTimingAPI fieldOrderForInputToFilter: ]
-[ FxImage setIsPremultiplied: ]
  +[ FxTimingAPI imageTimeForParmId:forEffect:fromTimelineTime: ]
-[ FxImage setNumActiveChannels: ]
  +[ FxTimingAPI inPointOfTimelineForEffect: ]
-[ FxImage setOrigin: ]
  +[ FxTimingAPI inputATimeForTransition:fromTimelineTime: ]
-[ FxImage setPixelAspect: ]
  +[ FxTimingAPI inputBTimeForTransition:fromTimelineTime: ]
-[ FxImage setPixelFormat: ]
  +[ FxTimingAPI inputTimeForFilter:fromTimelineTime: ]
-[ FxImage setWidth: ]
  +[ FxTimingAPI outPointOfTimelineForEffect: ]
-[ FxImage setWidth:andHeight: ]
  +[ FxTimingAPI startTimeForEffect: ]
-[ FxImage size ]
  +[ FxTimingAPI startTimeOfImageParm:forEffect: ]
-[ FxImage width ]
  +[ FxTimingAPI startTimeOfInputAToTransition: ]
+[ FxLayerInfoAPI getLayerGlobalOffsetX:OffsetY:atTime: ]
  +[ FxTimingAPI startTimeOfInputBToTransition: ]
+[ FxOnScreenControl drawingCoordinates ]
  +[ FxTimingAPI startTimeOfInputToFilter: ]
+[ FxOnScreenControl drawOSC:height:activePart:time: ]
  +[ FxTimingAPI timelineFpsDenominatorForEffect: ]
+[ FxOnScreenControl keyDown:positionY:keyPressed:modifiers:forceUpdate:didHandle:time: ]
  +[ FxTimingAPI timelineFpsNumeratorForEffect: ]
+[ FxOnScreenControl keyUp:positionY:keyPressed:modifiers:forceUpdate:didHandle:time: ]
  +[ FxTimingAPI timelineTimeFromImageTime:forParmId:forEffect: ]
+[ FxOnScreenControl mouseDown:positionY:activePart:modifiers:forceUpdate:time: ]
  +[ FxTimingAPI timelineTimeFromInputATime:forTransition: ]
+[ FxOnScreenControl mouseDragged:positionY:activePart:modifiers:forceUpdate:time: ]
  +[ FxTimingAPI timelineTimeFromInputBTime:forTransition: ]
+[ FxOnScreenControl mouseUp:positionY:activePart:modifiers:forceUpdate:time: ]
  +[ FxTimingAPI timelineTimeFromInputTime:forFilter: ]
+[ FxOnScreenControlAPI convertPointFromSpace:fromX:fromY:toSpace:toX:toY: ]
  +[ FxTransition frameCleanup ]
+[ FxOptionalParameterCreationAPI addGradientWithName:parmId:parmFlags: ]
  +[ FxTransition frameSetup:inputInfoA:inputInfoB:timeFraction:hardware:software: ]
+[ FxOptionalParameterCreationAPI addHistogramWithName:parmId:parmFlags: ]
  +[ FxTransition getOutputWidth:height:withInputA:withInputB:withTimeFraction:withInfo: ]
+[ FxOptionalParameterRetrievalAPI getGradientSamples:numSamples:depth:fromParm:atTime: ]
  +[ FxTransition renderOutput:withInputA:withInputB:withTimeFraction:withInfo: ]
+[ FxOptionalParameterRetrievalAPI getHistogramBlackIn:BlackOut:WhiteIn:WhiteOut:Gamma:forChannel:fromParm:atTime: ]
  +[ FxVersioningAPI versionAtCreation ]
+[ FxOptionalParameterSettingAPI setHistogramBlackIn:BlackOut:WhiteIn:WhiteOut:Gamma:forChannel:fromParm:atTime: ]
 

Other References

Header Index
Data Types Index

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.