2
Disclaimer
Specifications written in this document are believed to be accurate, but are not guaranteed to
be entirely free of error. The information in this manual is subject to change for functional or
performance improvements without notice. Please make sure your manual is the latest edition.
While the information herein is assumed to be accurate, SEGGER Microcontroller GmbH (SEG-
GER) assumes no responsibility for any errors or omissions. SEGGER makes and you receive no
warranties or conditions, express, implied, statutory or in any communication with you. SEGGER
specifically disclaims any implied warranty of merchantability or fitness for a particular purpose.
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.
© 2021 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 © 2021 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: August 11, 2021
Software Revision Date By Description
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.
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.
emWin User Guide & Reference Manual © 2021 SEGGER Microcontroller GmbH
4
Software Revision Date By Description
• 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.
• New function TEXT_SetFrameColor() added.
• New function TEXT_SetDefaultFrameColor() added.
• PROGBAR now sends WM_NOTIFICATION_VALUE_CHANGED to parent
when its value has changed.
• New keyboard layout KEYBOARD_ARA for Arabic added.
• New function MULTIEDIT_EnableMotion() added.
• New function MULTIEDIT_SetCursorColor() added.
• New function MULTIEDIT_SetInvertCursor() added.
• New function HEADER_SetColumnsResizeable() added.
• New function BUTTON_SetToggleMode() added.
• New function BUTTON_Toggle() added.
• BUTTON_REACT_ON_LEVEL is now the default way how PID events are
handled by a BUTTON.
• New function SWIPELIST_SetOverlap() added.
• New function SWIPELIST_GetOverlap() added.
• New function SWIPELIST_SetDefaultOverlap() added.
• New function SWIPELIST_GetDefaultOverlap() added.
• New function LISTVIEW_GetVisRowIndices() added.
• New function LISTVIEW_IsRowPartiallyVisible() added.
Chapter Anti-aliasing updated.
• New function GUI_AA_DrawRoundedFrame() added.
• New function GUI_AA_DrawRoundedFrameEx() added.
Chapter Memory Devices updated.
• New function GUI_MEMDEV_SerializeExBMP() added.
• Fixed color format issue in GUI_MEMDEV_PunchOutDevice() example.
Chapter AppWizard updated.
• New function APPW_SetCustCallback() added.
Chapter Bitmap Converter updated.
• Reading of C and DTA files added.
• New bitmap format RLE1 (compressed 1bpp) added.
• Added section about memory footprint.
6.14 0 200602 FO
Structure of chapters reworked.
Chapter Introduction to emWin updated.
• Added “Complete emWin system” diagram.
• Example section enhanced.
• Added information about AppWizard.
Chapter Getting Started updated.
• Prep.bat, CC.bat and Lib.bat examples updated to GCC/Cortex-M4.
Chapter Simulation updated.
• Hardkey bitmap examples updated.
Chapter Fonts updated.
• New function GUI_GetTrailingBlankRows() added.
• New function GUI_GetLeadingBlankRows() added.
emWin User Guide & Reference Manual © 2021 SEGGER Microcontroller GmbH
5
Software Revision Date By Description
Chapter The Window Manager (WM) updated.
• WM_GetUserData() now returns 0 if the given handle is NULL.
Chapter Widgets (window objects) updated.
• New KEYBOARD widget added.
• New function KEYBOARD_CreateUser() added.
• New function KEYBOARD_CreateIndirect() added.
• New function KEYBOARD_ExportLayout() added.
• New function KEYBOARD_ExportPatternFile() added.
• New function KEYBOARD_SetLayout() added.
• New function KEYBOARD_SetStreamedLayout() added.
• New function KEYBOARD_SetColor() added.
• New function KEYBOARD_SetFont() added.
• New function KEYBOARD_SetPeriod() added.
• New function EDIT_EnableAutoScroll() added.
6.12 1 200417 FO
Chapter Displaying bitmap files updated.
• Added member Progressive to struct GUI_JPEG_INFO to tell whether
or not the JPEG image is progressive.
Chapter Anti-aliasing updated.
• New function GUI_AA_FillEllipseXL() added.
6.12 0 200408 FO
Chapter 2-D Graphic Library updated.
• New function GUI_QR_CreateFramed() added.
Chapter Widgets (Window objects) updated.
• New GAUGE widget added.
• New function GAUGE_CreateIndirect() added.
• New function GAUGE_CreateUser() added.
• New function GAUGE_GetValue() added.
• New function GAUGE_SetAlign() added.
• New function GAUGE_SetBkColor() added.
• New function GAUGE_SetColor() added.
• New function GAUGE_SetOffset() added.
• New function GAUGE_SetRadius() added.
• New function GAUGE_SetRange() added.
• New function GAUGE_SetRoundedEnd() added.
• New function GAUGE_SetRoundedValue() added.
• New function GAUGE_SetValue() added.
• New function GAUGE_SetValueRange() added.
• New function GAUGE_SetWidth() added.
• New QRCODE widget added.
• New function QRCODE_CreateIndirect() added.
• New function QRCODE_CreateUser() added.
• New function QRCODE_SetEccLevel() added.
• New function QRCODE_SetNumModules() added.
• New function QRCODE_SetPixelSize() added.
• New function QRCODE_SetText() added.
• New function QRCODE_SetWiFiText() added.
6.10 4 200318 FO
Chapter AppWizard updated.
• New function APPW_GetFont() added.
Chapter Widgets (window objects) updated.
• New function RADIO_GetImage() added.
• New function LISTVIEW_GetLBorder() added.
• New function LISTVIEW_GetRBorder() added.
• New function LISTVIEW_GetTextAlign() added.
• New function LISTVIEW_RowIsDisabled() added.
• New function IMAGE_SetTiled() added.
• New function IMAGE_GetImageSize() added.
• New function GRAPH_SetGridOffY() added.
• New function CHECKBOX_GetDefaultAlign() added.
• New function CHECKBOX_SetDefaultAlign() added.
• New function CALENDAR_ShowDate() added.
• New function CALENDAR_GetWeekday() added.
Chapter Language Support updated.
• Updated section Thai language support.
• New function GUI_UC_EnableThai() added.
6.10 3 200313 FO
Chapter Displaying Text updated.
• Added parameter to GUI_GetCharFromPos() to save character index.
Chapter Fonts updated.
• New function GUI_GetStringDistXEx() added.
Chapter Movies updated.
• New function GUI_MOVIE_GetInfoH() added.
• New function GUI_MOVIE_GetNumFrames() added.
emWin User Guide & Reference Manual © 2021 SEGGER Microcontroller GmbH
