2
Disclaimer
The information written in this document is assumed to be accurate without guarantee. The
information in this manual is subject to change for functional or performance improvements
without notice. SEGGER Microcontroller GmbH (SEGGER) assumes no responsibility for any errors
or omissions in this document. SEGGER disclaims any warranties or conditions, express, implied
or statutory for the fitness of the product for a particular purpose. It is your sole responsibility
to evaluate the fitness of the product for any specific use.
Copyright notice
You may not extract portions of this manual or modify the PDF file in any way without the prior
written permission of SEGGER. The software described in this document is furnished under a
license and may only be used or copied in accordance with the terms of such a license.
© 2022 SEGGER Microcontroller GmbH, Monheim am Rhein / Germany
Trademarks
Names mentioned in this manual may be trademarks of their respective companies.
Brand and product names are trademarks or registered trademarks of their respective holders.
Contact address
SEGGER Microcontroller GmbH
Ecolab-Allee 5
D-40789 Monheim am Rhein
Germany
Tel. +49 2173-99312-0
Fax. +49 2173-99312-28
E-mail:
*
Internet: www.segger.com
*
By sending us an email your (personal) data will automatically be processed. For further information please refer to our
privacy policy which is available at https://www.segger.com/legal/privacy-policy/.
emWin User Guide & Reference Manual © 2022 SEGGER Microcontroller GmbH
3
Manual versions
This manual describes the current software version. If you find an error in the manual or a
problem in the software, please inform us and we will try to assist you as soon as possible.
Contact us for further information on topics or functions that are not yet documented.
Print date: September 7, 2022
Software Revision Date By Description
6.28 0 ?????? FO
Chapter 2-D Graphic Library updated.
• New function GUI_GCACHE_1_Create() added.
• New function GUI_GCACHE_1_CreateEx() added.
Chapter Colors updated.
• New function GUI_BlendColors() added.
Chapter Fonts updated.
• Section ’Changing the font style during run-time’ added.
• Section ’Other TrueType-based formats’ added.
Chapter The Window Manager (WM) updated.
• New function WM_GetCapture() added.
Chapter Widgets updated.
• New function WIDGET_GetType() added.
• New function EDIT_SetPasswordChar() added.
• New function EDIT_SetPasswordMode() added.
• New function LISTBOX_Clear() added.
• New function LISTVIEW_GetOverlap() added.
• New function LISTVIEW_SetOverlap() added.
• Parameter description in LISTBOX_SetFixedScrollPos() corrected.
• New function LISTBOX_GetFixedScrollPos() added.
• WIDGET_ITEM_DRAW_TEXT, WIDGET_ITEM_DRAW_BACKGROUND and WID-
GET_ITEM_DRAW_FOCUS added to LISTBOX_OwnerDraw(). The old command
WIDGET_ITEM_DRAW is still supported.
• New function KEYBOARD_GetKeyRect() added.
• Changed prototype of function pointer being set by EDIT_SetpfAdd-
KeyEx(). The function returns a value now.
Chapter Anti-aliasing updated.
• GUI_AA_DrawPolyOutlineEx() removed, compatibility macro added
which will call GUI_AA_DrawPolyOutline() instead.
Chapter Memory Devices updated.
• New function GUI_MEMDEV_CopyRect() added.
Chapter Bitmap Converter updated.
• Command table updated and restructured.
• -ditherinto… commands added.
6.26 0 220428 FO
Chapter The Window Manager (WM) updated.
• New function WM_GetContentRect() added.
• New function WM_GetContentRectEx() added.
• New function WM_IsUntouchable() added.
Chapter Widgets updated.
• New SCROLLER widget added: smartphone-like scroll bar widget.
• New WHEEL widget added: new and improved version of the LIST-
WHEEL widget.
• Parameters of SWIPELIST_GetOverlap() changed.
• Parameters of SWIPELIST_SetOverlap() changed.
• Parameters of SWIPELIST_GetDefaultOverlap() changed.
• Parameters of SWIPELIST_SetDefaultOverlap() changed.
6.24 0 220118 FO
Chapter Configuration updated.
• New function GUI_SetOnLogFunc() added.
• New function GUI_SetOnWarnFunc() added.
Chapter 2-D Graphic Library updated.
• New function GUI_DrawArcHREx() added.
• New function GUI_DrawFrame() added.
• New function GUI_DrawFrameEx() added.
Chapter Displaying bitmap files updated.
• Added “Limitations” sub-section to JPEG section.
Chapter Colors updated.
• Added new color conversion GUICC_666_18.
• Added new color conversion GUICC_M666_18.
Chapter Widgets updated.
• New function DROPDOWN_Clear() added.
• New function DROPDOWN_SetText() added.
• New function HEADER_GetBorderH() added.
• New function HEADER_GetBorderV() added.
• New function HEADER_SetBorderH() added.
emWin User Guide & Reference Manual © 2022 SEGGER Microcontroller GmbH
4
Software Revision Date By Description
• New function HEADER_SetBorderV() added.
• New function LISTVIEW_Clear() added.
• New function LISTVIEW_GetGridColor() added.
• New function LISTVIEW_SetGridColor() added.
Chapter Anti-aliasing updated.
• New function GUI_AA_SetBufferSize() added.
6.22 0 211116 FO
Chapter Colors updated.
• New color conversion GUICC_8888I added.
Chapter Fonts updated.
• New function GUI_BDF_EmboldenFont() added.
• New function GUI_BDF_EmboldenFontEx() added.
• New function GUI_BDF_SetLetterSpacing() added.
• New function GUI_FT_GetMeasurementChars() added.
• New function GUI_FT_SetMeasurementChars() added.
• New function GUI_TTF_EmboldenFont() added.
• New function GUI_TTF_EmboldenFontEx() added.
• New function GUI_TTF_ObliqueFont() added.
• New function GUI_TTF_ObliqueFontEx() added.
Chapter The Window Manager (WM) updated.
• Section ’Widgets with motion support’ added.
• New function WM_DeleteWindowSecure() added.
Chapter Widgets updated.
• New function DROPDOWN_EnableMotion() added.
• DROPDOWN widget now sends DROPDOWN_NOTIFICATION_COLLAPSED
and DROPDOWN_NOTIFICATION_EXPANDED notifications to its parent.
• New function LISTVIEW_GetDefaultBkColor() added.
• New function LISTVIEW_GetDefaultFont() added.
• New function LISTVIEW_GetDefaultGridColor() added.
• New function LISTVIEW_GetDefaultScrollStepH() added.
• New function LISTVIEW_GetDefaultTextColor() added.
• New function LISTVIEW_SetDefaultScrollStepH() added.
• New function LISTVIEW_SetScrollStepH() added.
• New function LISTVIEW_GetScrollStepH() added.
• New function LISTVIEW_SetScrollPos() added.
• New function MULTIEDIT_GetDefaultAlign() added.
• New function MULTIEDIT_GetDefaultBkColor() added.
• New function MULTIEDIT_GetDefaultCursorColor() added.
• New function MULTIEDIT_GetDefaultFont() added.
• New function MULTIEDIT_GetDefaultHBorder() added.
• New function MULTIEDIT_GetDefaultTextColor() added.
• New function MULTIEDIT_SetDefaultAlign() added.
• New function MULTIEDIT_SetDefaultBkColor() added.
• New function MULTIEDIT_SetDefaultCursorColor() added.
• New function MULTIEDIT_SetDefaultFont() added.
• New function MULTIEDIT_SetDefaultHBorder() added.
• New function MULTIEDIT_SetDefaultTextColor() added.
• New function SWITCH_DisableAnimation() added.
• SWIPELIST widget now sends notifications when its overlap area has
been reached or released.
Chapter emWinView updated.
• Selection position and size can now be edited from a dialog.
6.20 0 210810 FO
Chapter Displaying Text updated.
• New function GUI_GetShowMissingCharacters() added.
Chapter 2-D Graphic Library updated.
• New function GUI_DrawArcHR() added.
• New function GUI_DrawPieHR() added.
Chapter Fonts updated.
• ’Requirements’ section added.
Chapter Movies updated.
• Bitmap-based emWin movie files added.
Chapter Widgets updated.
• New function GAUGE_GetRange() added.
• Fixed mistakes in the SPINBOX configuration options table.
• New function IMAGE_SetAlign() added.
• New function IMAGE_SetOffset() added.
• New function IMAGE_SetAlpha() added.
• New function IMAGE_SetAngle() added.
• New function IMAGE_SetScale() added.
• New function IMAGE_EnableLQ() added.
Chapter VNC server updated.
• Multiple VNC connections to the same layer are now possible.
• Section for connection with a web browser added.
emWin User Guide & Reference Manual © 2022 SEGGER Microcontroller GmbH
5
Software Revision Date By Description
Chapter Anti-aliasing updated.
• New function GUI_AA_DrawPie() added.
Chapter Bitmap Converter updated.
• Bitmap-based emWin movie files added.
Chapter Display drivers updated.
• GUIDRV_SLinEPD_SSD1673 now supports SSD1680.
• GUIDRV_SLinEPD now supports UC8451.
• GUIDRV_FlexColor now supports ST7715.
Chapter Support updated.
• Fixed typo and updated FAQ.
6.18 0 210503
JE
FO
Chapter Fonts updated.
• New function GUI_BDF_CreateFont() added.
• New function GUI_BDF_DeleteFont() added.
• New function GUI_BDF_GetFamilyName() added.
• New function GUI_BDF_GetStyleName() added.
• Function GUI_TTF_DestroyCache() renamed to GUI_FT_Destroy-
Cache().
• Function GUI_TTF_Done() renamed to GUI_FT_Done().
• Function GUI_TTF_SetCacheSize() renamed to GUI_FT_Set-
CacheSize().
• New function GUI_GetFallbackFont() added.
• New function GUI_SetFallbackFont() added.
• New function GUI_SetFuncGetFallbackFont() added.
Chapter Font Converter updated.
• New command line options added added.
Chapter Simulation updated.
• New function SIM_GUI_EnableModifierKey() added.
• New function SIM_GUI_IsModifierKeyEnabled() added.
Chapter Display drivers updated.
• GUIDRV_FlexColor supports Sitronix ST7626.
Chapter Memory Devices updated.
• New function GUI_MEMDEV_GetBitsPerPixel() added.
• New function GUI_MEMDEV_GetSelMemdev() added.
Chapter 2-D Graphic Library updated.
• New function GUI_SetAfterExitHook() added.
Chapter Animations updated.
• New function GUI_ANIM_AddItemById() added.
• New function GUI_ANIM_CreateWithId() added.
• New function GUI_ANIM_DeleteById() added.
• New function GUI_ANIM_Get() added.
• New function GUI_ANIM_StartExId() added.
• New function GUI_ANIM_StopById() added.
Chapter Configuration updated.
• New function GUI_SetFuncDrawCircle() added.
• New function GUI_SetFuncDrawLine() added.
• New function GUI_SetFuncDrawRoundedRect() added.
• New function GUI_SetFuncFillCircle() added.
• New function GUI_SetFuncFillRoundedRect() added.
• Table of currently existing ready to use hardware accelerators added.
• Structure of sub chapters changed.
Chapter Widgets (window objects) updated.
• New function LISTBOX_GetVisItemIndices() added.
• New function LISTBOX_IsItemPartiallyVisible() added.
• New function KEYBOARD_SetRadius() added.
• New function KEYBOARD_SetSpace() added.
• Parameters changed of LISTBOX_EnableMotion(), LISTVIEW_Enable-
Motion() and MULTIEDIT_EnableMotion(). Calls of previous versions are
not affected by this.
• Added support of the following keys to LISTBOX: GUI_KEY_HOME,
GUI_KEY_END, GUI_KEY_PGUP, GUI_KEY_PGDOWN
Chapter ’Viewer’ renamed to emWinView.
• emWinView tool rewritten.
• Added Selection/Measure tool.
• Keyboard input gets send to emWin application.
• Transparency is shown for multi-layer configurations.
6.16 0 201120 FO
Chapter 2-D Graphic Library updated.
• New function GUI_CreateBitmapFromStreamRLE1() added.
Chapter Widgets (window objects) updated.
• New function EDIT_GetMinMax() added.
• New function SPINBOX_GetRange() added.
• New function TEXT_GetFrameColor() added.
• New function TEXT_GetDefaultFrameColor() added.
emWin User Guide & Reference Manual © 2022 SEGGER Microcontroller GmbH
