ScnLib_ShowCaptureRegionFrame()

ScnLib_ShowCaptureRegionFrame()

Std EditionPro EditionMax EditionUltra Edition
C++ __declspec(dllimport) void __stdcall ScnLib_ShowCaptureRegionFrame(BOOL bEnable);
C# [DllImport("ScnLib.dll")] public static extern void ScnLib_ShowCaptureRegionFrame(bool Enable);
Basic Public Declare Sub ScnLib_ShowCaptureRegionFrame Lib "ScnLib.dll" (ByVal Enable As Boolean)
Delphi procedure ScnLib_ShowCaptureRegionFrame(Enable: LongBool); stdcall; external 'ScnLib.dll';
  • Description
    Toggle the visibility of the capture region frame on the screen.

  • Parameters
    • Enable [in]
      TRUE: To show.
      FALSE: To hide.
  • Return Value
    None.

  • Remarks
    Use this function to toggle the visibility of the capture region frame on the screen. The capture region frame, featuring a thick border and a central crosshair, outlines the designated screen capture area and automatically updates to reflect any position changes of the area. When not recording, the frame appears green (or cyan if a capture window is set via ScnLib_SetCaptureWnd() and follows the position of the capture window), turning red during active recording. The crosshair vanishes during recording and the frame blinks when recording is paused, signaling the paused state.

    You can adjust the size of the capture region frame by dragging its borders or corners. For precise adjustments, position your mouse cursor on the desired border or corner, and use keyboard arrow keys for pixel-by-pixel movement. To move the entire frame, simply drag the central crosshair. Additionally, double-clicking on the border of the capture region frame will attach the capture window to the window directly beneath it. To detach the capture window, simply right-click on the central crosshair or the border of the capture region frame. Moreover, double-clicking the central crosshair enables you to begin selecting a new capture region or window.

    You can also call ScnLib_LockCaptureRegionFrameAspectRatio() to lock the aspect ratio of the capture region frame, ensuring it remains constant during adjustments.

    By default, the capture region frame is set to be invisible. To verify its current visibility status, refer to the function ScnLib_GetCaptureRegionFrameWnd(). Should the default style or operation of the capture region frame not meet your preferences, you have the option to keep it invisible and create your own custom capture region frame. This can be based on the coordinates of the screen capture region acquired by calling ScnLib_GetCaptureRegion().

  • See Also
    ScnLib_SetCaptureRegion()
    ScnLib_GetCaptureRegion()
    ScnLib_SetCaptureWnd()
    ScnLib_SelectCaptureRegionA/W()
    ScnLib_GetCaptureRegionFrameWnd()
    ScnLib_LockCaptureRegionFrameAspectRatio()

Try the SDK for FREE SDK APIs overview