Skip to content

Update MaterialResourceHandle for variable-size color tables used since 7.0 #1545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 25, 2025
Merged

Update MaterialResourceHandle for variable-size color tables used since 7.0 #1545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 32 additions & 87 deletions FFXIVClientStructs/FFXIV/Client/System/Resource/Handle/MaterialResourceHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ namespace FFXIVClientStructs.FFXIV.Client.System.Resource.Handle;
[Inherits<DefaultResourceHandle>]
[StructLayout(LayoutKind.Explicit, Size = 0x108)]
public unsafe partial struct MaterialResourceHandle {
public const int TableRows = 16;

[StructLayout(LayoutKind.Explicit, Size = 0x10)]
public struct TextureEntry {
[FieldOffset(0x0)]
Expand Down Expand Up @@ -52,82 +50,6 @@ public struct AttributeSetEntry {
public ushort Index;
}

/// <remarks>
/// All RGB values in this structure are pre-squared.
/// </remarks>
[StructLayout(LayoutKind.Explicit, Size = 0x20)]
public struct ColorTableRow {
[FieldOffset(0x0)] public Half DiffuseRed;
[FieldOffset(0x2)] public Half DiffuseGreen;
[FieldOffset(0x4)] public Half DiffuseBlue;
[FieldOffset(0x6)] public Half SpecularStrength;
[FieldOffset(0x8)] public Half SpecularRed;
[FieldOffset(0xA)] public Half SpecularGreen;
[FieldOffset(0xC)] public Half SpecularBlue;
[FieldOffset(0xE)] public Half GlossStrength;
[FieldOffset(0x10)] public Half EmissiveRed;
[FieldOffset(0x12)] public Half EmissiveGreen;
[FieldOffset(0x14)] public Half EmissiveBlue;
[FieldOffset(0x16)] public Half TileIndexW;
[FieldOffset(0x18)] public Half TileScaleUU;
[FieldOffset(0x1A)] public Half TileScaleUV;
[FieldOffset(0x1C)] public Half TileScaleVU;
[FieldOffset(0x1E)] public Half TileScaleVV;

public ushort TileIndex {
get => (ushort)((float)TileIndexW * 64.0f);
set => TileIndexW = (Half)((value + 0.5f) / 64.0f);
}

public Span<Half> AsSpan() {
fixed (Half* ptr = &DiffuseRed) {
return new(ptr, 16);
}
}

public ReadOnlySpan<Half> AsReadOnlySpan() {
fixed (Half* ptr = &DiffuseRed) {
return new(ptr, 16);
}
}
}

[StructLayout(LayoutKind.Explicit, Size = 0x2)]
public struct StainTableRow {
[FieldOffset(0x0)]
public ushort RawData;

public ushort Template {
get => (ushort)(RawData >> 5);
set => RawData = (ushort)((RawData & 0x1F) | (value << 5));
}

public bool Diffuse {
get => (RawData & 0x01) != 0;
set => RawData = (ushort)(value ? RawData | 0x01 : RawData & 0xFFFE);
}

public bool Specular {
get => (RawData & 0x02) != 0;
set => RawData = (ushort)(value ? RawData | 0x02 : RawData & 0xFFFD);
}

public bool Emissive {
get => (RawData & 0x04) != 0;
set => RawData = (ushort)(value ? RawData | 0x04 : RawData & 0xFFFB);
}

public bool Gloss {
get => (RawData & 0x08) != 0;
set => RawData = (ushort)(value ? RawData | 0x08 : RawData & 0xFFF7);
}

public bool SpecularStrength {
get => (RawData & 0x10) != 0;
set => RawData = (ushort)(value ? RawData | 0x10 : RawData & 0xFFEF);
}
}

// [FieldOffset(0xB8)] public ulong Length;
/// <summary>
/// The instantiated material. Its <see cref="Material.MaterialResourceHandle"/> will be the current structure.
Expand Down Expand Up @@ -165,21 +87,44 @@ public bool HasColorTable
public bool HasStainTable
=> (DataFlags & 0x8) != 0;

public ColorTableRow* ColorTable
=> DataSetSize >= TableRows * sizeof(ColorTableRow) && HasColorTable ? (ColorTableRow*)DataSet : null;
public byte ColorTableWidthLog
=> (byte)((DataFlags >> 4) & 0xF);

public byte ColorTableHeightLog
=> (byte)((DataFlags >> 8) & 0xF);

/// <summary>Width of the color table, in vectors of 4 <see cref="Half"/>.</summary>
public int ColorTableWidth
=> HasColorTable ? ((DataFlags & 0xFF0) == 0 ? 4 : 1 << ColorTableWidthLog) : 0;

public int ColorTableHeight
=> HasColorTable ? ((DataFlags & 0xFF0) == 0 ? 16 : 1 << ColorTableHeightLog) : 0;

/// <summary>Total length of the color table, in <see cref="Half"/>. This will be the length of <see cref="ColorTableSpan"/>.</summary>
public int ColorTableLength
=> ColorTableHeight * ColorTableWidth * 4;

public Half* ColorTable
=> DataSetSize >= ColorTableLength * sizeof(Half) && HasColorTable ? (Half*)DataSet : null;

public Span<Half> ColorTableSpan
=> ColorTable switch { null => default, var ptr => new(ptr, ColorTableLength) };

public int StainTableRowByteLength
=> (DataFlags & 0xFF0) == 0 ? 2 : 4;

public Span<ColorTableRow> ColorTableSpan
=> ColorTable switch { null => default, var ptr => new(ptr, TableRows) };
public int StainTableByteLength
=> ColorTableHeight * StainTableRowByteLength;

public StainTableRow* StainTable {
public byte* StainTable {
get {
var offset = HasColorTable ? TableRows * sizeof(ColorTableRow) : 0;
return DataSetSize >= offset + TableRows * sizeof(StainTableRow) && HasStainTable ? (StainTableRow*)(DataSet + offset) : null;
var offset = HasColorTable ? ColorTableLength * sizeof(Half) : 0;
return DataSetSize >= offset + StainTableByteLength && HasStainTable ? DataSet + offset : null;
}
}

public Span<StainTableRow> StainTableSpan
=> StainTable switch { null => default, var ptr => new(ptr, TableRows) };
public Span<byte> StainTableSpan
=> StainTable switch { null => default, var ptr => new(ptr, StainTableByteLength) };

public CStringPointer ShpkName
=> Strings + ShpkNameOffset;
Expand Down
Loading