ScnLib_ShowInGameOverlay()

ScnLib_ShowInGameOverlay()

Std EditionPro EditionMax EditionUltra Edition
C++ __declspec(dllimport) void __stdcall ScnLib_ShowInGameOverlay(const PVOID pRGB, int nWidth, int nHeight, int nBitCount);
C# [DllImport("ScnLib.dll")] public static extern void ScnLib_ShowInGameOverlay(IntPtr RGB, int Width, int Height, int BitCount);
Basic Public Declare Sub ScnLib_ShowInGameOverlay Lib "ScnLib.dll" (ByVal RGB As IntPtr, ByVal Width As Int32, ByVal Height As Int32, ByVal BitCount As Int32)
Delphi procedure ScnLib_ShowInGameOverlay(const RGB: Pointer; Width: Integer; Height: Integer; BitCount: Integer); stdcall; external 'ScnLib.dll';
  • Description
    Display, update, or hide the in-game overlay.

  • Parameters
    • RGB [in]
      The pointer to the pixel buffer of the overlay DIB (Device-Independent Bitmaps).
    • Width [in]
      The width of the overlay DIB.
    • Height [in]
      The height of the overlay DIB.
    • BitCount [in]
      The pixel bit count for the overlay DIB, supporting only 32, 24, and 16-bit RGB DIB.
  • Return Value
    None.

  • Remarks
    Use this function to display, update, or hide the in-game overlay. This feature enables you to overlay custom elements (such as recording status or game frame rate) onto the game screen, providing additional information to the user without exiting full-screen mode. To show or update the in-game overlay, provide valid DIB (Device-Independent Bitmaps) image parameters. To hide the overlay, pass in a parameter with a zero value. Note that the row pitch of the DIB must be a multiple of the size of a DWORD (4 bytes). This is particularly important when working with 24-bit or 16-bit DIBs. To adjust the overlay's position on the game screen, call ScnLib_SetInGameOverlayPosition(). This functionality becomes available once the game screen capture mode is activated through ScnLib_EnableGameCaptureMode().

  • See Also
    ScnLib_EnableGameCaptureMode()
    ScnLib_SetInGameOverlayPosition()

Try the SDK for FREE SDK APIs overview