C Specification

To bind a vulkan image to an optical flow session object, call:

// Provided by VK_NV_optical_flow
VkResult vkBindOpticalFlowSessionImageNV(
    VkDevice                                    device,
    VkOpticalFlowSessionNV                      session,
    VkOpticalFlowSessionBindingPointNV          bindingPoint,
    VkImageView                                 view,
    VkImageLayout                               layout);

Parameters

  • device is the device which owns the optical flow session object session.

  • session is the optical flow session object to which the image view is to be bound.

  • bindingPoint specifies the binding point VkOpticalFlowSessionBindingPointNV to which the image view is bound.

  • view is a VkImageView to be bound.

  • layout must specify the layout that the image subresources accessible from view will be in at the time the optical flow vectors are calculated with vkCmdOpticalFlowExecuteNV on a VkDevice.

Description

Valid Usage (Implicit)
  • VUID-vkBindOpticalFlowSessionImageNV-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkBindOpticalFlowSessionImageNV-session-parameter
    session must be a valid VkOpticalFlowSessionNV handle

  • VUID-vkBindOpticalFlowSessionImageNV-bindingPoint-parameter
    bindingPoint must be a valid VkOpticalFlowSessionBindingPointNV value

  • VUID-vkBindOpticalFlowSessionImageNV-view-parameter
    If view is not VK_NULL_HANDLE, view must be a valid VkImageView handle

  • VUID-vkBindOpticalFlowSessionImageNV-layout-parameter
    layout must be a valid VkImageLayout value

  • VUID-vkBindOpticalFlowSessionImageNV-session-parent
    session must have been created, allocated, or retrieved from device

  • VUID-vkBindOpticalFlowSessionImageNV-view-parent
    If view is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes
On success, this command returns
  • VK_SUCCESS

On failure, this command returns
  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_INITIALIZATION_FAILED

See Also

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 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0