VkOpticalFlowExecuteInfoNV(3)

# VkOpticalFlowExecuteInfoNV(3) Manual Page

## Name

VkOpticalFlowExecuteInfoNV - Structure specifying parameters of a optical flow vector calculation

Loading… please wait.

## C Specification

The VkOpticalFlowExecuteInfoNV structure is defined as:

    // Provided by VK_NV_optical_flow
    typedef struct VkOpticalFlowExecuteInfoNV {
        VkStructureType                sType;
        void*                          pNext;
        VkOpticalFlowExecuteFlagsNV    flags;
        uint32_t                       regionCount;
        const VkRect2D*                pRegions;
    } VkOpticalFlowExecuteInfoNV;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `flags` are the VkOpticalFlowExecuteFlagsNV used for this command.

- `regionCount` is the number of regions of interest specified in `pRegions`.

- `pRegions` is a pointer to `regionCount` `VkRect2D` regions of interest.

## Description

Valid Usage

- VUID-VkOpticalFlowExecuteInfoNV-regionCount-07593
  `regionCount` must be 0 if `VK_OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV` was not set for `VkOpticalFlowSessionNV` on which this command is operating

Valid Usage (Implicit)

- VUID-VkOpticalFlowExecuteInfoNV-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV`

- VUID-VkOpticalFlowExecuteInfoNV-pNext-pNext
  `pNext` must be `NULL`

- VUID-VkOpticalFlowExecuteInfoNV-flags-parameter
  `flags` must be a valid combination of VkOpticalFlowExecuteFlagBitsNV values

- VUID-VkOpticalFlowExecuteInfoNV-pRegions-parameter
  If `regionCount` is not `0`, `pRegions` must be a valid pointer to an array of `regionCount` VkRect2D structures

## See Also

VK_NV_optical_flow, VkOpticalFlowExecuteFlagsNV, VkRect2D, VkStructureType, vkCmdOpticalFlowExecuteNV

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

SPDX-License-Identifier: CC-BY-4.0