VLC  4.0.0-dev
vlc_window_mouse_event Struct Reference

Window mouse event. More...

Data Fields

enum vlc_window_mouse_event_type type
 Event type. More...
 
int x
 Pointer abscissa. More...
 
int y
 Pointer ordinate. More...
 
int button_mask
 Pressed button. More...
 

Detailed Description

Window mouse event.

This structure describes a pointer input event on a window.

Field Documentation

◆ button_mask

int vlc_window_mouse_event::button_mask

Pressed button.

See vlc_mouse_button for possible values.

This is set if event does not equal VLC_WINDOW_MOUSE_MOVED.

Referenced by vout_display_window_MouseEvent().

◆ type

enum vlc_window_mouse_event_type vlc_window_mouse_event::type

Event type.

Referenced by vout_display_window_MouseEvent().

◆ x

int vlc_window_mouse_event::x

Pointer abscissa.

The pointer abscissa is relative to the window and expressed in pixels. Abscissa goes from left to right, such that the left-most column is at 0 and the right-most column is at width minus one.

A negative abscissa refers to pixels to the left of the window, and an abscissa of width or larger refers to pixels to the right.

This is only set if event equals VLC_WINDOW_MOUSE_MOVED.

Referenced by vout_display_window_MouseEvent().

◆ y

int vlc_window_mouse_event::y

Pointer ordinate.

The pointer ordinate is relative to the window and expressed in pixels. Ordinate goes from top to bottom, such that the top-most row is at 0 and the bottom-most column is at height minus one.

A negative ordinate refers to pixels above the window, and an ordinate of height or larger refers to pixels below the window.

This is only set if event equals VLC_WINDOW_MOUSE_MOVED.

Referenced by vout_display_window_MouseEvent().


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