diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 747b0c3..e994dd6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: uses: actions-rs/cargo@v1 with: command: doc - args: --no-deps --features "test_all_features" -p smithay -p calloop:0.6.2 -p dbus -p drm -p gbm -p image -p input -p nix:0.17.0 -p udev -p slog -p wayland-server -p wayland-commons:0.26.6 -p wayland-protocols:0.26.6 -p winit + args: --no-deps --features "test_all_features" -p smithay -p calloop:0.8.0 -p dbus -p drm -p gbm -p input -p nix:0.20.0 -p udev -p slog -p wayland-server -p wayland-commons -p wayland-protocols -p winit - name: Setup index run: cp ./doc_index.html ./target/doc/index.html diff --git a/Cargo.toml b/Cargo.toml index 2320321..3a8f411 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -47,7 +47,7 @@ gl_generator = { version = "0.14", optional = true } pkg-config = { version = "0.3.17", optional = true } [features] -default = ["backend_drm", "backend_gbm", "backend_libinput", "backend_udev", "backend_session_logind", "backend_winit", "renderer_gl", "xwayland", "wayland_frontend", "slog-stdlog"] +default = ["backend_drm", "backend_gbm", "backend_libinput", "backend_udev", "backend_session_logind", "backend_winit", "image", "renderer_gl", "xwayland", "wayland_frontend", "slog-stdlog"] backend_winit = ["winit", "wayland-server/dlopen", "backend_egl", "wayland-egl", "renderer_gl"] backend_drm = ["drm", "drm-ffi"] backend_gbm = ["gbm"] diff --git a/src/backend/drm/render.rs b/src/backend/drm/render.rs index 3c9ca7b..b9fadfe 100644 --- a/src/backend/drm/render.rs +++ b/src/backend/drm/render.rs @@ -266,7 +266,7 @@ where } /// Returns the pending [`connector`](drm::control::connector)s - /// used for the next frame as submitted by [`finish`](Renderer::finish) of this [`DrmRenderSurface`] + /// used for the next frame in [`render`](DrmRenderSurface::render) pub fn pending_connectors(&self) -> impl IntoIterator { self.drm.pending_connectors() } diff --git a/src/backend/drm/surface/mod.rs b/src/backend/drm/surface/mod.rs index 79d2a5f..c307d9a 100644 --- a/src/backend/drm/surface/mod.rs +++ b/src/backend/drm/surface/mod.rs @@ -198,8 +198,8 @@ impl DrmSurface { /// /// This operation is not necessarily blocking until the crtc is in the desired state, /// but will trigger a `vblank` event once done. - /// Make sure to [set a `DeviceHandler`](crate::backend::drm::DrmDevice::set_handler) and - /// [register the belonging `Device`](crate::backend::drm::device_bind) before to receive the event in time. + /// Make sure to have the device registered in your event loop prior to invoking this, to not miss + /// any generated event. pub fn commit<'a>( &self, mut framebuffers: impl Iterator, @@ -226,8 +226,7 @@ impl DrmSurface { /// This will not cause the crtc to modeset. /// /// This operation is not blocking and will produce a `vblank` event once swapping is done. - /// Make sure to [set a `DeviceHandler`](crate::backend::drm::DrmDevice::set_handler) and - /// [register the belonging `DrmDevice`](crate::backend::drm::device_bind) before to receive the event in time. + /// Make sure to have the device registered in your event loop to not miss the event. pub fn page_flip<'a>( &self, mut framebuffers: impl Iterator, diff --git a/src/wayland/dmabuf/mod.rs b/src/wayland/dmabuf/mod.rs index 9892a30..6184e83 100644 --- a/src/wayland/dmabuf/mod.rs +++ b/src/wayland/dmabuf/mod.rs @@ -13,7 +13,7 @@ //! //! The list of supported format is just a `Vec`, where you will enter all the (code, modifier) //! couples you support. You can typically receive a list of supported formats for one renderer by calling -//! [`crate::backend::renderer::Renderer::dmabuf_formats`]. +//! [`crate::backend::renderer::ImportDma::dmabuf_formats`]. //! //! ``` //! # extern crate wayland_server;