KhronosGroup / KhronosGroup/Vulkan-Docs

Change the way out parameters are defined.

Open
#10 4 comments 0 reactions 0 assignees View on GitHub
Feature Request Registry
Dominant language
JavaScript
Stars
3.3k
Forks
549
Avg merge
5d 5h
Merged PRs (30d)
2

Description

The creation, allocation and capability-query functions use out parameters to return the created/allocated object (and the actual return value for errors). However not all languages support this and automatically mapping the pointer arguments to return values can be tricky.

Instead marking them explicitly will make it clearer where the result goes.

``` xml

VkResult vkCreateInstance
const VkInstanceCreateInfo* pCreateInfo
const VkAllocationCallbacks* pAllocator
VkInstance* pInstance


VkResult vkEnumeratePhysicalDevices
VkInstance instance
uint32_t* pPhysicalDeviceCount
VkPhysicalDevice* pPhysicalDevices

```

Contributor guide

Open the contributing guide

Research direction

Review the XML command definitions for creation, allocation, and capability-query functions, starting with the vkCreateInstance and vkEnumeratePhysicalDevices examples in the issue. Trace how their parameters are consumed and mapped, then verify that the affected definitions explicitly identify returned objects and error results across the relevant commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.