Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken doc links #2578

Merged
merged 1 commit into from
Oct 16, 2024
+14 −7
Merged

Fix broken doc links #2578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions vulkano/src/memory/allocator/suballocator/buddy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,10 @@ use std::cmp;
/// [suballocator]: Suballocator
/// [internal fragmentation]: super#internal-fragmentation
/// [external fragmentation]: super#external-fragmentation
/// [`FreeListAllocator`]: super::FreeListAllocator
/// [the `Suballocator` implementation]: Suballocator#impl-Suballocator-for-Arc<BuddyAllocator>
/// [region]: Suballocator#regions
/// [`BumpAllocator`]: super::BumpAllocator
#[derive(Debug)]
pub struct BuddyAllocator {
region_offset: DeviceSize,
Expand Down
1 change: 1 addition & 0 deletions vulkano/src/memory/allocator/suballocator/bump.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ use std::iter::FusedIterator;
/// Allocation is *O*(1), and so is resetting the allocator (freeing all allocations).
///
/// [suballocator]: Suballocator
/// [`FreeListAllocator`]: super::FreeListAllocator
/// [the `Suballocator` implementation]: Suballocator#impl-Suballocator-for-Arc<BumpAllocator>
/// [region]: Suballocator#regions
/// [free-list]: Suballocator#free-lists
Expand Down
2 changes: 2 additions & 0 deletions vulkano/src/memory/allocator/suballocator/free_list.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ use std::{cmp, iter::FusedIterator, marker::PhantomData, ptr::NonNull};
/// [suballocator]: Suballocator
/// [free-list]: Suballocator#free-lists
/// [external fragmentation]: super#external-fragmentation
/// [`BuddyAllocator`]: super::BuddyAllocator
/// [`BumpAllocator`]: super::BumpAllocator
/// [the `Suballocator` implementation]: Suballocator#impl-Suballocator-for-Arc<FreeListAllocator>
/// [internal fragmentation]: super#internal-fragmentation
/// [alignment requirements]: super#alignment
Expand Down
8 changes: 5 additions & 3 deletions vulkano/src/memory/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ impl ResourceMemory {
///
/// - Two resources must not alias each other, and if they do, you must ensure correct
/// synchronization yourself.
///
/// [`new_dedicated`]: Self::new_dedicated
pub unsafe fn new_dedicated_unchecked(device_memory: Arc<DeviceMemory>) -> Self {
let size = device_memory.allocation_size();

Expand All @@ -166,9 +168,9 @@ impl ResourceMemory {
///
/// # Safety
///
/// - Two resources must not alias each other (as returned by [`Buffer::memory_requirements`]
/// or [`Image::memory_requirements`]), and if they do, you must ensure correct
/// synchronization yourself.
/// - Two resources must not alias each other (as returned by
/// [`RawBuffer::memory_requirements`] or [`RawImage::memory_requirements`]), and if they do,
/// you must ensure correct synchronization yourself.
///
/// # Panics
///
Expand Down
4 changes: 2 additions & 2 deletions vulkano/src/pipeline/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,7 +731,7 @@ vulkan_enum! {
]), */

/// The value of
/// [`ConservativeRasterizationState::mode`](crate::pipeline::graphics::conservative_rasterization::ConservativeRasterizationState::mode)
/// [`ConservativeRasterizationState::mode`](crate::pipeline::graphics::rasterization::RasterizationConservativeState::mode)
///
/// Set with
/// [`set_conservative_rasterization_mode`](crate::command_buffer::RecordingCommandBuffer::set_conservative_rasterization_mode).
Expand All @@ -741,7 +741,7 @@ vulkan_enum! {
]),

/// The value of
/// [`ConservativeRasterizationState::overestimation_size`](crate::pipeline::graphics::conservative_rasterization::ConservativeRasterizationState::overestimation_size)
/// [`ConservativeRasterizationState::overestimation_size`](crate::pipeline::graphics::rasterization::RasterizationConservativeState::overestimation_size)
///
/// Set with
/// [`set_extra_primitive_overestimation_size`](crate::command_buffer::RecordingCommandBuffer::set_extra_primitive_overestimation_size).
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/query.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ impl QueryPool {
/// - There must be no calls to `reset*` or `get_results*` executing concurrently on another
/// thread.
///
/// [`host_query_reset`]: Features::host_query_reset
/// [`host_query_reset`]: crate::device::DeviceFeatures::host_query_reset
#[inline]
pub unsafe fn reset(&self, range: Range<u32>) -> Result<(), Box<ValidationError>> {
self.validate_reset(range.clone())?;
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/shader/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@
//! ## Mesh shading
//!
//! - If the shader declares the `OutputPoints` execution mode with a value greater than 0, and the
//! [`maintenance5`](Features::maintenance5) feature is not enabled on the device, then the
//! [`maintenance5`](DeviceFeatures::maintenance5) feature is not enabled on the device, then the
//! shader must write to a variable decorated with `PointSize` for each output point.
//! <sup>[\[09218\]]</sup>
//!
Expand Down