# lv_wayland_window.h (/api/public/drivers/wayland/lv_wayland_window_h)



<ApiSummary functions="10" typedefs="1" macros="1" />

Functions [#functions]

<ApiTabs items="[&#x22;Setters (4)&#x22;,&#x22;Other (6)&#x22;]">
  <ApiTab value="Setters (4)">
    <ApiMember kind="function" name="lv_wayland_window_set_physical_display" file="public/drivers/wayland/lv_wayland_window.h" line="67" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L67">
      lv_wayland_window_set_physical_display [#lv_wayland_window_set_physical_display]

      Assigns the window to a specific physical display

      ```c title=" " lineNumbers=1
      void lv_wayland_window_set_physical_display(lv_display_t *display, uint8_t phys_display)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name           | Type                                                     | Description                                                                                                  |
      | -------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
      | `display`      | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window                                                       |
      | `phys_display` | `uint8_t`                                                | Physical display number or LV\_WAYLAND\_PHYSICAL\_DISPLAY\_ANY to unassign a previously set physical display |
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_set_fullscreen" file="public/drivers/wayland/lv_wayland_window.h" line="84" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L84">
      lv_wayland_window_set_fullscreen [#lv_wayland_window_set_fullscreen]

      Sets the fullscreen state of the window

      ```c title=" " lineNumbers=1
      void lv_wayland_window_set_fullscreen(lv_display_t *display, bool fullscreen)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name         | Type                                                     | Description                                            |
      | ------------ | -------------------------------------------------------- | ------------------------------------------------------ |
      | `display`    | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |
      | `fullscreen` | `bool`                                                   | If true the window enters fullscreen                   |

      <Callout type="info">
        The fullscreen request is made asynchronously and may not be fulfilled if the compositor doesn't allow it. <ApiLink name="lv_wayland_window_is_fullscreen" display="lv_wayland_window_is_fullscreen()" /> can be used to determine the fullscreen state of the window.
      </Callout>
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_set_maximized" file="public/drivers/wayland/lv_wayland_window.h" line="102" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L102">
      lv_wayland_window_set_maximized [#lv_wayland_window_set_maximized]

      Requests the window be maximized/unmaximized

      ```c title=" " lineNumbers=1
      void lv_wayland_window_set_maximized(lv_display_t *display, bool maximize)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name       | Type                                                     | Description                                            |
      | ---------- | -------------------------------------------------------- | ------------------------------------------------------ |
      | `display`  | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |
      | `maximize` | `bool`                                                   | true: maximize the window false: unmaximize the window |

      <Callout type="info">
        The maximized request is made asynchronously and may not be fulfilled if the compositor doesn't allow it. <ApiLink name="lv_wayland_window_is_maximized" display="lv_wayland_window_is_maximized()" /> can be used to determine the maximized state of the window.
      </Callout>
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_set_minimized" file="public/drivers/wayland/lv_wayland_window.h" line="115" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L115">
      lv_wayland_window_set_minimized [#lv_wayland_window_set_minimized]

      Minimizes the window

      ```c title=" " lineNumbers=1
      void lv_wayland_window_set_minimized(lv_display_t *display)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name      | Type                                                     | Description                                            |
      | --------- | -------------------------------------------------------- | ------------------------------------------------------ |
      | `display` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (6)">
    <ApiMember kind="function" name="lv_wayland_window_create" file="public/drivers/wayland/lv_wayland_window.h" line="45" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L45">
      lv_wayland_window_create [#lv_wayland_window_create]

      Creates a window

      ```c title=" " lineNumbers=1
      lv_display_t * lv_wayland_window_create(uint32_t hor_res, uint32_t ver_res, char *title, lv_wayland_display_close_cb_t close_cb)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name       | Type                                             | Description                                                       |
      | ---------- | ------------------------------------------------ | ----------------------------------------------------------------- |
      | `hor_res`  | `uint32_t`                                       | The width of the window in pixels                                 |
      | `ver_res`  | `uint32_t`                                       | The height of the window in pixels                                |
      | `title`    | `char *`                                         | The title of the window                                           |
      | `close_cb` | <ApiLink name="lv_wayland_display_close_cb_t" /> | The callback that will be execute when the user closes the window |

      **Returns:** <ApiLink name="lv_display_t" display="lv_display_t *" /> — The LVGL display associated to the window
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_close" file="public/drivers/wayland/lv_wayland_window.h" line="52" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L52">
      lv_wayland_window_close [#lv_wayland_window_close]

      Closes the window programmatically

      ```c title=" " lineNumbers=1
      void lv_wayland_window_close(lv_display_t *display)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name      | Type                                                     | Description                                                               |
      | --------- | -------------------------------------------------------- | ------------------------------------------------------------------------- |
      | `display` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window **May** be `NULL`. |
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_is_open" file="public/drivers/wayland/lv_wayland_window.h" line="59" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L59">
      lv_wayland_window_is_open [#lv_wayland_window_is_open]

      Check if the window is open

      ```c title=" " lineNumbers=1
      bool lv_wayland_window_is_open(lv_display_t *display)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name      | Type                                                     | Description                                            |
      | --------- | -------------------------------------------------------- | ------------------------------------------------------ |
      | `display` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |

      **Returns:** `bool` — true: The window is open
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_remove_physical_display" file="public/drivers/wayland/lv_wayland_window.h" line="73" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L73">
      lv_wayland_window_remove_physical_display [#lv_wayland_window_remove_physical_display]

      Unassigns the current physical display attached to the window

      ```c title=" " lineNumbers=1
      void lv_wayland_window_remove_physical_display(lv_display_t *display)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name      | Type                                                     | Description                                            |
      | --------- | -------------------------------------------------------- | ------------------------------------------------------ |
      | `display` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_is_fullscreen" file="public/drivers/wayland/lv_wayland_window.h" line="91" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L91">
      lv_wayland_window_is_fullscreen [#lv_wayland_window_is_fullscreen]

      Check if window is fullscreen

      ```c title=" " lineNumbers=1
      bool lv_wayland_window_is_fullscreen(lv_display_t *disp)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                                     | Description                                            |
      | ------ | -------------------------------------------------------- | ------------------------------------------------------ |
      | `disp` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |

      **Returns:** `bool` — the fullscreen state of the window as reported by the compositor
    </ApiMember>

    <ApiMember kind="function" name="lv_wayland_window_is_maximized" file="public/drivers/wayland/lv_wayland_window.h" line="109" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L109">
      lv_wayland_window_is_maximized [#lv_wayland_window_is_maximized]

      Check if window is maximized

      ```c title=" " lineNumbers=1
      bool lv_wayland_window_is_maximized(lv_display_t *disp)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                                     | Description                                            |
      | ------ | -------------------------------------------------------- | ------------------------------------------------------ |
      | `disp` | <ApiLink name="lv_display_t" display="lv_display_t *" /> | Reference to the LVGL display associated to the window |

      **Returns:** `bool` — the maximized state of the window as reported by the compositor
    </ApiMember>
  </ApiTab>
</ApiTabs>

Typedefs [#typedefs]

<ApiMember kind="typedef" name="lv_wayland_display_close_cb_t" file="public/drivers/wayland/lv_wayland_window.h" line="30" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L30">
  lv_wayland_display_close_cb_t [#lv_wayland_display_close_cb_t]

  ```c title=" " lineNumbers=1
  typedef bool(* lv_wayland_display_close_cb_t) (lv_display_t *display)
  ```
</ApiMember>

<TypeUsedBy name="lv_wayland_display_close_cb_t" count="1">
  * `lv_wayland_window_create` — param `close_cb`
</TypeUsedBy>

Macros [#macros]

<ApiMember kind="macro" name="LV_WAYLAND_PHYSICAL_DISPLAY_ANY" file="public/drivers/wayland/lv_wayland_window.h" line="31" url="https://github.com/lvgl/lvgl/tree/e1a0ad863f29742359bc680d6a7d973448ec2285/include/lvgl/drivers/wayland/lv_wayland_window.h#L31">
  LV_WAYLAND_PHYSICAL_DISPLAY_ANY [#lv_wayland_physical_display_any]

  ```c title=" " lineNumbers=1
  #define LV_WAYLAND_PHYSICAL_DISPLAY_ANY 0xFF
  ```
</ApiMember>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_display.h&#x22;]" includedBy="[&#x22;lv_wayland.h&#x22;, &#x22;lvgl.h&#x22;]" transitiveIncludes="[&#x22;lv_area.h&#x22;, &#x22;lv_assert.h&#x22;, &#x22;lv_color.h&#x22;, &#x22;lv_color_op.h&#x22;, &#x22;lv_conf_internal.h&#x22;, &#x22;lv_event.h&#x22;, &#x22;lv_log.h&#x22;, &#x22;lv_math.h&#x22;, &#x22;lv_mem.h&#x22;, &#x22;lv_palette.h&#x22;, &#x22;lv_timer.h&#x22;, &#x22;lv_types.h&#x22;]" />
