Editor_options_getbrightness, Editor_options_getcontrast, Editor_options_gethue – Google Flix Engine Linux Reference Manual User Manual

Page 91: 3 function documentation

Advertising
background image

5.22 Brightness/Contrast/Hue/Saturation

85

5.22.3

Function Documentation

5.22.3.1

on2sc editor_options_GetBrightness (const FLIX2HANDLE flix, int32_t ∗ pBrightness)

Get the current brightness adjustment factor.

Parameters:

← flix Handle to the Flix Engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pBrightness Brightness factor (-255..255)

Return values:

ON2_OK

The brightness value 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_BCHS

and the

FE2_BCHS_BRIGHTNESS

param-

eter. This function will be removed in a future release.

5.22.3.2

on2sc editor_options_GetContrast (const FLIX2HANDLE flix, double ∗ pContrast)

Get the current contrast adjustment factor.

Parameters:

← flix Handle to the Flix Engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pContrast Contrast factor (-255..255)

Return values:

ON2_OK

The contrast value 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_BCHS

and the

FE2_BCHS_CONTRAST

parameter.

This function will be removed in a future release.

5.22.3.3

on2sc editor_options_GetHue (const FLIX2HANDLE flix, int32_t ∗ pHue)

Get the current hue adjustment factor.

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

Advertising