DEVA DEVA028, User Manual

Page: 46 / 49

3.7.7 capture_cursor
result capture_cursor(capture, coordinate_type, cursor_type, cx, cy, cursor_colour,
angle)
Parameter Type Description
capture U32
The handle of the capture stream to be
flushed.
coordinate_ty
pe CAPTURE_COORDIN
ATE_TYPES
Specifies whether the cy and cy parameters
relate to captured image pixels or user’s
application window pixels.
cursor_type CAPTURE_CURSOR_
TYPES The type of cursor.
cx I32 The horizontal centre of the cursor relative to
the centre of the captured image pixels or the
user’s application window pixels depending on
coordinate_type .
cy I32 The vertical centre of the cursor relative to the
centre of the captured image pixels or the
user’s application window pixels depending on
coordinate_type .
cursor_colour U32 The RGB colour of the cursor.
angle F64 A cursor rotation angle may be specified.
result U32 0 = Operation failed
1 = Operation completed
Applies a cursor to the capture stream being rendered.
This function is used to automatically overlay one of the built-in cursor types such as a
cross hair on a capture stream that is being rendered. The
angle parameter allows the
cross hairs to be rotated.