Render commands and friends by universalconquistador · Pull Request #1830 · aers/FFXIVClientStructs

universalconquistador · 2026-05-14T15:11:34Z

A few different rendering things in support of under-UI overlay drawing:

Initial ThreadLocals support. Feel free to suggest any changes to how it's presented in ClientStructs.
Adds the Context for generating and enqueueing render commands
Adds lots of stuff to ImmediateContext where the render commands are processed
Adds structs to help with bitfield rendering states
Adds AtkServer that turns UI draw commands into render commands
Adds Texture fields for getting the render target view / depth stencil view

universalconquistador · 2026-05-14T15:19:21Z

+    [MemberFunction("48 89 5C 24 ?? 48 89 6C 24 ?? 56 57 41 54 41 56 41 57 48 83 EC 50 44 8B 05")]
+    public partial ulong Draw(bool unk);
+
+    [MemberFunction("E9 ?? ?? ?? ?? CC CC CC CC CC CC CC CC CC CC 48 89 5C 24 ?? 48 89 6C 24 ?? 48 89 7C 24 ?? 41 56")]


Yes I realize this is a terrible signature, let me know if you have any better ideas for how to do this!

universalconquistador · 2026-05-14T17:06:41Z

Breaking Changes

Member exists in left but not in right

FFXIVClientStructs.FFXIV.Client.Graphics.Kernel: 2

RenderCommandScissorsRect: 4

int Left

int Top

int Right

int Bottom

RenderCommandClearDepth: 2

float ClearType

int ClearCheck

I believe basically none of these changed render command fields were correct? So I think we're good to make these breaking changes.

universalconquistador · 2026-05-15T03:43:27Z


