Skip to main content
Version: 15.x (API 15) [Legacy]

Struct TextureModificationArgs

Describes how to modify a texture.

Assembly: Dalamud.dll​
Declaration
public struct TextureModificationArgs : IEquatable<TextureModificationArgs>

Implements:
System.IEquatable<Dalamud.Interface.Textures.TextureModificationArgs>

Properties​

MakeOpaque​

Gets or sets a value indicating whether to make the texture opaque.

Declaration
public bool MakeOpaque { readonly get; set; }
Remarks​

If true, then the alpha channel values will be filled with 1.0.

DxgiFormat​

Gets or sets the new DXGI format.

Declaration
public int DxgiFormat { readonly get; set; }
Remarks​

<p>Set to 0 (TerraFX.Interop.DirectX.DXGI_FORMAT.DXGI_FORMAT_UNKNOWN) to use the source pixel format.</p> <p>Supported values can be queried with Dalamud.Plugin.Services.ITextureProvider.IsDxgiFormatSupportedForCreateFromExistingTextureAsync(int). This may not necessarily match Dalamud.Plugin.Services.ITextureProvider.IsDxgiFormatSupported(int). </p>

NewWidth​

Gets or sets the new width.

Declaration
public int NewWidth { readonly get; set; }
Remarks​

Set to 0 to automatically calculate according to the original texture size, Dalamud.Interface.Textures.TextureModificationArgs.Uv0, and Dalamud.Interface.Textures.TextureModificationArgs.Uv1.

NewHeight​

Gets or sets the new height.

Declaration
public int NewHeight { readonly get; set; }
Remarks​

Set to 0 to automatically calculate according to the original texture size, Dalamud.Interface.Textures.TextureModificationArgs.Uv0, and Dalamud.Interface.Textures.TextureModificationArgs.Uv1.

Uv0​

Gets or sets the left top coordinates relative to the size of the source texture.

Declaration
public Vector2 Uv0 { readonly get; set; }

Uv1​

Gets or sets the right bottom coordinates relative to the size of the source texture.

Declaration
public Vector2 Uv1 { readonly get; set; }
Remarks​

If set to System.Numerics.Vector2.Zero, then it will be interpreted as System.Numerics.Vector2.One, to accommodate the use of default value of this record struct.

Methods​

ToString()​

Declaration
public override string ToString()
Returns​

System.String

GetHashCode()​

Declaration
public override readonly int GetHashCode()
Returns​

System.Int32

Equals(object)​

Declaration
public override readonly bool Equals(object obj)
Returns​

System.Boolean

Parameters​
TypeName
System.Objectobj

Equals(TextureModificationArgs)​

Declaration
public readonly bool Equals(TextureModificationArgs other)
Returns​

System.Boolean

Parameters​
TypeName
Dalamud.Interface.Textures.TextureModificationArgsother

Implements​

  • System.IEquatable<Dalamud.Interface.Textures.TextureModificationArgs>