Trait gdk4::prelude::DisplayExt

source ·

pub trait DisplayExt: IsA<Display> + Sealed + 'static {
Show 35 methods    // Provided methods
    fn beep(&self) { ... }
    fn close(&self) { ... }
    fn create_gl_context(&self) -> Result<GLContext, Error> { ... }
    fn device_is_grabbed(&self, device: &impl IsA<Device>) -> bool { ... }
    fn flush(&self) { ... }
    fn app_launch_context(&self) -> AppLaunchContext { ... }
    fn clipboard(&self) -> Clipboard { ... }
    fn default_seat(&self) -> Option<Seat> { ... }
    fn dmabuf_formats(&self) -> DmabufFormats { ... }
    fn monitor_at_surface(&self, surface: &impl IsA<Surface>) -> Option<Monitor> { ... }
    fn monitors(&self) -> ListModel { ... }
    fn name(&self) -> GString { ... }
    fn primary_clipboard(&self) -> Clipboard { ... }
    fn startup_notification_id(&self) -> Option<GString> { ... }
    fn is_closed(&self) -> bool { ... }
    fn is_composited(&self) -> bool { ... }
    fn is_rgba(&self) -> bool { ... }
    fn list_seats(&self) -> Vec<Seat> { ... }
    fn notify_startup_complete(&self, startup_id: &str) { ... }
    fn prepare_gl(&self) -> Result<(), Error> { ... }
    fn put_event(&self, event: impl AsRef<Event>) { ... }
    fn supports_input_shapes(&self) -> bool { ... }
    fn supports_shadow_width(&self) -> bool { ... }
    fn sync(&self) { ... }
    fn is_input_shapes(&self) -> bool { ... }
    fn connect_closed<F: Fn(&Self, bool) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_opened<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId { ... }
    fn connect_seat_added<F: Fn(&Self, &Seat) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_seat_removed<F: Fn(&Self, &Seat) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_setting_changed<F: Fn(&Self, &str) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_composited_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_dmabuf_formats_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_input_shapes_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_rgba_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_shadow_width_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
}

Expand description

Trait containing all Display methods.

§Implementors

Display

Provided Methods§

source

fn beep(&self)

Emits a short beep on @self

source

fn close(&self)

Closes the connection to the windowing system for the given display.

This cleans up associated resources.

source

fn create_gl_context(&self) -> Result<GLContext, Error>

Available on crate feature v4_6 only.

Creates a new GLContext for the Display.

The context is disconnected from any particular surface or surface and cannot be used to draw to any surface. It can only be used to draw to non-surface framebuffers like textures.

If the creation of the GLContext failed, @error will be set. Before using the returned GLContext, you will need to call GLContextExt::make_current() or GLContextExt::realize().

§Returns

the newly created GLContext

source

fn device_is_grabbed(&self, device: &impl IsA<Device>) -> bool

Returns true if there is an ongoing grab on @device for @self.

§`device`

a Device

§Returns

true if there is a grab in effect for @device.

source

fn flush(&self)

Flushes any requests queued for the windowing system.

This happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitly. A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running.

This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

source

fn app_launch_context(&self) -> AppLaunchContext

Returns a AppLaunchContext suitable for launching applications on the given display.

§Returns

a new AppLaunchContext for @self

source

fn clipboard(&self) -> Clipboard

Gets the clipboard used for copy/paste operations.

§Returns

the display’s clipboard

source

fn default_seat(&self) -> Option<Seat>

Returns the default Seat for this display.

Note that a display may not have a seat. In this case, this function will return None.

§Returns

the default seat.

source

fn dmabuf_formats(&self) -> DmabufFormats

Available on crate feature v4_14 only.

Returns the dma-buf formats that are supported on this display.

GTK may use OpenGL or Vulkan to support some formats. Calling this function will then initialize them if they aren’t yet.

The formats returned by this function can be used for negotiating buffer formats with producers such as v4l, pipewire or GStreamer.

To learn more about dma-bufs, see DmabufTextureBuilder.

§Returns

a DmabufFormats object

source

