Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Misleading docs for Vulkan profiles

Aperta Adatta ai principianti
  • Qualcosa non va?
#397 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Inizia da chapters/vulkan_profiles.adoc e confronta le istruzioni sui profili personalizzati con il tutorial di Vulkan Profiles collegato nell’issue. Controlla le sezioni indicate per individuare i riferimenti ad API non supportate e verifica nella documentazione di Vulkan Profiles qual è la funzione corretta per controllare il supporto. Aggiorna le istruzioni e i riferimenti inesatti; il lavoro sarà completato quando il capitolo descriverà i flussi di lavoro e le API supportati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Makefile
Stelle
2.3k
Fork
198
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di KhronosGroup/Vulkan-Guide

Tutte le issue di KhronosGroup/Vulkan-Guide

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.