gate_video_screencontrol_t Interface Reference

General video frame reader interface. More...

#include <videosources.h>

Inheritance diagram for gate_video_screencontrol_t:

Public Member Functions
gate_result_t	get_cursor_pos (gate_int32_t *ptr_x, gate_int32_t *ptr_y)
	Returns the current cursor position on the screen (e.g. mouse pointer)
gate_result_t	move_cursor (gate_int32_t x, gate_int32_t y)
	Move the main cursor to the given coordinates on screen.
gate_result_t	change_cursor_button_state (gate_int32_t x, gate_int32_t y, gate_enumint_t button_id, gate_enumint_t button_state)
	Sends a cursor-button-state change event (e.g. mouse-button-down)
gate_result_t	change_key_state (gate_input_keycode_t key_code, gate_enumint_t key_state)
	Sends a keyboard-key state-change event (e.g. key-pressed)
Public Member Functions inherited from gate_video_source_t
char const *	get_id ()
	Returns a system-unique-ID about the video source.
char const *	get_name ()
	Returns a human readable name of the video source.
gate_intptr_t	get_handle ()
	Returns the native handle of the internal implementation resouce.
gate_size_t	get_supported_formats (gate_video_format_t *format_buffer, gate_size_t format_buffer_count)
	Fills the given buffer with different supported frame formats (that can be used in open() method)
gate_result_t	open (gate_video_format_t const *format)
	Openes a video frame stream source to read frames in a specific format.
gate_result_t	close ()
	Closes an opened video frame stream source.
Public Member Functions inherited from gate_video_reader_t
gate_result_t	read (gate_video_frame_t *frame)
	Reads one frame from a video frame source.
Public Member Functions inherited from gate_object_t
char const *	get_interface_name ()
	Returns on object's interface path name.
void	release ()
	Decrease object's reference counter, releases the object when count reaches zero.
int	retain ()
	Increase object's reference counter.

Detailed Description

General video frame reader interface.

Member Function Documentation

get_cursor_pos()

gate_result_t get_cursor_pos	(	gate_int32_t *	ptr_x,
		gate_int32_t *	ptr_y )

Returns the current cursor position on the screen (e.g. mouse pointer)

Parameters

[out]	ptr_x	Pointer to integer receiving the x-coordinate on screen
[out]	ptr_y	Pointer to integer receiving the y-coordinate on screen

Returns

GATE_RESULT_* result codes

move_cursor()

gate_result_t move_cursor	(	gate_int32_t	x,
		gate_int32_t	y )

Move the main cursor to the given coordinates on screen.

Parameters

[in]	x	x coordinate on screen
[in]	y	y coordinate on screen

Returns

GATE_RESULT_* result codes

change_cursor_button_state()

gate_result_t change_cursor_button_state	(	gate_int32_t	x,
		gate_int32_t	y,
		gate_enumint_t	button_id,
		gate_enumint_t	button_state )

Sends a cursor-button-state change event (e.g. mouse-button-down)

Parameters

[in]	x	desired x coordinate of cursor on screen
[in]	y	desired y coordinate of cursor on screen
[in]	button_id	Button ID that's state is required to change, see GATE_VIDEO_SCREENCONTROL_BUTTON_* (e.g. left/middle/right mouse button)
[in]	button_state	New button state to be applied, see GATE_VIDEO_SCREENCONTROL_STATE_* (e.g. down-pressed, up-released)

Returns

GATE_RESULT_* result codes

change_key_state()

gate_result_t change_key_state	(	gate_input_keycode_t	key_code,
		gate_enumint_t	key_state )

Sends a keyboard-key state-change event (e.g. key-pressed)

Parameters

[in]	key_code	Generic key-code of key to be sent
[in]	key_state	New state to be applied, see GATE_VIDEO_SCREENCONTROL_STATE_* (e.g. key-down)

Returns

GATE_RESULT_* result codes

---

The documentation for this interface was generated from the following file:

• src/gate/io/videosources.h