Skip to content

Make links from wgpu-types to wgpu work in docs.rs. #8572

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
+122 −64
Open

Make links from wgpu-types to wgpu work in docs.rs. #8572

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
16 changes: 8 additions & 8 deletions wgpu-types/src/features.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::VertexFormat;
use crate::{link_to_wgpu_docs, link_to_wgpu_item, VertexFormat};
#[cfg(feature = "serde")]
use alloc::fmt;
use alloc::vec::Vec;
Expand Down Expand Up @@ -800,10 +800,10 @@ bitflags_array! {
///
/// This is a native only feature.
///
/// [`RenderPass::multi_draw_indirect`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indirect
/// [`RenderPass::multi_draw_indexed_indirect`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indexed_indirect
/// [`RenderPass::multi_draw_indirect_count`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indirect_count
/// [`RenderPass::multi_draw_indexed_indirect_count`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indexed_indirect_count
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect`"]: "struct.RenderPass.html#method.multi_draw_indirect")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indirect_count")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect_count")]
const MULTI_DRAW_INDIRECT_COUNT = 1 << 15;
/// Allows the use of push constants: small, fast bits of memory that can be updated
/// inside a [`RenderPass`].
Expand All @@ -828,9 +828,9 @@ bitflags_array! {
///
/// This is a native only feature.
///
/// [`RenderPass`]: ../wgpu/struct.RenderPass.html
/// [`PipelineLayoutDescriptor`]: ../wgpu/struct.PipelineLayoutDescriptor.html
/// [`RenderPass::set_push_constants`]: ../wgpu/struct.RenderPass.html#method.set_push_constants
#[doc = link_to_wgpu_item!(struct RenderPass)]
#[doc = link_to_wgpu_item!(struct PipelineLayoutDescriptor)]
#[doc = link_to_wgpu_docs!(["`RenderPass::set_push_constants`"]: "struct.RenderPass.html#method.set_push_constants")]
/// [`Limits::max_push_constant_size`]: super::Limits
const PUSH_CONSTANTS = 1 << 16;
/// Allows the use of [`AddressMode::ClampToBorder`] with a border color
Expand Down
6 changes: 3 additions & 3 deletions wgpu-types/src/instance.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

use alloc::string::String;

use crate::Backends;
use crate::{link_to_wgpu_docs, Backends};

#[cfg(doc)]
use crate::{Backend, DownlevelFlags};
Expand Down Expand Up @@ -165,7 +165,7 @@ bitflags::bitflags! {
/// can be a hassle to do manually. When this is enabled, the timestamp period returned by the queue
/// will always be `1.0`.
///
/// [rqs]: ../wgpu/struct.CommandEncoder.html#method.resolve_query_set
#[doc = link_to_wgpu_docs!(["rqs"]: "struct.CommandEncoder.html#method.resolve_query_set")]
const AUTOMATIC_TIMESTAMP_NORMALIZATION = 1 << 6;
}
}
Expand Down Expand Up @@ -461,7 +461,7 @@ pub enum Dx12SwapchainKind {
/// This supports transparent windows, but does not have support from RenderDoc.
///
/// [`IDCompositionVisual`]: https://learn.microsoft.com/en-us/windows/win32/api/dcomp/nn-dcomp-idcompositionvisual
/// [CV]: ../wgpu/struct.SurfaceTargetUnsafe.html#variant.CompositionVisual
#[doc = link_to_wgpu_docs!(["CV"]: "struct.SurfaceTargetUnsafe.html#variant.CompositionVisual")]
DxgiFromVisual,
}

Expand Down
Loading
Loading