Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Misleading docs for Vulkan profiles

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#397 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với chapters/vulkan_profiles.adoc và so sánh hướng dẫn về hồ sơ tùy chỉnh với hướng dẫn Vulkan Profiles được liên kết trong issue. Kiểm tra các mục được nêu để tìm những tham chiếu API không được hỗ trợ và xác minh hàm kiểm tra hỗ trợ phù hợp theo tài liệu Vulkan Profiles. Cập nhật các hướng dẫn và tham chiếu không chính xác; hoàn thành khi chương mô tả các quy trình và API được hỗ trợ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The Vulkan guide's chapter on Vulkan Profiles (chapters/vulkan_profiles.adoc) instructs the reader to use several non-existent API tools. I'm not sure if they are outdated or what happened, but I was pretty confused for a while.

Custom profiles:

The docs say to create a profile using a format that does not match Vulkan Profile's actual schema. It then says to "use the profile in your application using either the header-based or JSON-based approach" with the following pseudocode:

// Define a custom profile (typically done offline and saved to a JSON file)
std::string customProfileJson = R"(
{
    "file_format_version": "1.0.0",
    "profiles": {
        "VP_CUSTOM_GAME_PROFILE": {
            "version": 1,
            "api_version": "1.1.0",
            "label": "Custom Game Profile",
            "description": "Profile for our game engine",
            "capabilities": [
                // ... custom capabilities ...
            ]
        }
    }
}
)";

// Load the custom profile
VkpProfilesFileLoader loader;
loader.LoadFromString(customProfileJson);

// Use the custom profile
VkpProfile profile = loader.GetProfile("VP_CUSTOM_GAME_PROFILE");
// ... use the profile as before ...

VkpProfilesFileLoader, LoadFromString, VkpProfile, and GetProfile don't appear to exist in the entire Vulkan SDK other than in this doc. These would be great if they actually existed! The Vulkan Profiles tutorial describes how to generate the library with custom profiles, which is the only way I know of making custom profiles.

The same section also mentions the Vulkan Samples profile sample having examples of custom profiles, which is not true.

Support checks:

The CheckSupport function is referenced in the Automated Feature Enabling, Android Baseline Profile Example, Integration with Existing Applications, and Troubleshooting and Common Issues sections, which should be vpGetPhysicalDeviceProfileSupport.

Capabilities report:

VkpProfileCapabilitiesReport and GetProfileCapabilitiesReport are mentioned in the Troubleshooting and Common Issues section as a way to determine which requirements weren't met. This, unfortunately, doesn't seem to exist either.

Ngôn ngữ chính
Makefile
Star
2.3k
Fork
198
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của KhronosGroup/Vulkan-Guide

Tất cả issue của KhronosGroup/Vulkan-Guide

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.