Struct Outline
Definition
- Assembly:
- Tizen.NUI.dll
A struct to pass data of Outline PropertyMap.
public struct Outline : IEquatable<Outline>
- Implements
-
IEquatable<><Outline>
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Properties
View SourceBlurRadius
The radius of blurring effect applied to the outline of the text. A higher value results in a more blurred outline.
If not specified, the default value is 0 which means no blurring effect will be applied.
Declaration
public float? BlurRadius { readonly get; set; }
Property Value
| Type | Description |
|---|---|
| float? |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Color
The color of the outline (the default color is Color.White).
Declaration
public Color Color { readonly get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Offset
The offset in pixels of the offset (if null, the default value is 0, 0).
If not provided then the offset is not enabled.
Declaration
public Vector2 Offset { readonly get; set; }
Property Value
| Type | Description |
|---|---|
| Vector2 |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Width
The width in pixels of the outline (if null, the default value is 0.0f).
If not provided then the outline is not enabled.
Declaration
public float? Width { readonly get; set; }
Property Value
| Type | Description |
|---|---|
| float? |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Methods
View SourceEquals(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 Outline, else false. |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Equals(Outline)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(Outline other)
Parameters
| Type | Name | Description |
|---|---|---|
| Outline | other | The Outline to compare with the current Outline. |
Returns
| Type | Description |
|---|---|
| bool | true if equal Outline, else false. |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
GetHashCode()
Gets the hash code of this Outline.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | The hash code. |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
Operators
View Sourceoperator ==(Outline, Outline)
The == operator.
Declaration
public static bool operator ==(Outline lhsOutline, Outline rhsOutline)
Parameters
| Type | Name | Description |
|---|---|---|
| Outline | lhsOutline | Outline to compare |
| Outline | rhsOutline | Outline to be compared |
Returns
| Type | Description |
|---|---|
| bool | true if Outlines are equal |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().
operator !=(Outline, Outline)
The != operator.
Declaration
public static bool operator !=(Outline lhsOutline, Outline rhsOutline)
Parameters
| Type | Name | Description |
|---|---|---|
| Outline | lhsOutline | Outline to compare |
| Outline | rhsOutline | Outline to be compared |
Returns
| Type | Description |
|---|---|
| bool | true if Outlines are not equal |
Remarks
The Outline struct is used as an argument to SetOutline and GetOutline methods.
See SetOutline(Outline), GetOutline(), SetOutline(Outline), GetOutline(), SetOutline(Outline) and GetOutline().