Synergy Software Package User's Manual

#include <sf_el_gx_api.h>

Data Fields

ssp_err_t(* open )(sf_el_gx_ctrl_t *const p_ctrl, sf_el_gx_cfg_t const *const p_cfg)
 
ssp_err_t(* close )(sf_el_gx_ctrl_t *const p_ctrl)
 
ssp_err_t(* versionGet )(ssp_version_t *p_version)
 
UINT(* setup )(GX_DISPLAY *p_display)
 
ssp_err_t(* canvasInit )(sf_el_gx_ctrl_t *const p_ctrl, GX_WINDOW_ROOT *p_window_root)
 

Detailed Description

Shared Interface definition for the SSP GUIX adaptation framework

Field Documentation

◆ canvasInit

ssp_err_t(* sf_el_gx_api_t::canvasInit) (sf_el_gx_ctrl_t *const p_ctrl, GX_WINDOW_ROOT *p_window_root)

Canvas initialization. Set the memory address of the initial canvas.

Implemented as
Parameters
[in,out]p_ctrlPointer to SF_EL_GX control block structure.
[in]p_window_rootPointer to GUIX root window context.

◆ close

ssp_err_t(* sf_el_gx_api_t::close) (sf_el_gx_ctrl_t *const p_ctrl)

Close SSP GUIX adaptation framework.

Implemented as
Parameters
[in,out]p_ctrlPointer to SF_EL_GX control block structure.

◆ open

ssp_err_t(* sf_el_gx_api_t::open) (sf_el_gx_ctrl_t *const p_ctrl, sf_el_gx_cfg_t const *const p_cfg)

Open SSP GUIX adaptation framework.

Implemented as
Parameters
[in,out]p_ctrlPointer to SF_EL_GX control block structure. Must be declared by user. Value set here.
[in]p_cfgPointer to SF_EL_GX configuration structure. All elements of this structure must be set by user.

◆ setup

UINT(* sf_el_gx_api_t::setup) (GX_DISPLAY *p_display)

Microsoft GUIX Driver setup entry.

Implemented as
Parameters
[in]p_displayPointer to GUIX display driver setup function.

◆ versionGet

ssp_err_t(* sf_el_gx_api_t::versionGet) (ssp_version_t *p_version)

Get version.

Implemented as
Parameters
[in]p_versionPointer to the memory to store the version information.

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