Skip to content

Commit aa6313e

Browse files
committed
doc: missing docs for wsi module
1 parent 0620d39 commit aa6313e

6 files changed

Lines changed: 11 additions & 4 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "phobos"
3-
version = "0.7.1"
3+
version = "0.7.2"
44
edition = "2021"
55
license = "Apache-2.0"
66
description = "Fast, powerful Vulkan abstraction library"

src/wsi/frame.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
//! This module contains all the logic responsible for managing presentation and frame synchronization. Every frame should be contained
2-
//! in a call to [`FrameManager::new_frame`], which takes in a closure that is called when the frame is ready to be processed.
1+
//! Contains all the logic responsible for managing presentation and frame synchronization.
2+
//!
3+
//! Every frame should be contained in a call to [`FrameManager::new_frame`], which takes in a closure that is called when the frame is ready to be processed.
34
//! This also gives you an [`InFlightContext`] object which contains useful data relevant to the current frame's execution context,
45
//! such as per-frame allocators and a view to the current swapchain image.
56
//!

src/wsi/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! The wsi module provides utilities for interacting with the window and rendering frames.
1+
//! Provides utilities for interacting with the window and rendering frames.
22
//! If you are using a headless context, you can largely ignore this module.
33
44
pub mod frame;

src/wsi/surface.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Wrappers around a `VkSurfaceKHR`
2+
13
use std::ops::Deref;
24

35
use anyhow::Result;

src/wsi/swapchain.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Wrappers around a `VkSwapchainKHR`
2+
13
use std::ops::Deref;
24

35
use anyhow::Result;

src/wsi/window.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Utilities for generic window handling
2+
13
use raw_window_handle::{HasRawDisplayHandle, HasRawWindowHandle, RawDisplayHandle, RawWindowHandle};
24
#[cfg(feature = "winit")]
35
use winit;

0 commit comments

Comments
 (0)