Scriptel ScripTouch ProScript C Library
This documentation contains information about the ScripTouch ProScript C Library.
Data Structures
Here are the data structures with brief descriptions:
[detail level 12]
 Cargb
 Cscriptel_colorThis structure describes a particular color in 32-bit space
 Cscriptel_deviceThis structure represents a physically attached Scriptel ScripTouch device
 Cscriptel_device_driverThis structure contains function pointers to the functions required to interact with a device
 Cscriptel_device_region_buttonThis structure contains all button specific information about a region
 Cscriptel_device_region_commonThis structure contains all of the items that are common to all regions regardless of type
 Cscriptel_device_region_containerThis structure contains all container specific information about a region
 Cscriptel_device_region_infoThis union contains all types of regions
 Cscriptel_device_region_lineThis structure contains all line specific region information
 Cscriptel_hid_capabilitiesThis structure describes the capabilities report of a ScripTouch device
 Cscriptel_hid_feature_asic_resetThis structure allows the reset of a device ASIC
 Cscriptel_hid_feature_calibrateThis structure contains information about whether or not the device is currently calibrating
 Cscriptel_hid_feature_calibration_dataThis report contains information about the current calibration state of a ScripTouch device
 Cscriptel_hid_feature_contact_count_maximumThis report is capable of retrieving the maximum number of track-able contacts in a multi-touch digitizer
 Cscriptel_hid_feature_coordinate_rangeThis report is capable of getting the coordinate range from the device
 Cscriptel_hid_feature_delete_resourceStructure that can be used to delete a resource
 Cscriptel_hid_feature_delete_screenStructure that can be used to delete a screen
 Cscriptel_hid_feature_device_configureThis report is capable of getting the device configuration
 Cscriptel_hid_feature_device_statusThis report contains information about a ScripTouch device's current running state
 Cscriptel_hid_feature_display_chunkThis structure contains information about a raster that should be displayed on the screen of a device
 Cscriptel_hid_feature_display_contentThis structure contains information related to display content
 Cscriptel_hid_feature_display_infoThis structure contains static information about a device's display and capabilities
 Cscriptel_hid_feature_display_settingsThis structure contains information about dynamic display settings
 Cscriptel_hid_feature_download_command_statusThis report indicates to the device that a firmware update session has been completed
 Cscriptel_hid_feature_edit_screenStructure that can be used to modify a screen
 Cscriptel_hid_feature_error_correction_tableThis report is capable of getting and setting the internal error correction table on the device
 Cscriptel_hid_feature_firmware_downloadThis report is capable of uploading a new page of firmware to the device
 Cscriptel_hid_feature_frequency_amplitudeThis report contains ASIC frequency and amplitude settings
 Cscriptel_hid_feature_general_parametersThis report gets and sets general digitizer parameters for the device
 Cscriptel_hid_feature_guid16 byte char array holding the guid value for the device
 Cscriptel_hid_feature_operating_modesThis report gets the supported operating modes of the device
 Cscriptel_hid_feature_output_parametersThis structure contains information about output configuration
 Cscriptel_hid_feature_pen_parametersThis structure contains information about pen parameters
 Cscriptel_hid_feature_peripheral_configurationThis structure contains information about peripheral configuration
 Cscriptel_hid_feature_pixel_retrieval_location
 Cscriptel_hid_feature_pixel_valuesThis structure contains pixel information for getting or setting a portion of the screen
 Ccolor_data
 Cscriptel_hid_feature_power_stateThis report is capable of getting and setting the ASIC power state
 Cscriptel_hid_feature_regionThis union contains all region information
 Cscriptel_hid_feature_region_buttonDefines a structure that represents a button region on the device
 Cscriptel_hid_feature_region_commonThis structure represents a region on the device that can be get or set
 Cscriptel_hid_feature_region_containerDefines a structure that represents a container/ink region on the device
 Cscriptel_hid_feature_region_deleteDescribes a structure that can be used to delete a region
 Cscriptel_hid_feature_region_edit_completeThis structure allows for the saving or discarding of updated region information
 Cscriptel_hid_feature_region_graphicDefines a structure that represents a graphic region on the device
 Cscriptel_hid_feature_region_lineDefines a structure that represents a line region on the device
 Cscriptel_hid_feature_region_textDefines a structure that represents a text region on the device
 Cscriptel_hid_feature_region_updateThis structure describes an update to a region
 Cscriptel_hid_feature_register_getThis structure contains information from an ASIC register
 Cscriptel_hid_feature_register_setThis structure allows setting of ASIC registers
 Cscriptel_hid_feature_report_regionThis structure transports a single region
 Cscriptel_hid_feature_resourceDefines a structure for a resource on the device
 Cscriptel_hid_feature_resource_availabilityDefines a structure that represents the amount of open resources on the device
 Cscriptel_hid_feature_resource_info
 Cscriptel_hid_feature_run_modeThis report is capable of both sending and receiving the current device run mode
 Cscriptel_hid_feature_save_configurationThis report is capable of setting the default run-mode on startup
 Cscriptel_hid_feature_screenStructure that can be used to get or set a screen on the device
 Cscriptel_hid_feature_screen_region_edit_completeThis structure allows for the saving or discarding of updated screen and region information
 Cscriptel_hid_feature_screen_region_infoDescribes a structure that gets the screen and region limitations of the current device
 Cscriptel_hid_feature_serial_numberThis report is capable of getting and setting the internal serial number on the device
 Cscriptel_hid_feature_touch_parametersThis structure contains information about touch parameters
 Cscriptel_hid_feature_tuning_status
 Cscriptel_hid_feature_versionThis report is capable of getting the device version information
 Cscriptel_hid_input_adc_valuesThis structure represents a sample from the ADC
 Cscriptel_hid_input_button_downThis structure contains a button down event
 Cscriptel_hid_input_button_moveThis structure contains a button move event
 Cscriptel_hid_input_button_pressThis structure contains a button press event
 Cscriptel_hid_input_button_upThis structure contains a button up event
 Cscriptel_hid_input_card_swipeThis structure carries information regarding a magnetic card swipe
 Cscriptel_hid_input_coordinateThis structure represents a basic coordinate without any region information
 Cscriptel_hid_input_debug_coordinateThis structure contains information about a debug coordinate from a ScripTouch device with debug firmware
 Cscriptel_hid_input_extended_coordinateThis structure represents an extended coordinate that does contain region information
 Cscriptel_hid_input_typeThis structure is common to all input reports
 Cscriptel_input_reportThis union contains all valid input report types
 Cscriptel_pen_coordinate
 Cscriptel_sample_infoThis union represents all types of sample information that can be associated with a particular sample
 Cscriptel_sample_info_commonThis structure contains information about a particular sample that is common to both pen and touch samples
 Cscriptel_sample_info_penThis structure contains information about a pen sample
 Cscriptel_sample_info_touchThis structure contains information about a touch sample