Struct Emboss

Definition

Namespace:
Tizen.NUI.Text
Assembly:
Tizen.NUI.dll

A struct to pass data of SetTextEmboss and GetTextEmboss methods.

public struct Emboss : IEquatable<Emboss>
Implements
IEquatable<><Emboss>
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

Properties

View Source

Direction

The emboss direction in texture space. (the default value is (0.0f, 0.0f).)

Declaration
public Vector2 Direction { readonly get; set; }
Property Value
Type Description
Vector2
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

Enable

Whether the emboss is enabled (the default value is false).

Declaration
public bool Enable { readonly get; set; }
Property Value
Type Description
bool
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

LightColor

The highlight color for raised areas. (the default value is transparent.)

Declaration
public Color LightColor { readonly get; set; }
Property Value
Type Description
Color
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

ShadowColor

The shadow color for recessed areas. (the default value is transparent.)

Declaration
public Color ShadowColor { readonly get; set; }
Property Value
Type Description
Color
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

Strength

The strength of emboss in pixels. (the default value is 0.0f.)

Declaration
public float? Strength { readonly get; set; }
Property Value
Type Description
float?
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

Methods

View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if equal Emboss, else false.
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

Equals(Emboss)

Determines whether the specified object is equal to the current object.

Declaration
public bool Equals(Emboss other)
Parameters
Type Name Description
Emboss other

The Emboss to compare with the current Emboss.
Returns
Type Description
bool

true if equal Emboss, else false.
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

GetHashCode()

Gets the hash code of this Emboss.

Declaration
public override int GetHashCode()
Returns
Type Description
int

The hash code.
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

Operators

View Source

operator ==(Emboss, Emboss)

The == operator.

Declaration
public static bool operator ==(Emboss lhsEmboss, Emboss rhsEmboss)
Parameters
Type Name Description
Emboss lhsEmboss

Emboss to compare
Emboss rhsEmboss

Emboss to be compared
Returns
Type Description
bool

true if Emboss are equal
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

View Source

operator !=(Emboss, Emboss)

The != operator.

Declaration
public static bool operator !=(Emboss lhsEmboss, Emboss rhsEmboss)
Parameters
Type Name Description
Emboss lhsEmboss

Emboss to compare
Emboss rhsEmboss

Emboss to be compared
Returns
Type Description
bool

true if Emboss are not equal
Remarks

The Emboss struct is used as an argument to SetTextEmboss and GetTextEmboss methods.
See SetEmboss(Emboss) and GetEmboss().

Implements

IEquatable<>

Extension Methods