Overlay_options_getmaskpixelxy, Overlay_options_getmaskpixelrgb, 4 function documentation – Google Flix Engine Linux Reference Manual User Manual

Page 132

Advertising
background image

126

Flix Engine Linux Module Documentation

5.31.4

Function Documentation

5.31.4.1

on2sc overlay_options_GetMaskPixelRGB (FLIX2HANDLE flix, uint8_t ∗ pMaskPixelR,
uint8_t ∗ pMaskPixelG, uint8_t ∗ pMaskPixelB)

Return the Red, Green, and Blue component values of the mask pixel.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pMaskPixelR pointer to variable that will receive the R value

→ pMaskPixelG pointer to variable that will receive the G value

→ pMaskPixelB pointer to variable that will receive the B value

Return values:

ON2_OK

the color component values were retrieved successfully

ON2_INVALID_PARAMS

a precondition failed

ON2_NET_ERROR

the underlying communication layer failed

Precondition:

flix

is not NULL

pMaskPixelR

is not NULL

pMaskPixelG

is not NULL

pMaskPixelB

is not NULL

Remarks:

This method returns the values set in previous call to

overlay_options_SetMaskPixelRGB()

, if no

coordinates were previously set, the Red, Green, and Blue component values will be set to 0.

Deprecated

Use the

Filter Interface

along with

FE2_FILTER_OVERLAY

and the

FE2_OVERLAY_MASK_R

,

FE2_OVERLAY_MASK_G

and

FE2_OVERLAY_MASK_B

parameters. This function will be re-

moved in a future release.

5.31.4.2

on2sc overlay_options_GetMaskPixelXY (const FLIX2HANDLE flix, int32_t ∗
pMaskPixelX, int32_t ∗ pMaskPixelY)

Return the X and Y coordinates of the mask pixel.

Parameters:

← flix Handle to the flix engine returned from

Flix2_Create()

or

Flix2_CreateEx()

→ pMaskPixelX pointer to variable that will receive the X value

→ pMaskPixelY pointer to variable that will receive the Y value

Return values:

ON2_OK

the coordinate values were retrieved successfully

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

Advertising