fn monitor_at_surface(&self, surface: &impl IsA<Surface>) -> Option<Monitor>

Gets the monitor in which the largest area of @surface resides.

§`surface`

a Surface

§Returns

the monitor with the largest overlap with @surface

source

fn monitors(&self) -> ListModel

Gets the list of monitors associated with this display.

Subsequent calls to this function will always return the same list for the same display.

You can listen to the GListModel::items-changed signal on this list to monitor changes to the monitor of this display.

§Returns

a GListModel of Monitor

source

fn name(&self) -> GString

Gets the name of the display.

§Returns

a string representing the display name. This string is owned by GDK and should not be modified or freed.

source

fn primary_clipboard(&self) -> Clipboard

Gets the clipboard used for the primary selection.

On backends where the primary clipboard is not supported natively, GDK emulates this clipboard locally.

§Returns

the primary clipboard

source

fn startup_notification_id(&self) -> Option<GString>

👎Deprecated: Since 4.10

Gets the startup notification ID for a Wayland display, or None if no ID has been defined.

§Deprecated since 4.10

§Returns

the startup notification ID for @self

source

fn is_closed(&self) -> bool

Finds out if the display has been closed.

§Returns

true if the display is closed.

source

fn is_composited(&self) -> bool

Returns whether surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen.

Check is_rgba() for whether the display supports an alpha channel.

On X11 this function returns whether a compositing manager is compositing on @self.

On modern displays, this value is always true.

§Returns

Whether surfaces with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.

source

fn is_rgba(&self) -> bool

Returns whether surfaces on this @self are created with an alpha channel.

Even if a true is returned, it is possible that the surface’s alpha channel won’t be honored when displaying the surface on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display. Use is_composited() to check if that is the case.

On modern displays, this value is always true.

§Returns

true if surfaces are created with an alpha channel or false if the display does not support this functionality.

source

fn list_seats(&self) -> Vec<Seat>

Returns the list of seats known to @self.

§Returns

the list of seats known to the Display

source

fn notify_startup_complete(&self, startup_id: &str)

👎Deprecated: Since 4.10

Indicates to the GUI environment that the application has finished loading, using a given identifier.

GTK will call this function automatically for GtkWindow with custom startup-notification identifier unless gtk_window_set_auto_startup_notification() is called to disable that feature.

§Deprecated since 4.10

Using ToplevelExt::set_startup_id() is sufficient

§`startup_id`

a startup-notification identifier, for which notification process should be completed

source

fn prepare_gl(&self) -> Result<(), Error>

Available on crate feature v4_4 only.

Checks that OpenGL is available for @self and ensures that it is properly initialized. When this fails, an @error will be set describing the error and this function returns false.

Note that even if this function succeeds, creating a GLContext may still fail.

This function is idempotent. Calling it multiple times will just return the same value or error.

You never need to call this function, GDK will call it automatically as needed. But you can use it as a check when setting up code that might make use of OpenGL.

§Returns

true if the display supports OpenGL

source

fn put_event(&self, event: impl AsRef<Event>)

👎Deprecated: Since 4.10

Adds the given event to the event queue for @self.

§Deprecated since 4.10

This function is only useful in very special situations and should not be used by applications.

§`event`

a Event

source

fn supports_input_shapes(&self) -> bool

Returns true if the display supports input shapes.

This means that SurfaceExt::set_input_region() can be used to modify the input shape of surfaces on @self.

On modern displays, this value is always true.

§Returns

true if surfaces with modified input shape are supported

source

fn supports_shadow_width(&self) -> bool

Available on crate feature v4_14 only.

Returns whether it’s possible for a surface to draw outside of the window area.

If true is returned the application decides if it wants to draw shadows. If false is returned, the compositor decides if it wants to draw shadows.

§Returns

true if surfaces can draw shadows or false if the display does not support this functionality.

source

fn sync(&self)

Flushes any requests queued for the windowing system and waits until all requests have been handled.

This is often used for making sure that the display is synchronized with the current state of the program. Calling sync() before GdkX11::Display::error_trap_pop() makes sure that any errors generated from earlier requests are handled before the error trap is removed.

This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

source