Editor_options_getcrop, Editor_options_getcropbounds, 3 function documentation – Google Flix Engine Linux Reference Manual User Manual

Page 104

Advertising
background image

98

Flix Engine Linux Module Documentation

5.24.2.5

#define FE2_FILTER_CROP

Filter name for use with

Flix2_AddFilter()

.

Definition at line 49 of file crop.h.

5.24.3

Function Documentation

5.24.3.1

on2sc editor_options_GetCrop (const FLIX2HANDLE flix, on2bool ∗ pCrop)

Determine if the crop filter is enabled.

Parameters:

← flix Handle to the Flix Engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pCrop Variable to update with the current crop enable status

Return values:

ON2_OK

The crop enable status was successfully retrieved from the engine.

ON2_NET_ERROR

The underlying communication layer failed.

Note:

If a value other than ON2_OK is returned, the output variables should not be considered valid.

Deprecated

Use the

Filter Interface

along with

FE2_FILTER_CROP

. This function will be removed in a future

release.

5.24.3.2

on2sc editor_options_GetCropBounds (const FLIX2HANDLE flix, int32_t ∗ pTop, int32_t
∗ pLeft, int32_t ∗ pBottom, int32_t ∗ pRight)

Get the current bounding box used for cropping.

Parameters:

← flix Handle to the Flix Engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pTop Topmost row of the cropped area

→ pLeft Leftmost column of the cropped area

→ pBottom Bottommost row of the cropped area

→ pRight Rightmost row of the cropped area

Return values:

ON2_OK

The crop bounding box was successfully retrieved from the engine.

ON2_NET_ERROR

The underlying communication layer failed.

Note:

If a value other than ON2_OK is returned, the output variables should not be considered valid.

Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen

Advertising