Symbols
loading...
Files
loading...

i2c_oled sample sample

i2c_oled sample is a sample project defining the following symbols:

Most used functions

Name
Location
Summary
Add a style to an object.
Mark the object as invalid to redrawn its area
Get the value of a style property. The current state of the object will be considered. Inherited properties will be inherited. If a property is not set a default value will be returned.
Set the value of property in a style. This function shouldn't be used directly by the user. Instead use `lv_style_set_()`. E.g. `lv_style_set_bg_color()`
Set local style property on an object's part and state.
Set a new text for a label. Memory will be allocated to store the text by the label.
MACROS GLOBAL FUNCTIONS
Set the size of an object.
Add an event handler function for an object. Used by the user to react on event which happens with the object. An object can have multiple event handler. They will be called in the same order as they were added.
Check the type of obj.
Get the parent of an object
Get the height of an object
Get the width of an object
Set one or more flags
Free an allocated data
Get the object originally targeted by the event. It's the same even if the event is bubbled.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Change the alignment of an object and set new coordinates. Equivalent to: lv_obj_set_align(obj, align); lv_obj_set_pos(obj, x_ofs, y_ofs);
Get the event code of an event
Create a base object (a rectangle)
MACROS GLOBAL FUNCTIONS
Get the parameter passed when the event was sent
Get the value of a property
Check if a given flag or all the given flags are set on an object.
Get the child of an object by the child's index.
Set hot the item should flow
Get the current target of the event. It's the object which event handler being called. If the event is not bubbled it's the same as "normal" target.
Get the width reduced by the left and right padding and the border width.
Allocate a memory dynamically
Get the elapsed milliseconds since start up
Create an animation
Get the height reduced by the top and bottom padding and the border width.
Initialize an animation variable. E.g.: lv_anim_t a; lv_anim_init(&a); lv_anim_set_...(&a); lv_anim_start(&a);
Get the text of a label
Get the type of an input device
Mark an area of an object as invalid. The area will be truncated to the object's area and marked for redraw.
Set the width of an object
Read from a file
Get the width of an area
Get the mapped of a number given an input and output range
Get the common parts of two areas
Update the layout of an object.
Used by the widgets internally to call the ancestor widget types's event handler
Sets the width or height (on main axis) to grow the object in order fill the free space
Return the width of the area on the left the object. That is the number of pixels the object can be scrolled down. Normally positive but can be negative when scrolled inside.
Get the user_data passed when the event was registered on the object
TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Add one or more states to the object. The other state bits will remain unchanged. If specified in the styles, transition animation will be started from the previous state to the current.
STATIC VARIABLES GLOBAL VARIABLES MACROS GLOBAL FUNCTIONS
Get the elapsed milliseconds since a previous time stamp
Set a new formatted text for a label. Memory will be allocated to store the text by the label.
Get the group of the object
Copy the coordinates of an object to an area
Align an object to an other object.
Return the height of the area above the object. That is the number of pixels the object can be scrolled down. Normally positive but can be negative when scrolled inside.
Mark the object for layout update.
Get current X scroll position.
Get current Y scroll position.
Get the next input device.
Return with head node of the linked list
Get the height of an area
Clear one or more flags
Initialize a label draw descriptor from an object's styles in its current state
Send a 'LV_EVENT_REFR_EXT_DRAW_SIZE' Call the ancestor's event handler to the object to refresh the value of the extended draw size. The result will be saved in `obj`.
Set the height of an object
MACROS GLOBAL FUNCTIONS
Return with area of an area (x * y)
Get the width of a glyph with kerning
moves the object to the given index in its parent. When used in listboxes, it can be used to sort the listbox items.
Check if a given flag or any of the flags are set on an object.
Handle if the size of the internal ("virtual") content of an object has changed.
Initialize a line draw descriptor from an object's styles in its current state
Reallocate a memory with a new size. The old content will be kept.
Release a memory buffer
Get the currently processed input device. Can be used in action functions too.
Manually set the current mode (edit or navigate).
Get the current mode (edit or navigate).
Tiny snprintf/vsnprintf implementation
Return with the pointer of the next node after 'n_act'
Scroll by a given amount of pixels
STATIC VARIABLES MACROS GLOBAL FUNCTIONS Initialize an area
Get the number of children
Get the last point of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Allocate special data for an object if not allocated yet.
Get a temporal buffer with the given size.
Set the cell of an object. The object's parent needs to have grid layout, else nothing will happen
Set how to place (where to align) the items and tracks
Create a menu page object
Create a menu cont object
Get a pseudo random number in the given range
Get the area reduced by the paddings and the border width.
Return the width of the area on the right the object. That is the number of pixels the object can be scrolled down. Normally positive but can be negative when scrolled inside.
Free the data from the parameter. It's called inside `lv_draw_mask_remove_id` and `lv_draw_mask_remove_custom` Needs to be called only in special cases when the mask is not added by `lv_draw_mask_add` and not removed by `lv_draw_mask_remove_id` or `lv_draw_mask_remove_custom`
Refresh a chart if its data line has changed
Notify an object and its children about its style is modified.
Checks if the reset_query flag has been set. If so, perform necessary global indev cleanup actions
Delete an animation of a variable with a given animator function
Get the vertical resolution of a display
Send a control character to the focuses object of a group
Get the current cursor position in character index
Set the behavior of the label with longer text then the object size
Create a new lv_timer
Check if the object is in a given state or not.
Set the value of a cell.
Scroll to a given Y coordinate on an object `y` will be limited internally to allow scrolling only on the content area.
Get the draw context which should be the first parameter of the draw functions. Namely: `LV_EVENT_DRAW_MAIN/POST`, `LV_EVENT_DRAW_MAIN/POST_BEGIN`, `LV_EVENT_DRAW_MAIN/POST_END`
Test whether the and object is positioned by a layout or not
Get the index of a child.
Remove a mask with a given ID
Get the horizontal resolution of a display
Set a new value on the bar
Insert a character to the current cursor position. To add a wide char, e.g. 'Á' use `_lv_txt_encoded_conv_wc('Á')`
Get the DPI of the display
MACROS GLOBAL FUNCTIONS
Align an area to an other
STATIC VARIABLES MACROS GLOBAL FUNCTIONS Add a draw mask. Everything drawn after it (until removing the mask) will be affected by the mask.
Return the height of the area below the object. That is the number of pixels the object can be scrolled down. Normally positive but can be negative when scrolled inside.
Calculate the current value of an animation applying linear characteristic
Check if a point is on an area
Remove the node 'node_p' from 'll_p' linked list. It does not free the memory of node.
Get the animation of a variable and its `exec_cb`.
Set the width of an area
Scroll to a given X coordinate on an object. `x` will be limited internally to allow scrolling only on the content area.
Set a new value on the arc
Initialize a draw descriptor used in events.
Check if an area is fully on an other
Allocate and add a data series to the chart
Clear the selection on the text area.
Set the y coordinate of an object
Recalculate the size of the object
Move the parent of an object. The relative coordinates will be kept.
Get the display which is being refreshed
Get the display of the object
Set the position of the 'cursor' (read write pointer) in a file
Set the height of an area
Get the currently scrolled object (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Get where to snap the children when scrolling ends horizontally
Get where to snap the children when scrolling ends vertically
Set menu page to display in main
Return with the pointer of the previous node before 'n_act'
Get the y coordinate of object.
Invalidate the area of the scrollbars
Initialize a transition descriptor.
Add a style to an object.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Set the start angle of an arc. 0 deg: right, 90 bottom, etc.
Set the end angle of an arc. 0 deg: right, 90 bottom, etc.
Get the required extra size (around the object's part) to draw shadow, outline, value etc.
Get the object in which directions can be scrolled
Remove a local style property from a part of an object with a given state.
Get the screen of an object
Clear all properties from a style and free all allocated memories.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Set the next point's Y value according to the update mode policy.
Set a function to animate `var`
Get the line height of a font. All characters fit into this height
Search the most top, clickable object by a point
Set the start and end values of an animation
Add a new head to a linked list
Return with tail node of the linked list
Register a new style property for custom usage ... MY_PROP = lv_style_register_prop(); ... lv_style_set_my_prop(&style1, lv_palette_main(LV_PALETTE_RED));
Transform a point using the angle and zoom style properties of an object
Focus the next object in a group (defocus the current)
Get the focused object or NULL if there isn't one
Get the state of an object
Set the x coordinate of an object
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
Create a menu section object
Fill the canvas with color
Close an already opened file
Get the x coordinate of object.
Remove an object from its group
Get the index of letter on a relative point of a label.
Close (Collapse) the drop-down list
Get the area of the scrollbars
STATIC VARIABLES MACROS GLOBAL FUNCTIONS Initialize linked list
Calculate the current value of an animation slowing down the end phase
Get the value of an arc
Get the text of a text area. In password mode it gives the real text (not '*'s).
Assign a Text Area to the Keyboard. The pressed characters will be put there.
Get a pointer to main header obj
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
Scroll to an object until it becomes visible on its parent
Set the new extra draw size. Can be used in `LV_EVENT_REFR_EXT_DRAW_SIZE`
Open the drop.down list
Draw an arc. (Can draw pie too with great thickness.)
Remove one or more states to the object. The other state bits will remain unchanged. If specified in the styles, transition animation will be started from the previous state to the current.
Set the display which is being refreshed. It shouldn't be used directly by the user. It can be used to trick the drawing functions about there is an active display.
Scroll by a given amount of pixels. `dx` and `dy` will be limited internally to allow scrolling only on the content area.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Get the primary color of the theme
Notify all object if a style is modified
Get the key passed as parameter to an event. Can be used in `LV_EVENT_KEY`
Add animation to the animation timeline.
MACROS GLOBAL FUNCTIONS
Initialize a line mask from two points.
Give the length of a text with a given font
Get the area of a rectangle if its rotated and scaled
Set a new map. Buttons will be created/deleted according to the map. The button matrix keeps a reference to the map and so the string array must not be deallocated during the life of the matrix.
Focus the previous object in a group (defocus the current)
Calculate the integer exponents.
Get the relative x and y coordinates of a letter
Enable or disable automatic style refreshing when a new style is added/removed to/from an object or any other style change happens.
Focus on an object (defocus the current)
Transform an area using the angle and zoom style properties of an object
Configure the text area to one line or back to normal
Calculate a value of a Cubic Bezier function.
Set the options in a drop-down list from a string. The options will be copied and saved in the object so the `options` can be destroyed after calling this function
Get information about an image. Try the created image decoder one by one. Once one is able to get info that info will be used.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Get the descriptor of a glyph
Select next higher digit for edition
Tells whether the list is opened or not
Set the object in which directions can be scrolled
Set a new type for a chart
Set the minimal and maximal y values on an axis
Scroll to a given coordinate on an object. `x` and `y` will be limited internally to allow scrolling only on the content area.
Pause/resume a timer.
Set the options in a drop-down list from a static string (global, static or dynamically allocated). Only the pointer of the option string will be saved.
MACROS GLOBAL FUNCTIONS
Initialize an arc draw descriptor from an object's styles in its current state
Set where to snap the children when scrolling ends horizontally
Set where to snap the children when scrolling ends vertically
Select next lower digit for edition
Remove a property from a style
Give a pointer to a driver from its letter
Get the label of a text area
Move the cursor one character left
Get the width occupied by the "parts" of the widget. E.g. the width of all columns of a table.
Calculate the current value of an animation with overshoot at the end
Create a span string descriptor and add to spangroup.
Set the number of points on a data line on a chart
Get the array of y values of a series
MACROS GLOBAL FUNCTIONS Create a Keyboard object
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
GLOBAL PROTOTYPES Create a menu object
Create a menu separator object
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
Set the text of a check box. `txt` will be copied and may be deallocated after this function returns.
Get the pixel size of a color format in bits
Check if an area is fully out of an other
Get the index of the lastly "activated" button by the user (pressed, released, focused etc) Useful in the `event_cb` to get the text of the button, check if hidden etc.
Used internally for color filtering
Get the input device passed as parameter to indev related events.
Set the start and end angles of the arc background
Set minimum and the maximum values of a bar
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Checked if the content is scrolled "in" and adjusts it to a normal position.
Get the time used to play the animation timeline.
Increment spinbox value by one step
Decrement spinbox value by one step
Set the brightness of a LED object
update the mode of the spangroup.
Get the movement vector of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Get the index of the selected option
Insert a text to the current cursor position
Set the rotation for the whole arc
Remove and free all elements from a linked list. The list remain valid but become empty.
Set the attributes of a button of the button matrix
Calculate the time of an animation with a given speed and the start and end values
Redrawn on object an all its children using the passed draw context
Set the size of an extended clickable area
Reset one or all input devices
MACROS GLOBAL FUNCTIONS
Set an arrow or other symbol to display when on drop-down list's button. Typically a down caret or arrow.
Set the duration of an animation
Get the default value of a property
Get a pointer to menu page that is currently displayed in sidebar
Get the value of a bar
Get the options of a drop-down list
Get the current selected option as a string
Set the options on a roller
Set the text of a text area
Scroll to an object until it becomes visible on its parent. Do the same on the parent's parent, and so on. Therefore the object will be scrolled into view even it has nested scrollable parents
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Check if there is any added draw mask
Get the next line of text. Check line length and break chars too.
Set the alpha value of a pixel of an image. The color won't be affected
Set the image data to display on the object
Get the image of the canvas as a pointer to an `lv_img_dsc_t` variable.
Get the extended draw area of an object.
Enable or disable the whole lv_timer handling
Get the number of object in the group
Calculate the current value of an animation applying step characteristic. (Set end value on the end of the animation)
Return with the extension of the filename
get the text content height with width fixed.
Iterate through the timers
Insert a text to a label. The label text can not be static.
Get the X and Y coordinates where the scrolling will end for this object if a scrolling animation is in progress. If no scrolling animation, give the current `x` or `y` scroll position.
Check the current scroll direction of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)
Apply the active theme on an object
GLOBAL PROTOTYPES MACROS GLOBAL FUNCTIONS Used as `get_glyph_bitmap` callback in LittelvGL's native font format if the font is uncompressed.
Used as `get_glyph_dsc` callback in LittelvGL's native font format if the font is uncompressed.
Set the start and end angles
Get the type of bar.
Get the one line configuration attribute
Get a list of accepted characters.
Get max length of a Text Area.
Move the cursor one character right
Add an object to a group
Get the height occupied by the "parts" of the widget. E.g. the height of all rows of a table.
Tell whether an area of an object is visible (even partially) now or not
Get the an area where to object can be clicked. It's the object's normal area plus the extended click area.
Get the current scroll mode (when to hide the scrollbars)
Do nothing until the next release
MACROS GLOBAL FUNCTIONS Create a led object
Set a static text. It will not be saved by the span so the 'text' variable has to be 'alive' while the span exist.
Set menu page to display in sidebar
Set the direction of the a drop-down list
Delete all children of an object. Also remove the objects from their group and remove all animations (if any). Send `LV_EVENT_DELETED` to deleted objects.
Get the type of an image source
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS Get the color of an image's pixel
Get the alpha value of an image's pixel
Set the color of a pixel of an image. The alpha channel won't be affected.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS Return with a pointer to the active screen
Calculate the atan2 of a vector.
Get a gradient cache from the given parameters
Clean up the gradient item after it was get with `lv_grad_get_from_cache`.
Calculate the current value of an animation applying an "S" characteristic (cosine)
Light on a LED
Light off a LED
Make a lv_timer ready. It will not wait its period.
Get the position of a point to the chart.
Set a new start value on the bar
Set the type of bar.
Predict where would a scroll throw end
Set a layout for an object
Set a variable to animate
Get an area the should be invalidated when the arcs angle changed between start_angle and end_ange
GLOBAL FUNCTIONS Initialize the dyn_mem module (work memory and other variables)
Convert a 32-bit RGB color to HSV
Remove an event handler function for an object.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Return with the sys. layer. (Same on every screen and it is above the normal screen and the top layer)
Temporarily enable and disable the invalidation of the display.
MACROS GLOBAL FUNCTIONS
Set a static text. It will not be saved by the label so the 'text' variable has to be 'alive' while the label exists.
Give information about the work memory of dynamic allocation
Set the progress of the animation timeline.
Write into a file
MACROS GLOBAL FUNCTIONS Create a spinner object
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
Set a new text for a span. Memory will be allocated to store the text by the span.
Get the data point number per data line on chart
Get the current index of the x-axis start point in the data array
Set the next point's X and Y value according to the update mode policy.
Get the index of the currently pressed point. It's the same for every series.
Set a new a mode (text or number map)
Set an array of points. The line object will connect these points.
MACROS GLOBAL FUNCTIONS
Get whether a cell has the control bits
Get the subtitle font of the theme
MACROS GLOBAL FUNCTIONS Create a roller object
Set the height to show the given number of rows (options)
Get the id of the selected option
Set the placeholder text of a text area
Get the actually set y coordinate of object, i.e. the offset form the set alignment
GLOBAL PROTOTYPES Initialize LVGL library. Should be called before any other LVGL related function.
Clamp a width between min and max width. If the min/max width is in percentage value use the ref_width
Clamp a height between min and max height. If the min/max height is in percentage value use the ref_height
Get a pointer to an `lv_point_t` variable in which the self size should be saved (width in `point->x` and height `point->y`). Can be used in `LV_EVENT_GET_SELF_SIZE`
Clean up the memory buffer which frees all the allocated memories.
Manually refresh the state of the animations. Useful to make the animations running in a blocking process where `lv_timer_handler` can't run for a while. Shouldn't be used directly because it is called in `lv_refr_now()`.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Get the time used to play the animation.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES GLOBAL PROTOTYPES MACROS GLOBAL FUNCTIONS Return with the bitmap of a font.
get the text content width when all span of spangroup on a line.
Get the brightness of a LEd object
Set the number of times a timer will repeat.
Checks if a style is empty (has no properties)
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Default keyboard event to add characters to the Text area and change the map. If a custom `event_cb` is added to the keyboard this function can be called from it to handle the button clicks
Get a pointer to menu page that is currently displayed in main
Check if a character is drawn under a point.
Set a destination group for a keypad input device (for LV_INDEV_TYPE_KEYPAD)
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Set the start angle of an arc background. 0 deg: right, 90 bottom, etc.
Set the start angle of an arc background. 0 deg: right, 90 bottom etc.
Get the start value of a bar
Get the minimum value of a bar
Get the maximum value of a bar
Enable/Disable the positioning of the cursor by clicking the text on the text area.
Get the replacement characters to show in password mode
Move the cursor one line down
Move the cursor one line up
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Swap 2 object in a group. The object must be in the same group
Handle the gesture of indev_proc_p->types.pointer.act_obj
Get the distance of the nearest snap point
Set the height reduced by the top and bottom padding and the border width.
Get the y2 coordinate of object.
Hit-test an object given a particular point in screen space.
Tell whether an object is visible (even partially) now or not
Iterate through all children of any object.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
remove the least recently used item @todo we can optimise this by finding the n lru items, where n = required_space / average_length
STATIC FUNCTIONS Set the previous node pointer of a node
Set the 'next node pointer' of a node
Set the current hsv of a color wheel.
Delete a lv_timer
Insert a string into an other
Set the number of columns
Return with the top layer. (Same on every screen and it is above the normal screen layer)
Delete a the left character from the current cursor position
Set a default group. New object are added to this group if it's enabled in their class with `add_to_def_group = true`
Calculate the current value of an animation slowing down the start phase
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Start the animation timeline.
Cancel an asynchronous function call
Set the playback direction of the animation timeline.
MACROS GLOBAL FUNCTIONS
Set spinbox digit format (digit count and decimal format)
MACROS GLOBAL FUNCTIONS
Set the color of the LED
Set the mode of the spangroup.
MACROS GLOBAL FUNCTIONS
Set the align of the spangroup.
Set the overflow of the spangroup.
Set the indent of the spangroup.
Set the callback the timer (the function to call periodically)
Set update mode of the chart object. Affects
Set the number of horizontal and vertical division lines
Add a cursor with a given color
Set the coordinate of the cursor with respect to the origin of series area of the chart.
Remove the provided input device. Make sure not to use the provided input device afterwards anymore.
Set an individual point's x and y value of a chart's series directly based on its index Can be used only with `LV_CHART_TYPE_SCATTER`.
Get the array of x values of a series
Set a new map for the keyboard
Set the value of a cell. Memory will be allocated to store the text by the table.
Add control bits to the cell.
Clear control bits of the cell.
Get the selected cell (pressed and or focused)
Set a base theme for a theme. The styles from the base them will be added before the styles of the current theme. Arbitrary long chain of themes can be created by setting base themes.
Set a callback for a theme. The callback is used to add styles to different objects
Rotate an object to the current position of the arc (knob)
Get the text of a check box
Set text of the drop-down list's button. If set to `NULL` the selected option's text will be displayed on the button. If set to a specific text then that text will be shown regardless of the selected option.
Clear all options in a drop-down list. Works with both static and dynamic options.
Set whether the selected option in the list should be highlighted or not
Get the current selected option as a string
Set a list of characters. Only these characters will be accepted by the text area
Set max length of a Text Area.
Set a buffer for the canvas.
MACROS GLOBAL FUNCTIONS
Set the image animation images source.
Startup the image animation.
Set the image animation duration time. unit:ms
Set the image animation reapeatly play times.
MACROS GLOBAL FUNCTIONS
Remove an event handler function with a specific user_data from an object.
Change the alignment of an object.
Get the actually set x coordinate of object, i.e. the offset form the set alignment
Check the children of `obj` and scroll `obj` to fulfill the scroll_snap settings
Swap the positions of two objects. When used in listboxes, it can be used to sort the listbox items.
Check next character in a string and decide if the character is part of the command or not
Decode two encoded character from a string.
Set the number of rows
Invalidate an area on display to redraw it
Return the length of the linked list.
MACROS GLOBAL FUNCTIONS
Clear the attributes of all buttons of a button matrix
Get the whether a control value is enabled or disabled for button of a button matrix
Initialize an image draw descriptor from an object's styles in its current state
Low level function to scroll by given x and y coordinates. `LV_EVENT_SCROLL` is sent.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS Searches base[0] to base[n - 1] for an item that matches *key.
Reset the long press state of an input device
Convert a HSV color to RGB
Refresh the label with its text stored in its extended data
Deinit the 'lv' library Currently only implemented when not using custom allocators, or GC is enabled.
Set a function call when the animation is ready
Find an indev preferably with KEYPAD or ENCOEDR type that uses the given group. In other words, find an indev, that is related to the given group. In the worst case simply return the latest indev
Search for snap point in the `min` - `max` range.
Search for snap point in the `min` - `max` range.
MACROS GLOBAL FUNCTIONS Initialize a display driver with default values. It is used to surly have known values in the fields ant not memory junk. After it you can set the fields.
Close the pending decoding. Free resources etc.
Invalidate an image source in the cache. Useful if the image source is updated therefore it needs to be cached again.
Check if a color format has alpha channel or not
Delete a part of a string
Get the internal buffer of a display
Get the memory consumption of a raw bitmap, given color format and dimensions.
Gets a pointer to the currently active object in the currently processed input device.
Called periodically to handle the refreshing
Check if a linked list is empty
Set attributes of all buttons of a button matrix
DEFINES TYPEDEFS STATIC PROTOTYPES GLOBAL PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Get the last element of a path (e.g. U:/folder/file -> file)
Get the old area of the object before its size was changed. Can be used in `LV_EVENT_SIZE_CHANGED`
Get the animation descriptor of a scrolling. Can be used in `LV_EVENT_SCROLL_BEGIN`
Get a pointer to an `lv_hit_test_info_t` variable in which the hit test result should be saved. Can be used in `LV_EVENT_HIT_TEST`
Get a pointer to an area which should be examined whether the object fully covers it or not. Can be used in `LV_EVENT_HIT_TEST`
Set the result of cover checking. Can be used in `LV_EVENT_COVER_CHECK`
Create a new object group
Remove all objects from a group
Stop the event from bubbling. This is only valid when called in the middle of an event processing chain.
Stop processing this event. This is only valid when called in the middle of an event processing chain.
Register a new, custom event ID. It can be used the same way as e.g. `LV_EVENT_CLICKED` to send custom events
Do not let to change the focus from the current object
Set a function for a group which will be called when a new object is focused
Set a function for a group which will be called when a focus edge is reached
Set whether the next or previous item in a group is focused if the currently focused obj is deleted.
Set whether focus next/prev will allow wrapping from first->last or last->first object.
Get the focus callback function of a group
Get the edge callback function of a group
Get whether focus next/prev will allow wrapping from first->last or last->first object.
MACROS GLOBAL FUNCTIONS
Check if any object has a given class (type). It checks the ancestor classes too.
Get the class (type) of the object
Check if any object is still "alive".
Enable or disable one or all input devices (default enabled)
Set a cursor for a pointer input device (for LV_INPUT_TYPE_POINTER and LV_INPUT_TYPE_BUTTON)
Get the number of currently running animations
Calculate the current value of an animation with 3 bounces
Get global animation refresher timer.
Get whether the animation timeline is played in reverse.
Give the position of the read write pointer
Initialize a 'fs_dir_t' variable for directory reading
Read the next filename form a directory. The name of the directories will begin with '/'
Close the directory reading
Fill a buffer with the letters of existing drivers
Step up one level
Set spinbox rollover function
Set cursor position to a specific digit for edition
Set direction of digit step when clicking an encoder button while in editing mode
Get spinbox rollover function status
Get the spinbox numeral value (user has to convert to float according to its digit format)
Get the spinbox step value (user has to convert to float according to its digit format)
Get a spangroup child by its index.
get the align of the spangroup.
get the overflow of the spangroup.
get the indent of the spangroup.
get the mode of the spangroup.
Toggle the state of a LED
Create an "empty" timer. It needs to initialized with at least `lv_timer_set_cb` and `lv_timer_set_period`
Set new period for a lv_timer
Reset a lv_timer. It will be called the previously set period milliseconds later.
Convert a color to HSV
Get the number of custom properties that have been registered thus far.
Get the type of a chart
Deallocate and remove a data series from a chart
Hide/Unhide a single series of a chart.
Change the color of a series
Set the index of the x-axis start point in the data array. This point will be considers the first (left) point and the other points will be drawn after it.
Set the coordinate of the cursor with respect to the origin of series area of the chart.
Get the coordinate of the cursor with respect to the origin of series area of the chart.
Initialize all data points of a series with a value
Set an individual point's y value of a chart's series directly based on its index
Set an external array for the y data points to use for the chart NOTE: It is the users responsibility to make sure the `point_cnt` matches the external array size.
Set an external array for the x data points to use for the chart NOTE: It is the users responsibility to make sure the `point_cnt` matches the external array size.
Show the button title in a popover when pressed.
Assign a Text Area to the Keyboard. The pressed characters will be put there.
Set a new a mode (text or number map)
Set the how the header should behave and its position
Get a pointer to sidebar header obj
Get the long mode of a label
Delete characters from a label. The label text can not be static.
Enable (or disable) the y coordinate inversion. If enabled then y will be subtracted from the height of the object, therefore the y = 0 coordinate will be on the bottom.
Get the y inversion attribute
Get the value of a cell.
Set the text of a check box. `txt` must not be deallocated during the life of this checkbox.
Initialize a file system driver with default values. It is used to surly have known values in the fields ant not memory junk. After it you can set the fields.
Test if a drive is ready or not. If the `ready` function was not initialized `true` will be returned.
Set the an array of points for LV_INDEV_TYPE_BUTTON. These points will be assigned to the buttons to press a specific point on the screen
Get the current gesture direct
Get the last pressed key of an input device (for LV_INDEV_TYPE_KEYPAD)
Get a pointer to the indev read timer to modify its parameters with `lv_timer_...` functions.
Redraw the invalidated areas now. Normally the redrawing is periodically executed in `lv_timer_handler` but a long blocking process can prevent the call of `lv_timer_handler`. In this case if the GUI is updated in the process (e.g. progress bar) this function can be called when the screen should be updated.
Get the small font of the theme
Get the normal font of the theme
Get the secondary color of the theme
Set the type of arc.
Set minimum and the maximum values of an arc
Set a change rate to limit the speed how fast the arc should reach the pressed point.
Get the start angle of an arc.
Get the end angle of an arc.
Get the start angle of an arc background.
Get the end angle of an arc background.
Get the minimum value of an arc
Get the maximum value of an arc
Get whether the arc is type or not.
Align an object to the current position of the arc (knob)
Give the slider is being dragged or not
Add an options to a drop-down list from a string. Only works for non-static options.
Get the list of a drop-down to allow styling or other modifications
Get text of the drop-down list's button.
Get the symbol on the drop-down list. Typically a down caret or arrow.
Get whether the selected option in the list should be highlighted or not
Get the direction of the drop-down list
Get the options of a roller
Set the replacement characters to show in password mode
In `LV_EVENT_INSERT` the text which planned to be inserted can be replaced by an other text. It can be used to add automatic formatting to the text area.
Set how long show the password before changing it to '*'
Deprecated: use the normal text_align style property instead Set the label's alignment. It sets where the label is aligned (in one line mode it can be smaller than the text area) and how the lines of the area align in case of multiline text area
Get the placeholder text of a text area
Get whether the cursor click positioning is enabled or not.
Get the password mode attribute
Find whether text is selected or not.
Find whether selection mode is enabled.
Set how long show the password before changing it to '*'
Set the palette color of a canvas with index format. Valid only for `LV_IMG_CF_INDEXED1/2/4/8`
Get the color of a pixel on the canvas
Copy a buffer to the canvas
Get the button matrix object of the calendar. It shows the dates and day names.
Get the number of the highlighted dates
DEPRECATED because doesn't work if multiple event handlers are added to an object. Remove an event handler function for an object.
Set the width reduced by the left and right padding and the border width.
Get the x2 coordinate of object.
Tell whether an object is being scrolled or not at this moment
Fade in an an object and all its children.
Fade out an an object and all its children.
GLOBAL PROTOTYPES
Set a delay before starting the animation
Get the theme of a display
Set the path (curve) of the animation.
Convert a percentage value to `lv_coord_t`. Percentage values are stored in special range
Make the refreshing from an object. Draw all its children and the youngers too.
STATIC FUNCTIONS Convert a hexadecimal characters to a number (0..15)
Refresh the position of the roller. It uses the id stored in: roller->ddlist.selected_option_id
Remove all mask with a given custom ID
Initialize a line mask from a point and an angle.
Tell the group of a property. If the a property from a group is set in a style the (1 has_group is set. It allows early skipping the style if the property is not exists in the style at all.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS Get the buffer needed for object snapshot image.
Set a default display. The new screens will be created on it by default.
Get the full / physical horizontal resolution of a display
Get the full / physical vertical resolution of a display
Get display invalidation is enabled.
Add a new tail to a linked list
Set the button control map (hidden, disabled etc.) for a button matrix. The control map array will be copied and so may be deallocated after this function returns.
Handle throwing after scrolling. Called by LVGL during input device processing
Helper function for asynchronously deleting objects. Useful for cases where you can't delete an object directly in an `LV_EVENT_DELETE` handler (i.e. parent).
Make the animation repeat itself.
@endcond Get the brightness of a color
Update the control map for the current mode
Hide all characters (convert them to '*')
Check if the style property has a specified behavioral flag. Do not pass multiple flags to this function as backwards-compatibility is not guaranteed for that.
Test if char is break char or not (a text can broken here or not)
Get the active screen of the default display
Used internally to update arc angles after a value change
Initialize a display buffer
Register an initialized display driver. Automatically set the first display as active.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS Initialize the image decoder module
Open an image. Try the created image decoders one by one. Once one is able to open the image that decoder is saved in `dsc`
Read a line from an opened image
Set a callback to get information about the image
Set a callback to open an image
Set a callback to a decoded line of an image
Set a callback to close a decoding session. E.g. close files and free other resources.
Decode `len` pixels starting from the given `x`, `y` coordinates and store them in `buf`. Required only if the "open" function can't return with the whole decoded pixel array.
MACROS GLOBAL FUNCTIONS Open an image using the image decoder interface and cache it. The image will be left open meaning if the image decoder open callback allocated memory then it will remain. The image is closed if a new image is opened and the new image takes its place in the cache.
Check if a color format is chroma keyed or not
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
Adjust the layer_ctx and/or draw_ctx based on the `layer_ctx->area_act`. It's called only if flags has `LV_DRAW_LAYER_FLAG_CAN_SUBDIVIDE`
Blend a rendered layer to `layer_ctx->area_act`
Called by LVGL the rendering of a screen is ready to clean up the temporal (cache) data of the masks
Free all memory buffers
Stop the animation timeline.
Join two areas into a third which involves the other two
Check if two area has common parts
Get the current selected color of a color wheel.
get max line height of all span in the spangroup.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
GLOBAL FUNCTIONS Init the lv_timer module
return a new formatted text. Memory will be allocated to store the text.
Set a special meta state for a property in a style. This function shouldn't be used directly by the user.
Get the flags of a built-in or custom property.
Take snapshot for object with its children, save image info to provided buffer.
Read data from an input device.
Check if an obj is a root back btn
Set where text selection should start
Set where text selection should end
A function to be easily used in animation ready callback to delete an object when the animation is ready
MACROS GLOBAL FUNCTIONS
Update the driver in run time.
Set the palette color of an indexed image. Valid only for `LV_IMG_CF_INDEXED1/2/4/8`
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
GLOBAL FUNCTIONS Initialize the screen refresh subsystem
Return with a pointer to the previous screen. Only used during screen transitions.
Make a screen active
Switch screen with animation
Frees the memory allocated by the `lv_font_load()` function
Clear the attributes of a button of the button matrix
Make the button matrix like a selector widget (only one button may be checked at a time). `LV_BTNMATRIX_CTRL_CHECKABLE` must be enabled on the buttons to be selected using `lv_btnmatrix_set_ctrl()` or `lv_btnmatrix_set_btn_ctrl_all()`.
Get the current map of a button matrix
Delete the right character from the current cursor position
Set the color of a pixel on the canvas
Nested events can be called and one of them might belong to an object that is being deleted. Mark this object's `event_temp_data` deleted to know that its `lv_event_send` should return `LV_RES_INV`
MACROS GLOBAL FUNCTIONS
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Used internally to create a style transition
Used internally to compare the appearance of an object in 2 states
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES GLOBAL VARIABLES MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS
MACROS GLOBAL FUNCTIONS Draw a letter in the Virtual Display Buffer
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS Draw a polygon. Only convex polygons are supported
Remove all styles from an object
Process the released state of LV_INDEV_TYPE_POINTER input devices
Process a new point from LV_INDEV_TYPE_BUTTON input device
Remove the transition from object's part's property. - Remove the transition from `_lv_obj_style_trans_ll` and free it - Delete pending transitions
Search the most top object which fully covers an area
Based on the idea from https://www.vagrearg.org/content/hsvrgb Here we want to compute an approximate RGB value from a HSV input color space. We don't want to be accurate (for that, there's lv_color_hsv_to_rgb), but we want to be fast. Few tricks are used here: Hue is in range [0; 6 * 256] (so that the sextant is in the high byte and the fractional part is in the low byte) both s and v are in [0; 255] range (very convenient to avoid divisions). We fold all symmetry by swapping the R, G, B pointers so that the code is the same for all sextants. We replace division by 255 by a division by 256, a.k.a a shift right by 8 bits. This is wrong, but since this is only used to compute the pixels on the screen and not the final color, it's ok.
If `src` is not defined for the current state try to get a state which is related to the current but has `src`. E.g. if the PRESSED src is not set but the RELEASED does, use the RELEASED.
Update the key and control map for the current mode
compare a key against an existing item's key
STATIC FUNCTIONS
Set the position of list when it is closed to show the selected item
Free the dot_tmp_ptr field if it was previously allocated. Always clears the field
Set the middle page for the roller if infinite is enabled
Set the rotation of this display.
Enable the recoloring by in-line commands
Make the animation to play back to when the forward direction is ready
MACROS For compatibility if LV_USE_BIDI = 0 Get the real text alignment from the a text alignment, base direction and a text.
Get the mode of the slider.
DEFINES TYPEDEFS STATIC PROTOTYPES
Process the pressed state of LV_INDEV_TYPE_POINTER input devices
Set the state (fully overwrite) of an object. If specified in the styles, transition animations will be started from the previous state to the current.
STATIC FUNCTIONS Get the local style of an object for a given part and for a given state. If the local style for the part-state pair doesn't exist allocate and return it.
Get the transition style of an object for a given part and for a given state. If the transition style for the part-state pair doesn't exist allocate and return it.
Refresh the style of all children of an object. (Called recursively)
Recursively refresh the style of the children. Go deeper until a not NULL style is found because the NULL styles are inherited from the parent
Flush the content of the draw buffer
STATIC FUNCTIONS
Test the circle drawing is ready or not
STATIC PROTOTYPES Transform a point with 1/256 precision (the output coordinates are upscaled by 256)
Find the last item of a track
Tell a start coordinate and gap for a placement type.
Place the grid track according to align methods. It keeps the track sizes but sets their position. It can process both columns or rows according to the passed parameters.
Get the number of days in a month
Get the day of the week
Code Comparator. Compares the value of both input arguments.
STATIC FUNCTIONS Periodically handle the animations.
STATIC FUNCTIONS Skip the driver letter and the possible : after the letter
remove an item and push it to the free items queue
DEFINES TYPEDEFS STATIC PROTOTYPES
Find out how much time remains before a timer must be run.
Get the width of a button in units (default is 1).
Gives the button id of a button under a given point
Enforces a single button being toggled on the button matrix. It simply clears the toggle flag on other buttons.
Called to blink the cursor
Set the number of images to be cached. More cached images mean more opened image at same time which might mean more memory usage. E.g. if 20 PNG or JPG images are open in the RAM they consume memory while opened in the cache.
Delete a group object
The user data of an event object event callback. Always the first match with `event_cb` will be returned.
Get the part draw descriptor passed as parameter to `LV_EVENT_DRAW_PART_BEGIN/END`.
Allocate an image buffer in RAM
Delete all the animations
Set the position of an area (width and height will be kept)
Check if 2 area is the same
MACROS GLOBAL FUNCTIONS
Add a new scale to the meter.
Set the properties of the ticks of a scale
Make some "normal" ticks major ticks and set their attributes. Texts with the current value are also added to the major ticks.
Set the value and angular range of a scale.
Add a needle line indicator the scale
Add a needle image indicator the scale
Add an arc indicator the scale
Add a scale line indicator the scale. It will modify the ticks.
Set the value of the indicator. It will set start and and value to the same value
Set the start value of the indicator.
Set the start value of the indicator.
MACROS GLOBAL FUNCTIONS Create a color_picker object
Set the current color of a color wheel.
Set the current color mode.
Set if the color mode is changed on long press on center
Get the current selected hsv of a color wheel.
Get if the color mode is changed on long press on center
Set lines of the spangroup.
get lines of the spangroup.
MACROS GLOBAL FUNCTIONS Create an image button object
Set images for a state of the image button
Use this function instead of `lv_obj_add/clear_state` to set a state manually
Get the left image in a given state
Get the middle image in a given state
Get the right image in a given state
Remove the span from the spangroup and free memory.
Take snapshot for object with its children, alloc the memory needed.
Free the snapshot image returned by lv_snapshot_take It will firstly free the data image takes, then the image descriptor.
Zoom into the chart in X direction
Zoom into the chart in Y direction
Set the number of tick lines on an axis
Tell whether "popovers" mode is enabled or not.
Set whether back button should appear at root
Get a pointer to main header back btn obj
Get a pointer to sidebar header obj
Get the index of the selected button
Get the recoloring attribute
Set the width of a column
Get the number of rows.
Get the number of columns.
Get the width of a column
Get the horizontal offset from the full / physical display
Get the vertical offset from the full / physical display
Get if anti-aliasing is enabled for a display or not
Get the current rotation of this display.
Free an allocated image buffer
Set the theme of a display
Set the background color of a display
Set the background image of a display
Set opacity of the background
Get elapsed time since last user activity on a display (e.g. click)
Manually trigger an activity on a display
Clean any CPU cache that is related to the display.
Get a pointer to the screen refresher timer to modify its parameters with `lv_timer_...` functions.
MACROS GLOBAL FUNCTIONS Loads a `lv_font_t` object from a binary font file
Insert a new node in front of the n_act node
Move a node to a new linked list
Move a node before an other node in the same linked list
Set an offset for the source of an image so the image will be displayed from the new origin.
Set an offset for the source of an image. so the image will be displayed from the new origin.
Set the rotation angle of the image. The image will be rotated around the set pivot set by `lv_img_set_pivot()` Note that indexed and alpha only images can't be transformed.
Set the rotation center of the image. The image will be rotated around this point.
Set the zoom factor of the image. Note that indexed and alpha only images can't be transformed.
Enable/disable anti-aliasing for the transformations (rotate, zoom) or not. The quality is better with anti-aliasing looks better but slower.
Set the image object size mode.
Get the source of the image
Get the offset's x attribute of the image object.
Get the offset's y attribute of the image object.
Get the rotation angle of the image.
Get the pivot (rotation center) of the image.
Get the zoom factor of the image.
Get whether the transformations (rotate, zoom) are anti-aliased or not
Get the size mode of the image
Set a single button's relative width. This method will cause the matrix be regenerated and is a relatively expensive operation. It is recommended that initial width be specified using `lv_btnmatrix_set_ctrl_map` and this method only be used for dynamic changes.
Tell whether "one check" mode is enabled or not.
Get the total number of options
Get the total number of options
Set the opacity of a pixel on the canvas
Transform and image and store the result on a canvas.
Apply horizontal blur on the canvas
Apply vertical blur on the canvas
Draw a rectangle on the canvas
Draw a text on the canvas.
Draw an image on the canvas
Draw a line on the canvas
Draw a polygon on the canvas
Draw an arc on the canvas
Check the type obj a part draw descriptor
Delete an object after some delay
Update the driver in run time.
GLOBAL FUNCTIONS Initialize an input device driver with default values. It is used to surly have known values in the fields ant not memory junk. After it you can set the fields.
Register an initialized input device driver.
Initialize LVGL portation
Add display handling to LVGL
Set a function call when the animation really starts (considering `delay`)
Make the animation to play back to when the forward direction is ready
Get the value of a property
Deinitialize LVGL portation
Set a new value on the slider
Set a new value for the left knob of a slider
Get the value of the main knob of a slider
Get the value of the left knob of a slider
STATIC FUNCTIONS Process a new point from LV_INDEV_TYPE_POINTER input device
Process a new point from LV_INDEV_TYPE_KEYPAD input device
Process new points from an input device. indev->state.pressed has to be set
Process a new point from LV_INDEV_TYPE_ENCODER input device
Handle focus/defocus on click for POINTER input devices
Initialize the draw descriptor for the scrollbar
Refresh the joined areas
STATIC FUNCTIONS Join the areas which has got common parts
Refresh an area if there is Virtual Display Buffer
Helper function for draw_buf_rotate_90_sqr. Given a list of four numbers, rotate the entire list to the left.
Initialize the circle drawing
Get the next point from the circle
Position the children in the same track
STATIC FUNCTIONS
STATIC FUNCTIONS
Calculate the grid cells coordinates
Free the a grid calculation's data
Reposition a grid item in its cell
TYPEDEFS STATIC PROTOTYPES
Tells whether a year is leap year or not
Get the nearest index to an X coordinate
Called when an animation is ready to do the necessary thinks e.g. repeat, play back, delete etc.
pop an existing item off the free queue, or create a new one
STATIC FUNCTIONS
STATIC FUNCTIONS Execute timer if its remaining time is zero
UTF-8 ENCODER/DECODER Give the size of an UTF-8 coded character
Convert a Unicode letter to UTF-8.
Get previous UTF-8 character form a string.
Convert a character index (in an UTF-8 text) to byte index. E.g. in "AÁRT" index of 'R' is 2th char but start at byte 3 because 'Á' is 2 bytes long
Convert a byte index (in an UTF-8 text) to character index. E.g. in "AÁRT" index of 'R' is 2th char but start at byte 3 because 'Á' is 2 bytes long
Convert a wide character, e.g. 'Á' little endian to be UTF-8 compatible
Decode an UTF-8 character from a string.
Get the number of characters (and NOT bytes) in a string. Decode it with UTF-8 if enabled. E.g.: "ÁBC" is 3 characters (but 4 bytes)
Create the required number of buttons and control bytes according to a map
Check if any of the buttons in the first row has the LV_BTNMATRIX_CTRL_POPOVER control flag set.
Called when a drop down list is released to open it or set new option
Store `len` characters from `data`. Allocates space if necessary.
Get the stored dot_tmp characters
Resets the switch's animation state to "no animation in progress".
Starts an animation for the switch knob. if the anim_time style property is greater than 0
Dummy function to animate char hiding in pwd mode. Does nothing, but a function is required in car hiding anim. (pwd_char_hider callback do the real job)
Call when an animation is ready to convert all characters to '*'
Test a unicode character if it is accepted or not. Checks max length and accepted char list.
Create LCD panel for model SH1107
Set a delay before repeating the animation.
Set a whether the animation's should be applied immediately or only when the delay expired.
GLOBAL PROTOTYPES
Get the top layer of the default display
Remove display handling from LVGL
Notify LVGL, that data was flushed to LCD display
DEFINES TYPEDEFS GLOBAL PROTOTYPES Initialize the theme
Rotate a square image 90/270 degrees in place.
Rotate the draw_buf to the display's native orientation.
MACROS STATIC FUNCTIONS
Get the next word of text. A word is delimited by break characters. If the word cannot fit in the max_width space, obey LV_TXT_LINE_BREAK_LONG_* rules. If the next word cannot fit anything, return 0. If the first character is a break character, returns the next index. Example calls from lv_txt_get_next_line() assuming sufficient max_width and txt = "Test text\n" 0123456789 Calls would be as follows: 1. Return i=4, pointing at breakchar ' ', for the string "Test" 2. Return i=5, since i=4 was a breakchar. 3. Return i=9, pointing at breakchar '\n' 4. Parenting lv_txt_get_next_line() would detect subsequent '\0' TODO: Returned word_w_ptr may overestimate the returned word's width when max_width is reached. In current usage, this has no impact.
STATIC VARIABLES MACROS GLOBAL FUNCTIONS
Align an object to the center on its parent.
Set the user_data field of the object
Get the user_data field of the object
Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the `obj`'s display. It ensures that e.g. `lv_dpx(100)` will have the same physical size regardless to the DPI of the display.
Similar to `lv_anim_set_exec_cb` but `lv_anim_custom_exec_cb_t` receives `lv_anim_t * ` as its first parameter instead of `void *`. This function might be used when LVGL is bound to other languages because it's more consistent to have `lv_anim_t *` as first parameter. The variable to animate can be stored in the animation's `user_data`
Set a function to use the current value of the variable and make start and end value relative to the returned current value.
Set a function call when the animation is deleted.
Set the custom user data field of the animation.
Get a delay before starting the animation
Get the user_data field of the animation
Delete an animation by getting the animated variable from `a`. Only animations with `exec_cb` will be deleted. This function exists because it's logical that all anim. functions receives an `lv_anim_t` as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings.
Get the animation of a variable and its `exec_cb`. This function exists because it's logical that all anim. functions receives an `lv_anim_t` as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings.
Just a wrapper around LV_FONT_DEFAULT because it might be more convenient to use a function in some cases
Wrapper functions for VERSION macros
@endcond Call it in the super-loop of main() or threads. It will run lv_timer_handler() with a given period in ms. You can use it with sleep or delay in OS environment. This function is used to simplify the porting.
Just a wrapper around LV_COLOR_CHROMA_KEY because it might be more convenient to use a function in some cases
Just a wrapper to `LV_GRID_FR` for bindings.
Get the current map of a keyboard
Get the index of the lastly "activated" button by the user (pressed, released, focused etc) Useful in the `event_cb` to get the text of the button, check if hidden etc.
Get the active screen of the default display
Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the default display. It ensures that e.g. `lv_dpx(100)` will have the same physical size regardless to the DPI of the display.
Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the given display. It ensures that e.g. `lv_dpx(100)` will have the same physical size regardless to the DPI of the display.
Set minimum and the maximum values of a bar
Set the mode of slider.
Get the minimum value of a slider
Get the maximum value of a slider
DEPRECATED: added only for backward compatibility
TYPEDEFS GLOBAL PROTOTYPES
MACROS INLINE FUNCTIONS Move the object to the foreground. It will look like if it was created as the last child of its parent. It also means it can cover any of the siblings.
Move the object to the background. It will look like if it was created as the first child of its parent. It also means any of the siblings can cover the object.

Other commonly used symbols

Name
Location
Summary
Represents an area of the screen.
A common type to handle all the property types in the same way.
Descriptor of a style (a collection of properties and values).
TYPEDEFS Represents a point on the screen.
@cond Doxygen_Suppress
Number integer number (opacity, enums, booleans or "normal" numbers)
GLOBAL PROTOTYPES MACROS
Width of the glyph's bounding box
Height of the glyph's bounding box
Draw the next glyph after this width. 8.4 format (real_value * 16 is stored).
x offset of the bounding box
y offset of the bounding box. Measured from the top of the line
Start index of the bitmap. A font can be max 1 MB.
DEFINES TYPEDEFS
Description of a linked list
Descriptor a chart series
A background like rectangle
The result of the previous mask operation
The current clip area with absolute coordinates, always the same or smaller than `buf_area`
A header describing the basics of the image
A timer which periodically checks the dirty areas and refreshes them
Special events The object's value has changed (i.e. slider moved)
>> LV_TRIGO_SHIFT to normalize
DEFINES TYPEDEFS Dummy type to make handling easier
DEFINES TYPEDEFS Represents a date on the calendar object (platform-agnostic).
Constant pointers (font, cone text, etc)
A gradient stop array
Image header it is compatible with the result from image converter utility
The dropped down list
Make the base object's class publicly available.
Point number in a data line
Options in a '\n' separated list
Called on release if not scrolled (regardless to long press)
NULL if ignored, or an alpha mask to apply on `blend_area`
STATIC VARIABLES
A descriptor of a gradient.
Descriptor for style transitions
Save the indicator area. Might be used by derived types
Describes the properties of a glyph.
DEFINES MACROS TYPEDEFS
Index of the current option
DEFINES A very big radius to always draw as circle
Perform the main drawing
DEFINES TYPEDEFS
Data structure passed to an input driver to fill
For LV_INDEV_TYPE_KEYPAD the currently pressed key
DEFINES TYPEDEFS Data of image
DEFINES TYPEDEFS
The stop color
DEFINES TYPEDEFS
Index of the currently selected option
The overall opacity
To avoid recomputing gradient for each draw operation, it's possible to cache the computation in this structure instance. Whenever possible, this structure is reused instead of recomputing the gradient map
Minimum value of the bar
DEFINES TYPEDEFS
Current value of the bar
DEFINES TYPEDEFS
For LV_INDEV_TYPE_POINTER the currently pressed point
Called in every cases when the object has been released
Linked list for the series (stores lv_chart_series_t)
Number of options
Store the pointer of the children in an array.
Used as the event parameter of ::LV_EVENT_COVER_CHECK to check if an area is covered by the object or not. In the event use `const lv_area_t * area = lv_event_get_cover_area(e)` to get the area to check and `lv_event_set_cover_res(e, res)` to set the result.
Line or column chart
Widget type specific event function
Run time data of input devices Internally used by the library, you should not need to touch it.
Encoder with only Left, Right turn and a Button
Show a popover when pressing this key
Object coordinates/size have changed
Touch pad, mouse, external button
Store the original index on focus
First element of a gradient is a color, so it maps well here
The area of `mask_buf` with absolute coordinates
Input device events The object has been pressed
Get the required extra draw area around the object (e.g. for shadow). The event parameter is `lv_coord_t *` to store the size.
Number of options
DEFINES TYPEDEFS This describes a glyph.
Start value of the bar
The area with absolute coordinates to draw on `draw_ctx->buf` will be clipped to `draw_ctx->clip_area`
DEFINES TYPEDEFS Heap information structure.
Used as the event parameter of ::LV_EVENT_HIT_TEST to check if an `point` can click the object or not. `res` should be set like this: - If already set to `false` an other event wants that point non clickable. If you want to respect it leave it as `false` or set `true` to overwrite it. - If already set `true` and `point` shouldn't be clickable set to `false` - If already set to `true` you agree that `point` can click the object leave it as `true`
Event callback. Events are used to notify the user of some action being taken on the object. For details, see ::lv_event_t.
LV_INDEV_STATE_REL or LV_INDEV_STATE_PR
Perform the post draw phase (when all children are drawn)
For LV_INDEV_TYPE_ENCODER number of steps since the previous read
Map codepoints to a `glyph_dsc`s Several formats are supported to optimize memory usage See https://github.com/lvgl/lv_font_conv/blob/master/doc/font_spec.md
DEFINES TYPEDEFS GLOBAL PROTOTYPES MACROS
Starting to draw a part. The event parameter is `lv_obj_draw_dsc_t *`.
The object in focus
Used if the widget has multiple similar elements (e.g. table cells)
The object is focused
Pointer to the data of the image
The object is defocused
Child was removed, added, or its size, position were changed
Object's style has changed
Get the internal size of a widget
Pointer to an array with the points of the line
DEFINES TYPEDEFS
STATIC VARIABLES
The stop position in 1/255 unit
The gradient direction. Any of LV_GRAD_DIR_HOR, LV_GRAD_DIR_VER, LV_GRAD_DIR_NONE
Info about the opened image: color format, size, etc. MUST be set in `open` function
Finishing to draw a part. The event parameter is `lv_obj_draw_dsc_t *`.
Max time in Bezier functions (not [0..1] to use integers)
External (hardware button) which is assigned to a specific point of the screen
A key is sent to the object. Get the key with `lv_indev_get_key(lv_indev_get_act());`
More complex but more optimal class based kern value storage
Dynamically allocated event callback and user data array
Current time in animation. Set to negative to make delay.
The object is still being pressed but slid cursor/finger off of the object
Store the original index on focus
Direction in which the list should open
Current brightness of the LED (0..255)
Pointer to an image to blend. If set `fill_color` is ignored
Variable to animate
The object is being pressed (called continuously while pressing)
Maximum value of the bar
Index of the currently pressed option
Drawing events Check if the object fully covers an area. The event parameter is `lv_cover_check_info_t *`.
Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
Pointer to a buffer initialized with `lv_disp_draw_buf_init()`. LVGL will use this buffer(s) to draw the screens contents
Set the position from absolutely (from the start of file)
A simple mapping of kern values from pairs
The position and size of `buf` (absolute coordinates)
Function pointer to read input device data.
Generic prototype of "animator" functions. First parameter is the variable to animate. Second parameter is the value to set. Compatible with `lv_xxx_set_yyy(obj, value)` functions The `x` in `_xcb_t` means it's not a fully generic prototype because it doesn't receive `lv_anim_t *` as its first argument
Width of the glyph's bounding box
Arrow or other icon when the drop-down list is closed
1: Only a pointer is saved in `options`
The class that sent the event
The type if part being draw. Element of `lv__draw_part_type_t`
Called after `long_press_time` in every `long_press_repeat_time` ms. Not called if scrolled.
Like handle to grab to adjust the value
true: `point` can click the object; false: it cannot
A draw descriptor that can be modified to changed what LVGL will draw. Set only for rectangle-like parts
Screens of the display Array of screen objects.
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Animation time in ms
Decode the next encoded character from a string.
Store kerning values. Can be `lv_font_fmt_txt_kern_pair_t * or `lv_font_kern_classes_fmt_txt_t *` depending on `kern_classes`
Structure for holding display buffer information.
The current part for which the event is sent
1: turn the display by 90 degree. @warning Does not update coordinates for you!
STATIC VARIABLES
Pointer to a font where the glyph was actually found after handling fallbacks
Make the object hidden. (Like it wasn't there at all)
Button is currently toggled (e.g. checked).
OPTIONAL: Set a pixel in a buffer according to the special requirements of the display Can be used for color format not supported in LittelvGL. E.g. 2 bit -> 4 gray scales
The index of the part. E.g. a button's index on button matrix or table cell index.
Number of children
Currently active screen on this display
The vertical resolution of the currently active display.
The number of used stops in the array
Scrolling begins. The event parameter is a pointer to the animation of the scroll. Can be modified
Linked list for the cursors (stores lv_chart_cursor_t)
Length of `unicode_list` and/or `glyph_id_ofs_list`
Text to display on the dropdown's button
The area of the part being drawn
A point relative to screen to check if it can click the object or not
Height of the glyph's bounding box
Number of event callbacks stored in `event_dsc` array
if(type == LV_FONT_FMT_TXT_CMAP_FORMAT0_...) it's `uint8_t *` if(type == LV_FONT_FMT_TXT_CMAP_SPARSE_...) it's `uint16_t *`
Type of bar
A process has finished
Other events Object is being deleted
Child was deleted, always bubbles up to all parents
Descriptor of a constant style property.
STATIC VARIABLES
DEFINES TYPEDEFS When loading images from the network it can take a long time to download and decode the image. To avoid repeating this heavy load images can be cached.
Function to execute to animate
STATIC VARIABLES
First glyph ID (array index of `glyph_dsc`) for this range
Type of this character map
DEFINES Brightness when the LED if OFF
Finishing the post draw phase (when all children are drawn)
The object was pressed for a short period of time, then released it. Not called if scrolled.
Store any custom data here is required
The theme assigned to the screen
Previous screen. Used during screen animations
STATIC VARIABLES
Get the current value during an animation
Number of points in 'point_array'
Perform advanced hit-testing
Starting the post draw phase (when all children are drawn)
STATIC VARIABLES
Horizontal resolution.
Image information
Linked list to store the objects in the group
Timer to periodically read the input device
Invalidated (marked to redraw) areas
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Child was created, always bubbles up to all parents
Number of horizontal division lines
Number of vertical division lines
log2(LV_BEZIER_VAL_MAX): used to normalize up scaled values
Brightness when the LED if ON
A point calculated during drawing. E.g. a point of chart or the center of an arc.
Object has been pressed for at least `long_press_time`. Not called if scrolled.
Finishing the main drawing phase
Vertical resolution.
The image source. A file path like "S:my_img.png" or pointer to an `lv_img_dsc_t` variable
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Dynamically allocated anim dsc array
Same as `lv_anim_exec_xcb_t` but receives `lv_anim_t *` as the first parameter. It's more consistent but less convenient. Might be used by binding generator functions.
STATIC VARIABLES
STATIC VARIABLES
Size of available memory
Pointer to a buffer to draw into
Pressed time stamp
E.g. LV_BLEND_MODE_ADDITIVE
A process has been cancelled
DEFINES TYPEDEFS Type for async callback.
Timers execute this type of functions.
1: y == 0 will be on the bottom
Number of Unicode characters related to this range. Last Unicode character = range_start + range_length - 1
CURRENT VERSION OF LVGL
DEFINES Can be used track size to make the track fill the free space.
A draw descriptor that can be modified to changed what LVGL will draw. Set only for text-like parts
A point calculated during drawing. E.g. a point of chart.
Value from ::lv_obj_class_group_def_t
Long press repeat time stamp
Type of the source: file or variable. Can be set in `open` function if required
A text calculated during drawing. Can be modified. E.g. tick labels on a chart axis.
Value from ::lv_obj_class_editable_t
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Number of default events
Make the object clickable by the input devices
The object is defocused but still selected
Amount of fragmentation
The glyph needs this space. Draw the next glyph after this width.
A gradient stop definition. This matches a color and a position in a virtual 0-255 scale.
An array with the properties to animate.
First Unicode character for this range
1: Make the selected option highlighted in the list
DEFINES Some helper defines
STATIC VARIABLES MACROS
Current point of input device.
1: Always make the whole screen redrawn
Wait until all background operations are finished. (E.g. GPU operations)
The real line height where any text fits
TYPEDEFS STATIC PROTOTYPES
STATIC VARIABLES
Same as `LV_IMG_CF_TRUE_COLOR` but every pixel has an alpha byte
DEFINES TYPEDEFS
Store some info to speed up drawing of very large texts It takes a lot of time to get the first visible character because all the previous characters needs to be checked to calculate the positions. This structure stores an earlier (e.g. at -1000 px) coordinate and the index of that line. Therefore the calculations can start from here.
The computed gradient low bitdepth color map, points into the cache's buffer, no free needed
Play back is in progress
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
The length of anim dsc array
x offset of the bounding box
y offset of the bounding box
Color format and depth should match with LV_COLOR settings
Can have one color but 256 different alpha value
A function to call when a new object is focused (optional)
A function to call when an edge is reached, no more focus targets are available in this direction (to allow edge feedback like a sound or a scroll bounce)
The current X/Y scroll offset
OPTIONAL: Called periodically while lvgl waits for operation to be completed. For example flushing or GPU User can execute very simple tasks here or yield the task
The screen prepared to load in lv_scr_load_anim
@see lv_disp_get_layer_top
@see lv_disp_get_layer_sys
Repeat count for the animation
Convert a letter index (in the encoded text) to byte index. E.g. in UTF-8 "AÁRT" index of 'R' is 2 but start at byte 3 because 'Á' is 2 bytes long
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Starting the main drawing phase
The children position has changed due to a layout recalculation
Select a character encoding for strings. Your IDE or editor should have the same character encoding - LV_TXT_ENC_UTF8 - LV_TXT_ENC_ASCII
Same as `LV_IMG_CF_TRUE_COLOR` but LV_COLOR_TRANSP pixels will be transparent
Mark a specific place e.g. for text area's cursor or on a chart
Difference between `act_point` and `last_point`.
First display buffer.
Make the object scrollable
Do not scroll the object when the parent scrolls and ignore layout
Do not repeat press this button.
1: Send LV_EVENT_VALUE_CHANGE on CLICK, 0: Send LV_EVENT_VALUE_CHANGE on PRESS
The decoder which was able to open the image source
A draw descriptor that can be modified to changed what LVGL will draw. Set only for line-like parts
E.g. the radius of an arc (not the corner radius).
A value calculated during drawing. E.g. Chart's tick line value.
1: Apply start value immediately even is there is `delay`
Get a glyph's descriptor from a font
Get the number of characters (and NOT bytes) in a string. E.g. in UTF-8 "ÁBC" is 3 characters (but 4 bytes)
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
A gesture is detected. Get the gesture with `lv_indev_get_gesture_dir(lv_indev_get_act());`
DEFINES TYPEDEFS
Callback to call when the animation really stars (considering `delay`)
Callback used when the animation values are relative to get the current value
Callback used when the animation is deleted
Log important events
Can have one color and it can be drawn or not
STATIC VARIABLES
Can have 2 different colors in a palette (can't be chroma keyed)
Indicate the currently selected option or section
Ignore max-width to avoid automatic word wrapping
1: can't focus to new object
1: Focus next/prev can wrap at end of list. 0: Focus next/prev stops at end of list.
Extra click padding in all direction
Horizontal offset from the full / physical display. Set to 0 for fullscreen mode.
Vertical offset from the full / physical display. Set to 0 for fullscreen mode.
A common callback type for every mask type. Used internally by the library.
Call it when the animation is deleted
Get the current value in relative mode
Describe the path (curve) of animations
Duration of playback animation
Wait before repeat
Base line measured from the top of the line_height
Store implementation specific or run_time data or caching here
Cursor for LV_INPUT_TYPE_POINTER
STATIC VARIABLES GLOBAL VARIABLES
Convert a byte index (in an encoded text) to character index. E.g. in UTF-8 "AÁRT" index of 'R' is 2 but start at byte 3 because 'Á' is 2 bytes long
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS GLOBAL PROTOTYPES MACROS Gives 1 if the x.y.z version is supported in the current version Usage: - Require v6 #if LV_VERSION_CHECK(6,0,0) new_func_in_v6(); #endif - Require at least v5.3 #if LV_VERSION_CHECK(5,3,0) new_feature_from_v5_3(); #endif - Require v5.3.2 bugfixes #if LV_VERSION_CHECK(5,3,2) bugfix_in_v5_3_2(); #endif
Can have 256 different colors in a palette (can't be chroma keyed)
Can have one color but 4 different alpha value
Can have one color but 16 different alpha value
Ticks on scale e.g. for a chart or meter
Do not align, leave where it is
Second display buffer.
A screen unload started, fired immediately when scr_load is called
A screen load started, fired when the screen change delay is expired
Total heap size
A custom user data that will be passed to the animation's user_data
A path for the animation.
Duration of the transition in [ms]
Delay before the transition in [ms]
For LV_INDEV_TYPE_BUTTON the currently pressed button
Enable parsing of recolor command
Align text to center
Index of the line at `y` coordinate
A life counter that's incremented on usage. Higher counter is less likely to be evicted from the cache
A pointer the identifies something in the part. E.g. chart series.
Special, rarely used attributes. They are allocated automatically if any elements is set.
1: anti-aliasing is enabled on this display.
OPTIONAL: Extend the invalidated areas to match with the display drivers requirements E.g. round `y` to, 8, 16 ..) on a monochrome display
Opacity of the background color or wallpaper
Get a glyph's bitmap from a font
Thickness of the underline
Timer function
1: One time; -1 : infinity; n>0: residual times
Number of pixels to slide before actually drag the object
Repeated trigger period in long press [ms]
Keypad destination group
Get the previous encoded character form a string.
STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Align text to right
Last point of input device.
Size of the image in bytes
MACROS The horizontal resolution of the currently active display.
Propagate the events to the parent too
Keep the size and roll the text circularly
DPI (dot per inch) of the display. Default value is `LV_DPI_DEF`. MANDATORY: Write the internal buffer (draw_buf) to the display. 'lv_disp_flush_ready()' has to be called when finished
Pointer to a buffer where the image's data (pixels) are stored in a decoded, plain format. MUST be set in `open` function
How much time did it take to open the image. [ms] If not set `lv_img_cache` will measure and set the time to open
The cache was too small so this item is not managed by the cache
Horizontal resolution of the full / physical display. Set to -1 for fullscreen mode.
Vertical resolution of the full / physical display. Set to -1 for fullscreen mode.
An image source to display as wallpaper
Get an area of a transformed image (zoomed and/or rotated)
Replace the buffer with a rect without decoration like radius or borders
Wait before play back
How often the timer should run
Last time the timer ran
Custom user data
At least this difference should be between two points to evaluate as gesture
Current state of the input device.
Last time when there was activity on this display
Initialize a new layer context. The original buffer and area data are already saved from `draw_ctx` to `layer_ctx`
Adjust the layer_ctx and/or draw_ctx based on the `layer_ctx->area_act`. It's called only if flags has `LV_DRAW_LAYER_FLAG_CAN_SUBDIVIDE`
Blend a rendered layer to `layer_ctx->area_act`
Destroy a layer context. The original buffer and area data of the `draw_ctx` will be restored and the `layer_ctx` itself will be freed automatically.
GLOBAL VARIABLES
Special value can be used in some functions to target all parts
STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Init configuration structure
LCD Screen swapped X and Y (in esp_lcd driver)
LCD Screen mirrored X (in esp_lcd driver)
LCD Screen mirrored Y (in esp_lcd driver)
Configuration display structure
Automatically scroll object to make it visible when focused
Make the object position-able by the layouts
Draw points and lines in 2D (x,y coordinates)
OPTIONAL: called when driver parameters are updated
Size of the text buffer containing null-terminated text string calculated during drawing.
1: Edit mode, 0: Navigate mode
1: Focus prev if focused on deletion. 0: Focus next if focused on deletion.
How to display scrollbars
The allowed scroll direction(s)
1: Automatically delete the previous screen when the screen load animation is ready
Default display color when screens are transparent
Call it when the animation is starts (considering `delay`)
Call it when the animation is ready
Distance between the top of the underline and base line (< 0 means below the base line)
Array points assigned to the button ()screen will be pressed here by the buttons
Convert a Unicode letter to encoded
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
Fill an area of the destination buffer with a color
Check the base class. Must have 0 value to let zero initialized class inherit
Check the base class. Must have 0 value to let zero initialized class inherit
A text is inserted to the object. The event data is `char *` being inserted.
Notify the object to refresh something on it (for the user)
Max size of Heap memory used
Percentage used
If set to true, the read callback is invoked again
Set the position from the current position
Set the position from the end of the file
DEFINES A lot of logs to give detailed information
Do not log anything
Can have 4 different colors in a palette (can't be chroma keyed)
Can have 16 different colors in a palette (can't be chroma keyed)
No gradient (the `grad_color` property is ignored)
Align to the right/bottom
STATIC VARIABLES
Callback to call when the animation is ready
Symbol (lv_symbol_def.h)
Add focused state to the object when clicked
STATIC VARIABLES
STATIC VARIABLES
A text to display instead of the image when the image can't be opened. Can be set in `open` function or set NULL.
Get info from an image and store in the `header`
Open an image for decoding. Prepare it as it is required to read it later
Decode `len` pixels starting from the given `x`, `y` coordinates and store them in `buf`. Required only if the "open" function can't return with the whole decoded pixel array.
Close the pending decoding. Free resources etc.
Give the `y` coordinate of the first letter at `line start` index. Relative to the label's coordinates
The 'y1' coordinate of the label when the hint was saved. Used to invalidate the hint if the label has moved too much.
The computed gradient color map size, in colors
A draw descriptor that can be modified to changed what LVGL will draw. Set only for arc-like parts
EXTend the size in every direction for drawing.
Cache the layer type here. Element of @lv_intermediate_layer_type_t
OPTIONAL: Called after every refresh cycle to tell the rendering and flushing time + the number of flushed pixels
OPTIONAL: Called when lvgl needs any CPU cache that affects rendering to be cleaned
OPTIONAL: called when start rendering
On CHROMA_KEYED images this color will be transparent. `LV_COLOR_CHROMA_KEY` by default. (lv_conf.h)
1: Draw previous screen over active screen
1: The current screen rendering is in progress
Custom user data
Indicates the animation has run in this round
An element of `lv_font_subpx_t`
Bit-per-pixel: 1, 2, 4, 8
Called when an action happened on the input device. The second parameter is the event from `lv_event_t`
Drag throw slow-down in [%]. Greater value means faster slow-down
At least this difference should be to send a gesture
Long press time in milliseconds
Apply the current theme's style on top of this theme.
Size of a layer context in bytes.
DEFINES TYPEDEFS
GLOBAL VARIABLES
DEFINES Same as Android's DIP. (Different name is chosen to avoid mistype between LV_DPI and LV_DIP) 1 dip is 1 px on a 160 DPI screen 1 dip is 2 px on a 320 DPI screen https://stackoverflow.com/questions/2025282/what-is-the-difference-between-px-dip-dp-and-sp
Size of the buffer for the screen in pixels
Max-width is already equal to the longest line. (Used to skip some calculation)
Align text to left
STATIC VARIABLES
Custom display driver user data
@file lv_templ.c INCLUDES DEFINES TYPEDEFS
Flags for style behavior The rest of the flags will have _FLAG added to their name in v9.
Toggle checked state when the object is clicked
Do not clip the children's content to the parent's boundary
Connect the points with lines
Shift old data to the left and add the new one the right
Infinite mode (roller can be scrolled forever).
Color to draw the image. USed when the image has alpha channel only
Count the cache entries's life. Add `time_to_open` to `life` when the entry is used. Decrement all lifes by one every in every ::lv_img_cache_open. If life == 0 the entry can be reused
A discriminating key that's built from the drawing operation. If the key does not match, the cache item is not used
The map allocated size in colors
Where to align the snappable children horizontally
Where to align the snappable children vertically
1: Use screen-sized buffers and draw to absolute coordinates
1: use software rotation (slower)
Handle if the screen doesn't have a solid (opa == LV_OPA_COVER) background. Use only if required because it's slower.
Indicates that the `start_cb` was already called
Used on line and scatter charts for lines and points
Used on tick lines and labels
Copy an area from buffer to an other
Convert a wide character, e.g. 'Á' little endian to be compatible with the encoded format.
DEFINES TYPEDEFS
LVGL task pinned to core (-1 is no affinity)
LCD display horizontal resolution
LCD display vertical resolution
Default values of the screen rotation
Expand the object size to the text size
Allow propagating the vertical scroll to a parent
Allow performing more accurate hit (click) test. E.g. consider rounded corners.
Vertical (top to bottom) gradient
Last point read from read_cb.
Show scroll bars when object is being scrolled
Show scroll bars when the content is large enough to be scrolled
Keep the object width, wrap the too long lines and expand the object height
Keep the size and write dots at the end if the text is too long
Keep the size and roll the text back and forth
Normal mode (roller ends at the end of the options).
STATIC VARIABLES
STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
@file lvgl.h Include all LVGL related headers
@file lv_log.h
GENERATED FILE, DO NOT EDIT IT! @file lv_conf_internal.h Make sure all the defines of lv_conf.h have a default value
* @file lv_conf_kconfig.h * Configs that need special handling when LVGL is used with Kconfig
@file lv_types.h
Log if something unwanted happened but didn't caused problem
Only critical issue, when the system may fail
Custom logs from the user
@file lv_timer.h
@file lv_math.h
@file lv_mem.h
@file lv_async.h
@file lv_anim_timeline.h
@file lv_anim.h
@file lv_draw.h
@file lv_style.h
@file lv_font.h
@file lv_area.h
@file lv_color.h
@file lv_assert.h
@file lv_bidi.h
@file lv_fs.h
@file lv_draw_rect.h
@file lv_obj_pos.h
@file lv_draw_label.h
@file lv_draw_line.h
@file lv_draw_triangle.h
@file lv_draw_arc.h
@file lv_draw_mask.h
@file lv_ll.h Handle linked lists. The nodes are dynamically allocated by the 'lv_mem' module.
@file lv_obj.h
@file struct _lv_obj_tree.h
@file lv_obj_scroll.h
@file lv_obj_style.h
@file lv_obj_draw.h
@file lv_obj_class.h
@file lv_event.h
@file lv_group.h
@file lv_indev.h
@file lv_refr.h
@file lv_theme.h
@file lv_font_fmt_txt.h
@file lv_arc.h
@file lv_label.h
@file lv_line.h
@file lv_table.h
@file lv_bar.h
@file lv_slider.h
@file lv_dropdown.h
@file lv_roller.h
@file lv_textarea.h
@file lv_canvas.h
@file lv_switch.h
@file lv_flex.h
@file lv_grid.h
@file lv_bmp.h
@file lv_fsdrv.h
@file lv_gif.h
@file lvgl.h This file exists only to be compatible with Arduino's library structure
@file lv_qrcode
@file lv_freetype.h
@file lv_rlottie.h
@file lv_ffmpeg.h
@file lv_snapshot.h
@file lv_monkey.h
Public header for Fragment @file lv_fragment.h
@file lv_imgfont.h
@file lv_ime_pinyin.h
@file lv_theme_default.h
@file lv_calendar.h
@file lv_chart.h
@file lv_keyboard.h
@file lv_win.h
@file lv_menu.h
@file lv_mbox.h
@file lv_spinbox.h
@file lv_spinner.h
@file lv_templ.h
@file lv_tileview.h
@file lv_win.h
@file lv_led.h
@file lv_span.h
@file lv_indev_scroll.h
@file lv_draw_sw.h
@file lv_draw_sw_blend.h
@file lv_utils.h
@file lv_lru.h
LVGL task stack size
LCD panel IO handle
Allow scrolling only one snappable children
Allow propagating the horizontal scroll to a parent
If scroll snap is enabled on the parent it can snap to this object
Custom flag, free to use by layouts
Custom flag, free to use by widget
Processing the parameter
Simply mix according to the opacity value
Horizontal (left to right) gradient
If the object size is set to SIZE_CONTENT, then object size equals zoomed image size. It causes layout recalculation. If the object size is set explicitly, the image will be cropped when zoomed in.
STATIC VARIABLES
STATIC VARIABLES
STATIC VARIABLES
Frame of the image, using with animated images
Used to skip dithering in it if already done
A draw descriptor that can be modified to changed what LVGL will draw. Set only for image-like parts
Fallback font for missing glyph. Resolved recursively
The tick lines and labels
The border if style_border_post = true
Whether to dither the gradient or not. Any of LV_DITHER_NONE, LV_DITHER_ORDERED, LV_DITHER_ERR_DIFF
Used before/after drawn the div lines
Used for each horizontal division lines
Used for each vertical division lines
Used on bar charts for the rectangles
Used on cursor lines and points
The main (right) knob's rectangle
The rectangle and label of buttons
"Simple layers" are used when a widget has `style_opa < 255` to buffer the widget into a layer and blend it as an image with the given opacity. Note that `bg_opa`, `text_opa` etc don't require buffering into layer) The widget can be buffered in smaller chunks to avoid using large buffers. - LV_LAYER_SIMPLE_BUF_SIZE: [bytes] the optimal target buffer size. LVGL will try to allocate it - LV_LAYER_SIMPLE_FALLBACK_BUF_SIZE: [bytes] used if `LV_LAYER_SIMPLE_BUF_SIZE` couldn't be allocated. Both buffer sizes are in bytes. "Transformed layers" (where transform_angle/zoom properties are used) use larger buffers and can't be drawn in chunks. So these settings affects only widgets with opacity.
STATIC VARIABLES GLOBAL VARIABLES
Maximum sleep in LVGL task
LVGL timer tick period in ms
True, if should be allocated two buffers
True, if display is monochrome and using 1bit for 1px
Contains the file as it is. Needs custom decoder function
Allocated LVGL buffer will be DMA capable
Allocated LVGL buffer will be in PSRAM
fixed the obj size
Keep width, break the too long lines and expand height
Special value can be used in some functions to target all states
Allow scrolling inside but with slower speed
Make the object scroll further when "thrown"
Allow scrolling the focused object with arrow keys
Keep the object pressed even if the press slid from the object
Propagate the gestures to the parent
Custom flag, free to use by layouts
Processing the command
Add the respective color channels
Subtract the foreground from the background
Multiply the foreground and background
Keep the size and clip the text out of it
STATIC VARIABLES
DEFINES TYPEDEFS STATIC PROTOTYPES STATIC VARIABLES
STATIC VARIABLES
Contains the file as it is. The image has alpha. Needs custom decoder function
Contains the file as it is. The image is chroma keyed. Needs custom decoder function
Extension point for custom widgets
FOR matrix-like objects (e.g. Button matrix)
Zoom doesn't affect the coordinates of the object, however if zoomed in the image is drawn out of the its coordinates. The layout's won't change on zoom
Enable text recoloring with `#color`
LVGL port configuration structure
Custom user data for font.
Custom file user data
Number of log levels
@file lv_hal_tick.h Provide access to the system tick with 1 millisecond resolution
@file lv_hal.h
@file lv_hal_disp.h @description Display Driver HAL interface header file
@file lv_txt.h
@file lv_img_decoder.h
@file lv_img_buf.h
@file lv_img_cache.h
@file lv_draw_sw_dither.h
@file lv_draw_img.h
@file lv_draw_transform.h
@file lv_draw_layer.h
@file lv_hal_indev.h @description Input Device HAL interface layer header file
@file lv_disp.h
@file lv_font_loader.h
@file lv_btn.h
@file lv_img.h
@file lv_btnmatrix.h
@file lv_api_map.h
@file lv_extra.h
@file lv_layouts.h
@file lv_libs.h
@file lv_png.h
@file lv_sjpg.h
@file lv_others.h
STATIC PROTOTYPES STATIC VARIABLES MACROS GLOBAL FUNCTIONS STATIC FUNCTIONS @file lv_gridnav.h
@file lv_msg.h
@file lv_themes.h
@file lv_theme_basic.h
@file lv_widgets.h
@file lv_animimg.h
@file lv_meter.h
@file lv_colorwheel.h
@file lv_imgbtn.h
@file lv_gc.h
@file lv_gpu_arm2d.h
@file lv_gpu_nxp.h MIT License Copyright 2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_draw_pxp_blend.h MIT License Copyright 2020-2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_gpu_nxp_pxp.h MIT License Copyright 2020-2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_gpu_nxp_pxp_osa.h MIT License Copyright 2020, 2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_draw_vglite_arc.h MIT License Copyright 2021, 2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_draw_vglite_blend.h MIT License Copyright 2020-2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_draw_vglite_rect.h MIT License Copyright 2021, 2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_gpu_nxp_vglite.h MIT License Copyright 2020-2022 NXP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@file lv_gpu_stm32_dma2d.h
@file lv_txt_ap.h
The OUTER_MASK_WIDTH define is required to assist with the placing of a mask over the outer ring of the widget as when the multicoloured radial lines are calculated for the outer ring of the widget their lengths are jittering because of the integer based arithmetic. From tests the maximum delta was found to be 2 so the current value is set to 3 to achieve appropriate masking.
@file lv_draw_sdl.h
I2C address of the SH1107 controller
Touch IO configuration structure
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
Reserved for further use.
User holder encoding format.
User holder encoding format.
User holder encoding format.
User holder encoding format.
User holder encoding format.
User holder encoding format.
User holder encoding format.
User holder encoding format.
Custom flag, free to use by widget
Custom flag, free to use by user
Custom flag, free to use by user
Custom flag, free to use by user
Custom flag, free to use by user
Replace background with foreground in the area
No dithering, colors are just quantized to the output resolution
Ordered dithering. Faster to compute and use less memory but lower quality
Error diffusion mode. Slower to compute and use more memory but give highest dither quality
Don't draw the series
Add the new data in a circular way
Reserved to stire the size units

Dependencies

i2c_oled sample depends on the following libraries: