vkUnregisterObjectsNVX(3)

# vkUnregisterObjectsNVX(3) Manual Page

## Name

vkUnregisterObjectsNVX - Unregister resource bindings in an object table

## C Specification

Use the following command to unregister resources from an object table:

    VkResult vkUnregisterObjectsNVX(
        VkDevice                                    device,
        VkObjectTableNVX                            objectTable,
        uint32_t                                    objectCount,
        const VkObjectEntryTypeNVX*                 pObjectEntryTypes,
        const uint32_t*                             pObjectIndices);

## Parameters

- `device` is the logical device that creates the object table.

- `objectTable` is the table from which the resources are unregistered.

- `objectCount` is the number of resources being removed from the object table.

- `pObjectEntryType` provides an array of VkObjectEntryTypeNVX for the resources being removed.

- `pObjectIndices` provides the array of object indices to be removed.

## Description

Valid Usage

- At any `pObjectIndices` there must be a registered resource already.

- The `pObjectEntryTypes` of the resource at `pObjectIndices` must match.

- All operations on the device using the registered resource must have been completed.

Valid Usage (Implicit)

- `device` must be a valid `VkDevice` handle

- `objectTable` must be a valid `VkObjectTableNVX` handle

- `pObjectEntryTypes` must be a valid pointer to an array of `objectCount` valid VkObjectEntryTypeNVX values

- `pObjectIndices` must be a valid pointer to an array of `objectCount` `uint32_t` values

- `objectCount` must be greater than `0`

- `objectTable` must have been created, allocated, or retrieved from `device`

Host Synchronization

- Host access to `objectTable` must be externally synchronized

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

## See Also

VkDevice, VkObjectEntryTypeNVX, VkObjectTableNVX

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.