Class

FxImage

The FxImage class is the parent class of the FxBitmap and FxTexture classes.

Declaration

@interface FxImage : NSObject

Overview

The FxImage class is a base class for all image types in the FxPlug SDK. It is the parent class of both the FxBitmap and FxTexture classes which represent images stored either in RAM or on the video card, respectively.

A plug-in can query an FxImage class or subclass to get information from it such as its width and height in pixels, which field of video it represents, or what colorspace it is in. This is necessary to render most effects. For example, if your plug-in has a point parameter, it can use the input image's width and height to figure out what point in the image corresponds to the point the user has selected.

Topics

Getting Image Values

- bounds

Returns the floating point bounding rectangle of the image in its own coordinate space.

- bytes

Return the number of bytes per pixel component.

- colorInfo

Returns the color properties of the image.

- colorSpace

Returns a CGColorSpaceRef that matches the color space used in creating the image.

- depth

Returns the depth of the image in bits per pixel.

- dod

Returns the domain of definition for this image.

- field

Returns the field identifier of the image.

- fieldOrder

Returns the field order of the image stream.

- height

Returns the height of the image.

- imageInfo

Returns the image info structure that describes the image.

- imageType

Returns the type of the image.

- isPremultiplied

Returns whether the image's RGB values are premultiplied by its alpha values.

- origin

Returns the orientation of the image.

- pixelAspect

Returns the pixel aspect ratio of the image.

- pixelFormat

Returns the pixel format of the image.

- setColorInfo:

Sets the color properties of the image.

- setField:

Sets the field identifier of the image.

- setFieldOrder:

Sets the field order of the image stream.

- version

Returns the version of the image class currently in use.

- width

Returns the width of the image.

- size

Returns the size of the image.

- numActiveChannels

Returns the number of active channels.

- setNumActiveChannels:

Sets the number of active channels in the image.

- containsPointX:Y:

Checks whether the specified position lies within the image bounds.

Pixel Transforms

- inversePixelTransform

Returns the inverse pixel transform of the image.

- pixelTransform

The image’s pixel transform.

Setting Image Values

- setWidth:

Sets the width of the image.

- setHeight:

Sets the height of the image.

- setWidth:andHeight:

Sets both the width and height of the image.

- setDepth:

Sets the the depth of the image in bits per pixel.

- setBytes:

Sets the number of bytes per pixel component.

- setImageType:

Sets the type of the image.

- setOrigin:

Sets the orientation of the image.

- setPixelFormat:

Sets the pixel format of the image.

- setIsPremultiplied:

Sets the premultiplied flag for the image.

- setPixelAspect:

Sets the pixel aspect ratio of the image.

Constants

Image Versions

Constants that specify the version of the FxImage class.

FxImageType

Identifies the type of an image.

FxPixelFormat

These constants define the format of the pixels for an image.

FxImageOrigin

These constants define the orientation of an image's coordinate system. Images in Motion have a bottom-left origin. Images in Final Cut have a top-left origin.

FxImageInfo

Structure that defines the parameters of an image.The FxImageInfo structure describes an image and is used to create a new image.

FxImageColorInfo

Identifies some color properties of an FxImage instance. These include the color space, gamma level, and, in the case of YCbCr images, the color matrix for conversion to RGB.

Pixel Transforms Property Key

Tells the host application which pixel transformations your plug-in is able to work with. All plug-ins must support at least non-uniform scaling to handle non-square pixel aspect ratios and fields.

FxPixelTransformSupport

Constants that define the support for pixel transforms.

Instance Methods

Relationships

Inherits From

Conforms To