ILMVEmboss Interface

Data Types

EMBOSS_ATTRIBUTES

typedef struct 
{ 
   long lLightAngle; 
   long lElevation; 
   long lDepth; 
   BOOL bEmbossp; 
   BOOL bEnabled; 
   long lDLightAngle; 
   long lDElevation; 
   long lDDepth; 
   BOOL bDEmbossp; 
   BOOL bDEnabled; 
} EMBOSS_ATTRIBUTES; 

Describes emboss effect properties.

Members

lLightAngle

The light Angle, 0 to 360 degrees, this parameter will control the light direction.

lElevation

Elevation angle, 0 to 180 degrees, 0 value will have outer embossing, 180 will have inner embossing effect.

lDepth

Depth of emboss effect, 1 to 100.

bEmbossp

Indicates weather to emboss with a bump map (TRUE) or not (FALSE).

BEnabled

Indicates weather Emboss effect is enabled (TRUE) or not (FALSE).

lDLightAngle

Default light angle value. Original default value is 180.

lDElevation

Default elevation angle value. Original default value is 90.

lDDepth

Default depth value. Original default value is 1.

bDEmbossp

Default bump map value. Original default value is TRUE.

bDEnabled

Default for bEnabled value. Original default value is TRUE.

CROP_ATTRIBUTES

typedef struct 
{ 
   long lLeft; 
   long lTop; 
   long lRight; 
   long lBottom; 
   BOOL bEnabled; 
   long lDLeft; 
   long lDTop; 
   long lDRight; 
   long lDBottom; 
   BOOL bDEnabled; 
} CROP_ATTRIBUTES; 

Describes the area exposed to the emboss effect.

Members

lLeft

The left coordinate of the cropped rectangle, 0 by default.

lTop

The top coordinate of the cropped rectangle, 0 by default.

lRight

The right coordinate of the cropped rectangle, 1 by default.

lBottom

The bottom coordinate of the cropped rectangle, 1 by default.

bEnabled

Enable (TRUE) / Disable (FALSE) the effect area.

lDLeft

Default left.

lDTop

Default top.

lDRight

Default right.

lDBottom

Default bottom.

bDEnabled

Default effect area enable status

Methods

HRESULT IsLEADInputPinConnected()

Description

Determines whether the filter input pin is currently connected.

Returns

Return Description
S_OK Connected.
S_FALSE Otherwise.

HRESULT IsLEADOutputPinConnected()

Description

Determines whether the filter output pin is currently connected.

Returns

Return Description
S_OK Connected.
S_FALSE Otherwise.

HRESULT SetEmbossAttributes(EMBOSS_ATTRIBUTES emboss_attributes)

Description

Sets the properties for the emboss effect.

Parameters

emboss_attributes

An EMBOSS_ATTRIBUTES structure that contains emboss attributes to set.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT GetEmbossAttributes(EMBOSS_ATTRIBUTES *emboss_attributes)

Description

Retrieves the current emboss attributes.

Parameters

emboss_attributes

A valid pointer to an EMBOSS_ATTRIBUTES structure to be updated with the current emboss attributes.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT SetCropAttributes(CROP_ATTRIBUTES crop_attributes)

Description

Sets the effect area attributes. If successful, effect is applied only to the passed rectangle.

Parameters

crop_attributes

A CROP_ATTRIBUTES structure that contains the effect area attributes to set.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT GetCropAttributes(CROP_ATTRIBUTES *crop_attributes)

Description

Retrieves the current effect area attributes.

Parameters

crop_attributes

A valid pointer to a CROP_ATTRIBUTES structure to be updated with the current effect area attributes.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT GetIODimensions(long *plInWidth, long *plInHeight, long *plOutWidth, long *plOutHeight)

Description

Retrieves the current media dimensions.

Parameters

plInWidth

A valid pointer to a long variable to be updated with the input media width. NULL can be passed if this value is not needed.

plInHeight

A valid pointer to a long variable to be updated with the input media height. NULL can be passed if this value is not needed.

plOutWidth

A valid pointer to a long variable to be updated with the output media width. NULL can be passed if this value is not needed.

plOutHeight

A valid pointer to a long variable to be updated with the output media height. NULL can be passed if this value is not needed.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT GetIOBitCount(int *plInBits, int *plOutBits)

Description

Gets the bits per pixel of the current connected input and output media formats.

Parameters

pInBitCount

A valid pointer to an integer to be updated with the input media bits per pixel value. NULL can be passed if this value is not needed.

pPBitCount

A valid pointer to an integer to be updated with the output media bits per pixel value. NULL can be passed if this value is not needed.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.
Help Version 22.0.2022.6.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.