Protocol

FxOnScreenControlAPI_v2

The FxOnScreenControlAPI_v2 protocol specifies additions to the FxOnScreenControlAPI protocol which defines the methods the host application provides to manage conversions between various on-screen coordinate spaces.

Declaration

@protocol FxOnScreenControlAPI_v2

Overview

This protocol inherits from, and expands on, the FxOnScreenControlAPI protocol It can retrieve information about the canvas, such as its pixel aspect ratio or its zoom level so that a plug-in can draw its controls at the appropriate scale. As with the FxOnScreenControlAPI protocol, this aids in allowing the user to directly manipulate a plug-in's parameters.

Topics

Canvas Information

- canvasZoom

Returns the zoom factor the user has set the canvas

Required.

- canvasPixelAspectRatio

Returns the pixel aspect ratio of the canvas.

Required.

- pixelAspectRatio

Returns the pixel aspect ratio for which the on-screen control applies.

Required.

- objectBounds

Returns the bounds of the object that the on-screen control applies to.

Required.

- objectToScreenTransform

Returns a 4x4 matrix describing the transformation from object normalized space

Required.

Input and Output Item Geometry

- objectWidth:height:pixelAspectRatio:

Returns the width, height, and pixel aspect ratio of the object for which the on-screen control is applied.

Required.

- inputWidth:height:pixelAspectRatio:

Returns the width, height, and pixel aspect ratio of the input to the filter or transition for which the on-screen control is applied.

Required.

- inputBounds

Returns the bounds of the input to the filter or transition.

Required.

Relationships

See Also

APIs

FxOnScreenControlAPI

The FxOnScreenControlAPI protocol defines the methods the host application uses to draw controls and other user interface elements directly on the canvas where the user has applied the plug-in.

FxOnScreenControlAPI_v3

The FxOnScreenControlAPI_v3 protocol specifies additions to the FxOnScreenControlAPI protocol which defines the methods the host application provides to manage conversions between various on-screen coordinate spaces.

FxOnScreenControlAPI_v4

The FxOnScreenControlAPI_v4 protocol specifies additions to the FxOnScreenControlAPI protocol which defines the methods the host application provides to manage conversions between various on-screen coordinate spaces.