Skip to content
New issue

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

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

Already on GitHub? # to your account

Update Khronos URLs #1986

Merged
merged 1 commit into from
Sep 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion vulkano/autogen/extensions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ fn extensions_members(ty: &str, extensions: &IndexMap<&str, &Extension>) -> Vec<

fn make_doc(ext: &mut ExtensionsMember) {
let writer = &mut ext.doc;
write!(writer, "- [Vulkan documentation](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/{}.html)", ext.raw).unwrap();
write!(writer, "- [Vulkan documentation](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/{}.html)", ext.raw).unwrap();

if ext.required_if_supported {
write!(
Expand Down
2 changes: 1 addition & 1 deletion vulkano/autogen/features.rs
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ fn features_members(types: &HashMap<&str, (&Type, Vec<&str>)>) -> Vec<FeaturesMe

fn make_doc(feat: &mut FeaturesMember, vulkan_ty_name: &str) {
let writer = &mut feat.doc;
write!(writer, "- [Vulkan documentation](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/{}.html#features-{})", vulkan_ty_name, feat.name).unwrap();
write!(writer, "- [Vulkan documentation](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/{}.html#features-{})", vulkan_ty_name, feat.name).unwrap();

if !feat.requires_features.is_empty() {
let links: Vec<_> = feat
Expand Down
2 changes: 1 addition & 1 deletion vulkano/autogen/properties.rs
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ fn properties_members(types: &HashMap<&str, (&Type, Vec<&str>)>) -> Vec<Properti

fn make_doc(prop: &mut PropertiesMember, vulkan_ty_name: &str) {
let writer = &mut prop.doc;
write!(writer, "- [Vulkan documentation](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/{}.html#limits-{})", vulkan_ty_name, prop.name).unwrap();
write!(writer, "- [Vulkan documentation](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/{}.html#limits-{})", vulkan_ty_name, prop.name).unwrap();
}

#[derive(Clone, Debug)]
Expand Down
4 changes: 2 additions & 2 deletions vulkano/src/command_buffer/commands/pipeline.rs
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ impl<L, P> AutoCommandBufferBuilder<L, P> {

/*
Instruction/Sampler/Image View Validation
https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap16.html#textures-input-validation
https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap16.html#textures-input-validation
*/

// The SPIR-V Image Format is not compatible with the image view’s format.
Expand Down Expand Up @@ -784,7 +784,7 @@ impl<L, P> AutoCommandBufferBuilder<L, P> {

/*
Instruction/Sampler/Image View Validation
https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap16.html#textures-input-validation
https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap16.html#textures-input-validation
*/

// - The SPIR-V instruction is one of the OpImage*Dref* instructions and the sampler
Expand Down
8 changes: 4 additions & 4 deletions vulkano/src/command_buffer/commands/transfer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1188,7 +1188,7 @@ impl<L, P> AutoCommandBufferBuilder<L, P> {
});
}

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
let image_subresource_block_size = if image_subresource.aspects.stencil {
1
} else if image_subresource.aspects.depth {
Expand Down Expand Up @@ -1612,7 +1612,7 @@ impl<L, P> AutoCommandBufferBuilder<L, P> {
});
}

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
let image_subresource_block_size = if image_subresource.aspects.stencil {
1
} else if image_subresource.aspects.depth {
Expand Down Expand Up @@ -3451,7 +3451,7 @@ impl Default for BufferImageCopy {

impl BufferImageCopy {
// Following
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap20.html#copies-buffers-images-addressing
// https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap20.html#copies-buffers-images-addressing
pub(crate) fn buffer_copy_size(&self, format: Format) -> DeviceSize {
let &BufferImageCopy {
buffer_offset: _,
Expand Down Expand Up @@ -3493,7 +3493,7 @@ impl BufferImageCopy {
(image_extent[1] as DeviceSize - 1) * buffer_row_length as DeviceSize;
let num_blocks = blocks_to_last_slice + blocks_to_last_row + image_extent[0] as DeviceSize;

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkBufferImageCopy.html#_description
let block_size = if image_subresource.aspects.stencil {
1
} else if image_subresource.aspects.depth {
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/device/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ impl Device {
///
/// To ensure valid usage of the Vulkan API, we cannot call `vkAllocateMemory` when
/// `maxMemoryAllocationCount` has been exceeded. See the Vulkan specs:
/// https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#vkAllocateMemory
/// https://registry.khronos.org/vulkan/specs/1.0/html/vkspec.html#vkAllocateMemory
///
/// Warning: You should never modify this value, except in `device_memory` module
pub(crate) fn allocation_count(&self) -> &Mutex<u32> {
Expand Down
6 changes: 3 additions & 3 deletions vulkano/src/format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
//! you can query a device beforehand for its support by calling `format_properties` on the physical
//! device. You can use this to select a usable format from one or more suitable alternatives.
//! Some formats are required to be always supported for a particular usage. These are listed in the
//! [tables in the Vulkan specification](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap43.html#features-required-format-support).
//! [tables in the Vulkan specification](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap43.html#features-required-format-support).
//!
//! # Special format types
//!
Expand Down Expand Up @@ -171,7 +171,7 @@ impl From<Format> for ash::vk::Format {
}
}

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap46.html#spirvenv-image-formats
// https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap46.html#spirvenv-image-formats
impl From<ImageFormat> for Option<Format> {
fn from(val: ImageFormat) -> Self {
match val {
Expand Down Expand Up @@ -733,7 +733,7 @@ impl Default for FormatProperties {

impl FormatProperties {
/// Returns the potential format features, following the definition of
/// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap43.html#potential-format-features>.
/// <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap43.html#potential-format-features>.
#[inline]
pub fn potential_format_features(&self) -> FormatFeatures {
self.linear_tiling_features | self.optimal_tiling_features
Expand Down
12 changes: 6 additions & 6 deletions vulkano/src/image/sys.rs
Original file line number Diff line number Diff line change
Expand Up @@ -474,11 +474,11 @@ impl UnsafeImage {
/*
Some device limits can be exceeded, but only for particular image configurations, which
must be queried with `image_format_properties`. See:
https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap44.html#capabilities-image
https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap44.html#capabilities-image
First, we check if this is the case, then query the device if so.
*/

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap44.html#features-extentperimagetype
// https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap44.html#features-extentperimagetype
let extent_must_query = || match image_type {
ImageType::Dim1d => {
let limit = device.physical_device().properties().max_image_dimension1_d;
Expand All @@ -500,7 +500,7 @@ impl UnsafeImage {
extent[0] > limit || extent[1] > limit || extent[2] > limit
}
};
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkImageFormatProperties.html
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkImageFormatProperties.html
let mip_levels_must_query = || {
if mip_levels > 1 {
// TODO: for external memory, the spec says:
Expand All @@ -511,7 +511,7 @@ impl UnsafeImage {
false
}
};
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkImageFormatProperties.html
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkImageFormatProperties.html
let array_layers_must_query = || {
if array_layers > device.physical_device().properties().max_image_array_layers {
true
Expand All @@ -521,7 +521,7 @@ impl UnsafeImage {
false
}
};
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap44.html#features-supported-sample-counts
// https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap44.html#features-supported-sample-counts
let samples_must_query = || {
if samples == SampleCount::Sample1 {
return false;
Expand Down Expand Up @@ -614,7 +614,7 @@ impl UnsafeImage {

false
};
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkImageCreateInfo.html#_description
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkImageCreateInfo.html#_description
let linear_must_query = || {
if tiling == ImageTiling::Linear {
!(image_type == ImageType::Dim2d
Expand Down
6 changes: 3 additions & 3 deletions vulkano/src/image/view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ where
*image_inner.format_features()
};

// Per https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap12.html#resources-image-view-format-features
// Per https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap12.html#resources-image-view-format-features
if image_inner
.device()
.enabled_extensions()
Expand Down Expand Up @@ -274,7 +274,7 @@ where

// Get usage
// Can be different from image usage, see
// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkImageViewCreateInfo.html#_description
// https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkImageViewCreateInfo.html#_description
let usage = *image_inner.usage();

// Check for compatibility with the image
Expand Down Expand Up @@ -799,7 +799,7 @@ pub enum ImageViewCreationError {
},

/// The image was not created with
/// [one of the required usages](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#valid-imageview-imageusage)
/// [one of the required usages](https://registry.khronos.org/vulkan/specs/1.2-extensions/html/vkspec.html#valid-imageview-imageusage)
/// for image views.
ImageMissingUsage,

Expand Down
10 changes: 5 additions & 5 deletions vulkano/src/render_pass/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ impl RenderPass {
}

/// Returns `true` if this render pass is compatible with the other render pass,
/// as defined in the [`Render Pass Compatibility` section of the Vulkan specs](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap8.html#renderpass-compatibility).
/// as defined in the [`Render Pass Compatibility` section of the Vulkan specs](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap8.html#renderpass-compatibility).
pub fn is_compatible_with(&self, other: &RenderPass) -> bool {
if self == other {
return true;
Expand Down Expand Up @@ -952,7 +952,7 @@ pub struct AttachmentReference {
///
/// The layout is restricted by the type of attachment that an attachment is being used as. A
/// full listing of allowed layouts per type can be found in
/// [the Vulkan specification](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap8.html#attachment-type-imagelayout).
/// [the Vulkan specification](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap8.html#attachment-type-imagelayout).
///
/// The default value is [`ImageLayout::Undefined`], which must be overridden.
pub layout: ImageLayout,
Expand Down Expand Up @@ -996,11 +996,11 @@ impl Default for AttachmentReference {
/// except that they operate on whole subpasses instead of individual images.
///
/// If `source_subpass` and `destination_subpass` are equal, then this specifies a
/// [subpass self-dependency](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-barriers-subpass-self-dependencies).
/// [subpass self-dependency](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-barriers-subpass-self-dependencies).
/// The `source_stages` must all be
/// [logically earlier in the pipeline](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-stages-order)
/// [logically earlier in the pipeline](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-stages-order)
/// than the `destination_stages`, and if they both contain a
/// [framebuffer-space stage](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-framebuffer-regions),
/// [framebuffer-space stage](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-framebuffer-regions),
/// then `by_region` must be activated.
///
/// If `source_subpass` or `destination_subpass` are set to `None`, this specifies an external
Expand Down
4 changes: 2 additions & 2 deletions vulkano/src/sampler/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ impl Sampler {
/*
Note: Most of these checks come from the Instruction/Sampler/Image View Validation
section, and are not strictly VUIDs.
https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/chap16.html#textures-input-validation
https://registry.khronos.org/vulkan/specs/1.2-extensions/html/chap16.html#textures-input-validation
*/

if self.compare.is_some() {
Expand Down Expand Up @@ -618,7 +618,7 @@ impl Sampler {

// The sampler unnormalizedCoordinates is VK_TRUE and any of the limitations of
// unnormalized coordinates are violated.
// https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/chap13.html#samplers-unnormalizedCoordinates
// https://registry.khronos.org/vulkan/specs/1.2-extensions/html/chap13.html#samplers-unnormalizedCoordinates
if self.unnormalized_coordinates {
// The viewType must be either VK_IMAGE_VIEW_TYPE_1D or
// VK_IMAGE_VIEW_TYPE_2D.
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/sampler/ycbcr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ pub struct SamplerYcbcrConversionCreateInfo {

/// Forces explicit reconstruction if the implementation does not use it by default. The format
/// must support it. See
/// [the spec](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/chap16.html#textures-chroma-reconstruction)
/// [the spec](https://registry.khronos.org/vulkan/specs/1.2-extensions/html/chap16.html#textures-chroma-reconstruction)
/// for more information.
///
/// The default value is `false`.
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/shader/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,7 @@ pub enum ShaderScalarType {
Uint,
}

// https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap43.html#formats-numericformat
// https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap43.html#formats-numericformat
impl From<NumericType> for ShaderScalarType {
fn from(val: NumericType) -> Self {
match val {
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/shader/spirv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
//! validation, but you should not assume that code that is read successfully is valid.
//!
//! For more information about SPIR-V modules, instructions and types, see the
//! [SPIR-V specification](https://www.khronos.org/registry/SPIR-V/specs/unified1/SPIRV.html).
//! [SPIR-V specification](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html).

use crate::Version;
use std::{
Expand Down
2 changes: 1 addition & 1 deletion vulkano/src/sync/pipeline.rs
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ impl PipelineStages {
/// Returns the access types that are supported with the given pipeline stages.
///
/// Corresponds to the table
/// "[Supported access types](https://www.khronos.org/registry/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-access-types-supported)"
/// "[Supported access types](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-access-types-supported)"
/// in the Vulkan specification.
#[inline]
pub fn supported_access(&self) -> AccessFlags {
Expand Down