Interface INotificationIcon

Icon source for Dalamud.Interface.ImGuiNotification.INotification.

Remarks

Plugins implementing this interface are left to their own on managing the resources contained by the instance of their implementation of Dalamud.Interface.ImGuiNotification.INotificationIcon. In other words, they should not expect to have System.IDisposable.Dispose called if their implementation is an System.IDisposable. Dalamud will not call System.IDisposable.Dispose on any instance of Dalamud.Interface.ImGuiNotification.INotificationIcon. On plugin unloads, the icon may be reverted back to the default, if the instance of Dalamud.Interface.ImGuiNotification.INotificationIcon is not provided by Dalamud.

Assembly: Dalamud.dll

Declaration

public interface INotificationIcon

Methods

From(SeIconChar)

Gets a new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that will source the icon from an Dalamud.Game.Text.SeIconChar.

Declaration

public static INotificationIcon From(SeIconChar iconChar)

Returns

Dalamud.Interface.ImGuiNotification.INotificationIcon: A new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that should be disposed after use.

Parameters

Type	Name	Description
Dalamud.Game.Text.SeIconChar	iconChar	The icon character.

From(FontAwesomeIcon)

Gets a new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that will source the icon from an Dalamud.Interface.FontAwesomeIcon.

Declaration

public static INotificationIcon From(FontAwesomeIcon iconChar)

Returns

Dalamud.Interface.ImGuiNotification.INotificationIcon: A new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that should be disposed after use.

Parameters

Type	Name	Description
Dalamud.Interface.FontAwesomeIcon	iconChar	The icon character.

FromGame(string)

Gets a new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that will source the icon from a texture file shipped as a part of the game resources.

Declaration

public static INotificationIcon FromGame(string gamePath)

Returns

Dalamud.Interface.ImGuiNotification.INotificationIcon: A new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that should be disposed after use.

Parameters

Type	Name	Description
System.String	gamePath	The path to a texture file in the game virtual file system.

Remarks

If any errors are thrown, the default icon will be displayed instead.

FromFile(string)

Gets a new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that will source the icon from an image file from the file system.

Declaration

public static INotificationIcon FromFile(string filePath)

Returns

Dalamud.Interface.ImGuiNotification.INotificationIcon: A new instance of Dalamud.Interface.ImGuiNotification.INotificationIcon that should be disposed after use.

Parameters

Type	Name	Description
System.String	filePath	The path to an image file in the file system.

Remarks

If any errors are thrown, the default icon will be displayed instead.

DrawIcon(Vector2, Vector2, Vector4)

Draws the icon.

Declaration

bool DrawIcon(Vector2 minCoord, Vector2 maxCoord, Vector4 color)

Returns

System.Boolean: true if anything has been drawn.

Parameters

Type	Name	Description
System.Numerics.Vector2	minCoord	The coordinates of the top left of the icon area.
System.Numerics.Vector2	maxCoord	The coordinates of the bottom right of the icon area.
System.Numerics.Vector4	color	The foreground color.