C++ Syntax

class MKI_DISPLAY_EFFECT

{

public:

__int32 m_nTransparency,

m_nBrightness,

m_nSaturation,

m_nTint;

MKI_COLORVALUE m_cTintColor;

MKI_COLORMODEL m_cTintColorMode;

void

Init( void );

bool

IsIdentical( const MKI_DISPLAY_EFFECT& f_rData ) const;

bool

SetEnumEffect( const MKI_ENUMEFFECT_DATA& f_rData );

void

AddEnumEffect( const MKI_ENUMEFFECT_DATA& f_rData );

bool

ApplyToColor( MKI_COLORVALUE_REF f_rColor, MKI_COLORMODEL f_cColorMode ) const;

bool

ApplyToAlpha( MKI_ALPHAVALUE_REF f_rAlpha ) const;

};

This structure contains settings for object dyeing effects. Dyeing does not change the properties of objects, it only changes their rendering.

This class is similar to MKI_ENUMEFFECT_DATA, but uses a different value range (integer percent instead of doubles relative to 1.0).

Element Description

m_nTransparency

[__int32] Relative transparency to be applied to all subordinate objects in percent. Allowed values are -100 to 100. Negative values make all subordinate objects less transparent, positive values make all subordinate more transparent.

m_nBrightness

[__int32] Relative brightness to be applied to all subordinate objects in percent. Allowed values are -100 to 100. Negative values make all subordinate objects darker, positive values make all subordinate objects lighter.

m_nSaturation

[__int32] Relative saturation to be applied to all subordinate objects in percent. Allowed values are -100 to 100. Negative values make all subordinate objects less saturated (towards gray), positive values make all subordinate objects more saturated (intense colors).

m_nTint

[__int32] Amount of tinting with m_cTintColor / m_cTintColorMode to be applied to all subordinate objects in percent. Allowed values are 0 to 100.

m_cTintColor

[MKI_COLORVALUE] Tinting color (only used if m_nTint is non-zero).

m_cTintColorMode

[MKI_COLORMODEL] Tinting color model (only used if m_nTint is non-zero).

MKD Syntax

Transparency,Brightness,Saturation,Tint,TintColor;