Protocol

Fx3DAPI

An API that defines the methods the host application provides to get information about the 3D environment, including camera and object transforms.

Declaration

@protocol Fx3DAPI

Topics

Accessing the 3D Environment

- cameraMatrixAtTime:

Returns the 4x4 camera transform matrix.

Required.

- layerMatrixAtTime:

Returns the 4x4 layer transform matrix.

Required.

- focalLengthAtTime:

Returns the focal length.

Required.

- is3D

Returns whether the effect's layer is in 3D.

Required.

Constants

Drawing in Screen Space

Tells the host application that your plug-in draws in screen space — it is always directly in front of the camera and facing the camera. This key would be contained within the properties method, described in FxBaseEffect.

Relationships

Inherited By

See Also

Legacy Versions

Fx3DAPI_v2

An API that defines the methods the host application provides to get information about the 3D environment, including camera and object transforms.

Fx3DAPI_v3

An API that defines the methods the host application provides to get information about the 3D environment, including camera and object transforms.