+[StructLayout(LayoutKind.Explicit, Size = 0x40)]
+public unsafe struct TextureMipRenderTarget {
+    [FieldOffset(0x00)] public void* D3D11RenderTargetViewOrDepthStencilView; // ID3D11RenderTargetView(1?) or ID3D11DepthStencilView(1?)


I bet we could use a CExporterUnion here to present both the ID3D11RenderTargetView* and the ID3D11DepthStencilView*

Haselnussbomber

Pushed some changes, but other than that it looks fine to me.

Haselnussbomber · 2026-05-27T22:02:22Z

    public static partial Device* Instance();

-    [FieldOffset(0x8)] public void* ContextArray; // Client::Graphics::Kernel::Context array
+    [FieldOffset(0x8)] public void* ContextArray; // TODO: We have a struct for this now (breaking change)


Just as a note, I would have no idea what to change this to. I guess Context* something?
Would rather add a Span for that if the size is constant and the length is known.

I have no idea what the length is, whether it's fixed size or not, and where the contexts come from. I didn't look into it because it wasn't critical for what I was doing; any function you hook that does drawing is going to have a thread-local context nice and ready to be used.

If you want to add it, its max length is 16. The actual length is stored in 0x68.

DeviceDX11_Initialize:

v7 = 16; *(_QWORD *)(v3 + 0xC0) = (v4 >> 1) & 0x7FFFFFFFFFFFFFF0i64; if ( *((_DWORD *)a2 + 2) < 16u ) v7 = *((_DWORD *)a2 + 2); *(_DWORD *)(v3 + 0x68) = v7;

sourpuh · 2026-06-09T19:38:21Z

+    [FieldOffset(0x10)] public ShaderCodeResourceHandle* PrimitiveUIVSResource;
+    [FieldOffset(0x18)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_2;
+    [FieldOffset(0x20)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_3;
+    [FieldOffset(0x28)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_4;


Should this use a FixedSizeArray like GBuffers?

Those are all the same shaderresourcehandle, I'm not really sure whether they are treated like an array. But if someone really cares one way or another I could change it.

I misunderstood; I didn't realize they were all pointing to the same shader handle. I think it makes sense to do it this way since I guess they are useless padding.

sourpuh · 2026-06-09T19:38:36Z

+    [FieldOffset(0xE8)] public VertexShader* PrimitiveUIVS;
+    [FieldOffset(0xF0)] internal VertexShader* _primitiveUIVS_2;
+    [FieldOffset(0xF8)] internal VertexShader* _primitiveUIVS_3;
+    [FieldOffset(0x100)] internal VertexShader* _primitiveUIVS_4;


Also FixedSizeArray?

Those are all the same VertexShader*, I'm not really sure whether they are treated like an array. But if someone really cares one way or another I could change it.

sourpuh

Just a few changes and LGTM

sourpuh · 2026-06-11T18:24:09Z

+    [FieldOffset(0x10)] public ShaderCodeResourceHandle* PrimitiveUIVSResource;
+    [FieldOffset(0x18)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_2;
+    [FieldOffset(0x20)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_3;
+    [FieldOffset(0x28)] internal ShaderCodeResourceHandle* _primitiveUIVSResource_4;


I misunderstood; I didn't realize they were all pointing to the same shader handle. I think it makes sense to do it this way since I guess they are useless padding.

universalconquistador added 5 commits May 13, 2026 20:15

Adds client graphics kernel context.

81aeda6

Adds ImmediateContext stuff and packed render state structs.

e3c9ef1

Adds render target view / depth stencil view access to Textures.

b7f02b8

Adds UI drawing stuff.

0f2118f

Removes address comment I left in by accident

67e25b0

universalconquistador commented May 14, 2026

View reviewed changes

universalconquistador added 4 commits May 14, 2026 08:43

Fixes misnamed ImmediateContext field.

9954873

Improves clear rectangle field name.

73525a5

Removes another address comment I left in by mistake.

ab37087

Adds missing force bool to DirectX CExporter type override.

265c466

github-actions Bot added the breaking change PR contains breaking changes and wont be merged before a new patch label May 14, 2026

Restores some backwards-compatibility with improved fields.

62e6622

universalconquistador commented May 15, 2026

View reviewed changes

Caraxi reviewed May 20, 2026

View reviewed changes

Comment thread FFXIVClientStructs/FFXIV/Client/Graphics/Render/RenderTargetManager.cs Outdated

Caraxi reviewed May 20, 2026

View reviewed changes

Comment thread FFXIVClientStructs/FFXIV/Client/UI/UIModule.cs Outdated

universalconquistador added 4 commits May 20, 2026 03:00

Corrects render command rectangles and re-adds obsoleted fields.

0f2f956

Adds packeddepthstencil stencil ref field.

321e11e

Fixes void return type of uimodule draw2d.

1bd8e90

Gives public unk's actual names.

85331c8

universalconquistador requested a review from Caraxi May 21, 2026 19:11

universalconquistador and others added 4 commits May 22, 2026 12:46

Improves comments

f90eec1

Opinionated style changes

c6b57a9

Add GenerateInterop to RenderCommandMultiViewport

2c5b0f2

Fix some return types

325e3c5

Haselnussbomber reviewed May 27, 2026

View reviewed changes

Add AtkServer pointer to AtkModule

3dac72c

sourpuh reviewed Jun 2, 2026

View reviewed changes

Comment thread FFXIVClientStructs/FFXIV/Client/Graphics/Kernel/ImmediateContext.cs Outdated

sourpuh reviewed Jun 2, 2026

View reviewed changes

Comment thread FFXIVClientStructs/FFXIV/Client/Graphics/Kernel/Context.cs Outdated

Merge branch 'main' into render-commands-and-friends

3e62de0

Restores obsolete clear command and adds new correct one.

af3729d

github-actions Bot removed the breaking change PR contains breaking changes and wont be merged before a new patch label Jun 9, 2026

universalconquistador added 3 commits June 9, 2026 00:25

Updates deprecation of clear render command reference.

a393253

Fixes ImmediateContext::ProcessCommands

f00afe1

Uses render command type enum

52f4b27

universalconquistador requested a review from sourpuh June 9, 2026 07:43

sourpuh suggested changes Jun 9, 2026

View reviewed changes

Fixes typos

27169ae

universalconquistador requested a review from sourpuh June 10, 2026 23:51

sourpuh approved these changes Jun 11, 2026

View reviewed changes

universalconquistador and others added 4 commits June 11, 2026 13:22

Fixes RenderCommandClear fields and size.

fbf0d5a

Fixes naming

bfaf82b

Fixes threadlocals typo

679a710

Merge branch 'main' into render-commands-and-friends

b3b249f

pohky merged commit 024256e into aers:main Jun 12, 2026
5 checks passed

Conversation

universalconquistador commented May 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

universalconquistador commented May 14, 2026

Breaking Changes

Member exists in left but not in right

FFXIVClientStructs.FFXIV.Client.Graphics.Kernel: 2

RenderCommandScissorsRect: 4

RenderCommandClearDepth: 2

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Haselnussbomber left a comment

Choose a reason for hiding this comment

Uh oh!

Haselnussbomber May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sourpuh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Haselnussbomber May 27, 2026 •

edited

Loading