Struct ImGuiViewportTextureArgs

Describes how to take a texture of an existing ImGui viewport.

Assembly: Dalamud.dll

Declaration

public struct ImGuiViewportTextureArgs : IEquatable<ImGuiViewportTextureArgs>

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

Properties

ViewportId

Gets or sets the ImGui Viewport ID to capture.

Declaration

public uint ViewportId { readonly get; set; }

Remarks

Use Dalamud.Bindings.ImGui.ImGuiViewport.ID from Dalamud.Bindings.ImGui.ImGui.GetMainViewport to take the main viewport, where the game renders to.

AutoUpdate

Gets or sets a value indicating whether to automatically update the texture.

Declaration

public bool AutoUpdate { readonly get; set; }

Remarks

Enabling this will also update Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap.Size as needed.

TakeBeforeImGuiRender

Gets or sets a value indicating whether to get the texture before rendering ImGui.

Declaration

public bool TakeBeforeImGuiRender { readonly get; set; }

Remarks

It probably makes no sense to enable this unless Dalamud.Interface.Textures.ImGuiViewportTextureArgs.ViewportId points to the main viewport.

KeepTransparency

Gets or sets a value indicating whether to keep the transparency.

Declaration

public bool KeepTransparency { readonly get; set; }

Remarks

<p>If true, then the alpha channel values will be filled with 1.0.</p> <p>Keep in mind that screen captures generally do not need alpha values.</p>

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

Type	Name
System.Object	obj

Equals(ImGuiViewportTextureArgs)

Declaration

public readonly bool Equals(ImGuiViewportTextureArgs other)

Returns

System.Boolean

Parameters

Type	Name
Dalamud.Interface.Textures.ImGuiViewportTextureArgs	other

Implements

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