Bink SDK 1.5v

# BinkCheckCursor

The function BinkCheckCursor checks to see if the mouse is currently inside the specified window rectangle, and, if so, hides it.

    S32 BinkCheckCursor(
      OS_WND window,
      S32 check_x,
      S32 check_y,
      U32 width,
      U32 height
    );

#### In Parameters

window
  Specifies the window handle (under Win32) or window pointer (under MacOS) that the check_x and check_y parameters are relative to. You can pass in NULL for this parameter.
check_x
  Specifies the X (left) coordinate of the test rectangle.
check_y
  Specifies the X (left) coordinate of the test rectangle.
width
  Specifies the width of the test rectangle.
height
  Specifies the height of the test rectangle.

#### Returns

Returns the total number of times cursor had to be hidden (which is passed to BinkRestoreCursor).

#### Discussion

This function will determine if the mouse is currently in the specified window rectangle, and, if it is, hide it. This will let you move the mouse without leaving mouse trails behind with software-drawn mouse cursors. You have to call this function before you lock the primary surface, or the cursor won't be hidden. Check out the BinkIsSoftwareCursor function for an example of how to use this function. This function returns a count value that you need to pass to the BinkRestoreCursor function to restore the mouse cursor to its original state.

Group: BinkBuffer API
Related Sections: Mouse Cursors
Related Functions: BinkIsSoftwareCursor, BinkRestoreCursor
Related Basic Types: OS_WND, S32, U32

For technical support, e-mail Bink1@radgametools.com
© Copyright 1994-2003 RAD Game Tools, Inc. All Rights Reserved.