Struct simics_api_sys::bindings::gfx_console_frontend_interface

#[repr(C)]
pub struct gfx_console_frontend_interface {

    pub start: Option<unsafe extern "C" fn(obj: *mut conf_object_t, backend: *mut conf_object_t) -> c_int>,
    pub stop: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>,
    pub set_title: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, short_title: *const c_char, long_title: *const c_char)>,
    pub set_size: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, width: c_int, height: c_int)>,
    pub set_visible: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, visible: bool)>,
    pub set_contents: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, left: c_int, top: c_int, right: c_int, bottom: c_int, data: *const uint32)>,
    pub invalidate_contents: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>,
    pub set_text_mode: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, text_mode: bool)>,
    pub signal_text_update: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>,
    pub set_grab_mode: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, active: bool)>,
    pub set_mouse_pos: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, x: c_int, y: c_int)>,
    pub set_keyboard_leds: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, led_state: gfx_console_led_t)>,
    pub set_grab_modifier: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, modifier: sim_key_t)>,
    pub set_grab_button: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, button: gfx_console_mouse_button_t)>,
}

Fields

start: Option<unsafe extern "C" fn(obj: *mut conf_object_t, backend: *mut conf_object_t) -> c_int>

Called when the backend is finalised. Should return a unique handle identifying the given backend object to the frontend.

stop: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>

Called when the backend is being destroyed.

set_title: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, short_title: *const c_char, long_title: *const c_char)>

Set window title of the frontend associated to the specified backend. Two title strings are given, where the long title is meant for a window title bar and the short for a window list. The long title string is at least as long as the short.

set_size: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, width: c_int, height: c_int)>

Called when the screen size of the specified backend changes.

set_visible: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, visible: bool)>

Tell the frontend to show/hide its GUI window.

set_contents: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, left: c_int, top: c_int, right: c_int, bottom: c_int, data: *const uint32)>

Update the screen contents in the rectangle between (left, top) and (right, bottom), inclusive. ‘data’ is the start of the screen pixel array, so the first pixel of the rectangle is at &data[width * top + left], where width was set by set_size.

invalidate_contents: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>

Tell the frontend that the data argument passed to set_contents is no longer valid. This must be called upon a screen size change, before set_size.

set_text_mode: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, text_mode: bool)>

Inform the frontend whether or not we are currently in VGA text mode.

signal_text_update: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int)>

Tell the frontend that text arrived to the backend from the attached device, using vga_text_update.

set_grab_mode: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, active: bool)>

Inform the frontend that the grab mode of the specified backend has changed.

set_mouse_pos: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, x: c_int, y: c_int)>

Tell the frontend to set the host mouse cursor to (x, y), with ranges [0, width - 1] and [0, height - 1], where width and height were set by set_size.

set_keyboard_leds: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, led_state: gfx_console_led_t)>

Inform frontend that the keyboard LED state have been updated. The new state of the LEDs is given as a bitmask.

set_grab_modifier: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, modifier: sim_key_t)>

Inform frontend that the grab modifier has changed.

set_grab_button: Option<unsafe extern "C" fn(obj: *mut conf_object_t, handle: c_int, button: gfx_console_mouse_button_t)>

Inform frontend that the grab button has changed.

Trait Implementations

impl Clone for gfx_console_frontend_interface

fn clone(&self) -> gfx_console_frontend_interface

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for gfx_console_frontend_interface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for gfx_console_frontend_interface

fn default() -> gfx_console_frontend_interface

Returns the “default value” for a type.

impl Hash for gfx_console_frontend_interface

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for gfx_console_frontend_interface

fn cmp(&self, other: &gfx_console_frontend_interface) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for gfx_console_frontend_interface

fn eq(&self, other: &gfx_console_frontend_interface) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for gfx_console_frontend_interface

fn partial_cmp( &self, other: &gfx_console_frontend_interface, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for gfx_console_frontend_interface

impl Eq for gfx_console_frontend_interface

impl StructuralPartialEq for gfx_console_frontend_interface