What is ClipState?

[johnbl]

I see that the following check is made in some plugins:

if (clipState != ClipState.BeforeClip) return;

And I saw that the possible values are BeforeClip, AfterClip and Inventory. What do they represent?

[JackCeparou]

'public void PaintTopInGame(ClipState clipState)' method make 3 calls per frame.

1. BeforeClip : before inventory & other is rendered => can be removed by clipping?
2. Inventory : inventory (displayed?) => I guess it's just a state for performance optimisation
3. AfterClip : after inventory & other is rendered => can display over D3 UI Elements?

Note: that's just a guess work, only KJ can answer precisely to this.

[johnbl]

Thanks Jack. So if I check for BeforeClip and draw something, when I talk to the blacksmith it would disappear?
If I check for AfterClip and draw something, would it, in this example, only appear if I talked to the blacksmith?

[JackCeparou]

So if I check for BeforeClip and draw something, when I talk to the blacksmith it would disappear?

That's how I understand it, if you draw something in the rectangle of a vendor in the BeforeClip cycle, it will be 'behind' the vendor UI.

If I check for AfterClip and draw something, would it, in this example, only appear if I talked to the blacksmith?

That's another matter, vendors share the same 'window' UI, afaik there is no way atm to check which vendor is opened without some voodoo.
But if you draw something in the 'AfterClip' cycle it will be draw over the (virtually) top of any D3 UI elements.