Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_NV_optical_flow

Name

VK_NV_optical_flow - device extension

VK_NV_optical_flow

Name String: VK_NV_optical_flow

Extension Type: Device extension
Registered Extension Number: 465
Revision: 1
Ratification Status: Not ratified
Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or

Vulkan Version 1.1 and

VK_KHR_format_feature_flags2 and

VK_KHR_synchronization2 or Vulkan Version 1.3

Contact

Carsten Rohde @crohde%0A*Here describe the issue or question you have about the VK_NV_optical_flow extension*

Other Extension Metadata

Last Modified Date: 2022-09-26

Contributors

Carsten Rohde, NVIDIA
Vipul Parashar, NVIDIA
Jeff Bolz, NVIDIA
Eric Werness, NVIDIA

Description

Optical flow are fundamental algorithms in computer vision (CV) area. This extension allows applications to estimate 2D displacement of pixels between two frames.

This extension is designed to be used with upcoming NVIDIA Optical Flow SDK Version 5 which will be available on NVIDIA Developer webpage.

Examples

// Example querying available input formats
VkOpticalFlowImageFormatInfoNV ofFormatInfo = { VK_STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV };
ofFormatInfo.usage = VK_OPTICAL_FLOW_USAGE_INPUT_BIT_NV;

uint32_t count = 0;
vkGetPhysicalDeviceOpticalFlowImageFormatsNV(physicalDevice, &ofFormatInfo, &count, NULL);
VkOpticalFlowImageFormatPropertiesNV* fmt = new VkOpticalFlowImageFormatPropertiesNV[count];
memset(fmt, 0, count  * sizeof(VkOpticalFlowImageFormatPropertiesNV));
for (uint32_t i = 0; i < count; i++) {
    fmt[i].sType = VK_STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_PROPERTIES_NV;
}
vkGetPhysicalDeviceOpticalFlowImageFormatsNV(physicalDevice, &ofFormatInfo, &count, fmt);

// Pick one of the available formats
VkFormat inputFormat = fmt[0].format;

// Check feature support for optimal tiling
VkFormatProperties3 formatProperties3 = { VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3 };
VkFormatProperties2 formatProperties2 = { VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, &formatProperties3 };
vkGetPhysicalDeviceFormatProperties2(physicalDevice, inputFormat, &formatProperties2);
if (!(formatProperties3.optimalTilingFeatures & VK_FORMAT_FEATURE_2_OPTICAL_FLOW_IMAGE_BIT_NV)) {
    return false;
}

// Check support for image creation parameters
VkPhysicalDeviceImageFormatInfo2 imageFormatInfo2 = { VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2, &ofFormatInfo };
imageFormatInfo2.format = inputFormat;
imageFormatInfo2.type = VK_IMAGE_TYPE_2D;
imageFormatInfo2.tiling = VK_IMAGE_TILING_OPTIMAL;
imageFormatInfo2.usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;

VkImageFormatProperties2 imageFormatProperties2 = { VK_STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2 };
if (vkGetPhysicalDeviceImageFormatProperties2(physicalDevice, &imageFormatInfo2, &imageFormatProperties2) != VK_SUCCESS) {
    return false;
}

VkImageCreateInfo imageCreateInfo = { VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, &ofFormatInfo };
imageCreateInfo.imageType = VK_IMAGE_TYPE_2D;
imageCreateInfo.format = inputFormat;
imageCreateInfo.extent = { width, height, (uint32_t)1};
imageCreateInfo.mipLevels = 1;
imageCreateInfo.arrayLayers = 1;
imageCreateInfo.samples = VK_SAMPLE_COUNT_1_BIT;
imageCreateInfo.usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
imageCreateInfo.tiling = VK_IMAGE_TILING_OPTIMAL;

vkCreateImage(device, &imageCreateInfo, NULL, &input);
"allocate memory, bind image, create view"

"do the same for reference and output"

// Create optical flow session
VkOpticalFlowSessionCreateInfoNV sessionCreateInfo = { VK_STRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_INFO_NV };
sessionCreateInfo.width = width;
sessionCreateInfo.height = height;
sessionCreateInfo.imageFormat = inputFormat;
sessionCreateInfo.flowVectorFormat = outputFormat;
sessionCreateInfo.outputGridSize = VK_OPTICAL_FLOW_GRID_SIZE_4X4_BIT_NV;
sessionCreateInfo.performanceLevel = VK_OPTICAL_FLOW_PERFORMANCE_LEVEL_SLOW_NV;
VkOpticalFlowSessionNV session;
vkCreateOpticalFlowSessionNV(device, &sessionCreateInfo, NULL, &session);

"allocate command buffer"

"transfer images to VK_PIPELINE_STAGE_2_OPTICAL_FLOW_BIT_NV"
"transfer input images to VK_ACCESS_2_OPTICAL_FLOW_READ_BIT_NV and output image to VK_ACCESS_2_OPTICAL_FLOW_WRITE_BIT_NV"

vkBindOpticalFlowSessionImageNV(device, session, VK_OPTICAL_FLOW_SESSION_BINDING_POINT_INPUT_NV, inputView, VK_IMAGE_LAYOUT_GENERAL);
vkBindOpticalFlowSessionImageNV(device, session, VK_OPTICAL_FLOW_SESSION_BINDING_POINT_REFERENCE_NV, refView, VK_IMAGE_LAYOUT_GENERAL);
vkBindOpticalFlowSessionImageNV(device, session, VK_OPTICAL_FLOW_SESSION_BINDING_POINT_FLOW_VECTOR_NV, outputView, VK_IMAGE_LAYOUT_GENERAL);

VkOpticalFlowExecuteInfoNV opticalFlowExecuteInfo = { VK_STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV };
vkCmdOpticalFlowExecuteNV(cmd, session, &opticalFlowExecuteInfo);

"submit command buffer"

Version History

Revision 1, 2022-09-26 (Carsten Rohde)
- Internal revisions

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

20 types
6 values

Packagevulkan-3.27
Exports59
LanguageGHC2021
LicenceBSD-3-Clause
SourceVK_NV_optical_flow.hs

valuegetPhysicalDeviceOpticalFlowImageFormatsNV

:: MonadIO io
=> PhysicalDevice
physicalDevice is the physical device being queried.
-> OpticalFlowImageFormatInfoNV
pOpticalFlowImageFormatInfo is a pointer to a OpticalFlowImageFormatInfoNV structure specifying the optical flow usage for which information is returned.
-> io (Result, "imageFormatProperties" ::: Vector OpticalFlowImageFormatPropertiesNV)

vkGetPhysicalDeviceOpticalFlowImageFormatsNV - Query image formats for optical flow

Description

If pImageFormatProperties is NULL, then the number of optical flow properties supported for the given physicalDevice is returned in pFormatCount. Otherwise, pFormatCount must point to a variable set by the application to the number of elements in the pImageFormatProperties array, and on return the variable is overwritten with the number of values actually written to pImageFormatProperties. If the value of pFormatCount is less than the number of optical flow properties supported, at most pFormatCount values will be written to pImageFormatProperties, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available values were returned.

Before creating an image to be used as an optical flow frame, obtain the supported image creation parameters by querying with getPhysicalDeviceFormatProperties2 and getPhysicalDeviceImageFormatProperties2 using one of the reported formats and adding OpticalFlowImageFormatInfoNV to the pNext chain of PhysicalDeviceImageFormatInfo2.

When querying the parameters with getPhysicalDeviceImageFormatProperties2 for images used for optical flow operations, the OpticalFlowImageFormatInfoNV::usage field must contain one or more of the bits defined in OpticalFlowUsageFlagBitsNV.

Valid Usage (Implicit)

physicalDevice must be a valid PhysicalDevice handle

pOpticalFlowImageFormatInfo must be a valid pointer to a valid OpticalFlowImageFormatInfoNV structure
pFormatCount must be a valid pointer to a uint32_t value
If the value referenced by pFormatCount is not 0, and pImageFormatProperties is not NULL, pImageFormatProperties must be a valid pointer to an array of pFormatCount OpticalFlowImageFormatPropertiesNV structures

Return Codes

Success

Failure

FORMAT_B8G8R8A8_UNORM, FORMAT_R8_UNORM and FORMAT_G8_B8R8_2PLANE_420_UNORM are initially supported for images with optical usage OPTICAL_FLOW_USAGE_INPUT_BIT_NV.

FORMAT_R16G16_SFIXED5_NV is initially supported for images with optical flow usage OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV, OPTICAL_FLOW_USAGE_HINT_BIT_NV and OPTICAL_FLOW_USAGE_GLOBAL_FLOW_BIT_NV.

FORMAT_R8_UINT and FORMAT_R32_UINT are initially supported for images with optical flow usage OPTICAL_FLOW_USAGE_COST_BIT_NV. It is recommended to use FORMAT_R8_UINT because of the lower bandwidth.

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	VK_QUEUE_OPTICAL_FLOW_BIT_NV	Action

Members

This structure describes the following feature:

Description

If the PhysicalDeviceOpticalFlowFeaturesNV structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceOpticalFlowFeaturesNV, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

Constructors

PhysicalDeviceOpticalFlowFeaturesNV
- opticalFlow :: Bool
  opticalFlow indicates whether the implementation supports optical flow.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero PhysicalDeviceOpticalFlowFeaturesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata PhysicalDeviceOpticalFlowPropertiesNV

VkPhysicalDeviceOpticalFlowPropertiesNV - Structure describing properties supported by VK_NV_optical_flow

Description

If the PhysicalDeviceOpticalFlowPropertiesNV structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Structure Chaining

Extends the structure

PhysicalDeviceProperties2

Constructors

PhysicalDeviceOpticalFlowPropertiesNV
- supportedOutputGridSizes :: OpticalFlowGridSizeFlagsNV
  supportedOutputGridSizes are the supported OpticalFlowGridSizeFlagsNV which can be specified in OpticalFlowSessionCreateInfoNV::outputGridSize.
- supportedHintGridSizes :: OpticalFlowGridSizeFlagsNV
  supportedHintGridSizes are the supported OpticalFlowGridSizeFlagsNV which can be specified in OpticalFlowSessionCreateInfoNV::hintGridSize.
- hintSupported :: Bool
  hintSupported is a boolean describing whether using hint flow vector map is supported in an optical flow session.
- costSupported :: Bool
  costSupported is a boolean describing whether cost map generation is supported in an optical flow session.
- bidirectionalFlowSupported :: Bool
  bidirectionalFlowSupported is a boolean describing whether bi-directional flow generation is supported in an optical flow session.
- globalFlowSupported :: Bool
  globalFlowSupported is a boolean describing whether global flow vector map generation is supported in an optical flow session.
- minWidth :: Word32
  minWidth is the minimum width in pixels for images used in an optical flow session.
- minHeight :: Word32
  minHeight is the minimum height in pixels for images used in an optical flow session.
- maxWidth :: Word32
  maxWidth is the maximum width in pixels for images used in an optical flow session.
- maxHeight :: Word32
  maxHeight is the maximum height in pixels for images used in an optical flow session.
- maxNumRegionsOfInterest :: Word32
  maxNumRegionsOfInterest is the maximum number of regions of interest which can be used in an optical flow session. If this maxNumRegionsOfInterest is 0, regions of interest are not supported in an optical flow session.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero PhysicalDeviceOpticalFlowPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata OpticalFlowImageFormatInfoNV

VkOpticalFlowImageFormatInfoNV - Structure describing optical flow image format info

Structure Chaining

Extends the structures

Constructors

OpticalFlowImageFormatInfoNV
- usage :: OpticalFlowUsageFlagsNV
  usage is a bitmask of OpticalFlowUsageFlagBitsNV describing the intended optical flow usage of the image.
  usage must be a valid combination of OpticalFlowUsageFlagBitsNV values
  usage must not be 0

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowImageFormatInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata OpticalFlowImageFormatPropertiesNV

VkOpticalFlowImageFormatPropertiesNV - Structure describing properties of an optical flow image format

Valid Usage (Implicit)

Constructors

OpticalFlowImageFormatPropertiesNV
- format :: Format
  format is a Format that specifies the format that can be used with the specified optical flow image usages.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowImageFormatPropertiesNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata OpticalFlowSessionCreateInfoNV (es :: [Type])

VkOpticalFlowSessionCreateInfoNV - Structure specifying parameters of a newly created optical flow session

Valid Usage

width must be greater than or equal to PhysicalDeviceOpticalFlowPropertiesNV::minWidth and less than or equal to PhysicalDeviceOpticalFlowPropertiesNV::maxWidth

height must be greater than or equal to PhysicalDeviceOpticalFlowPropertiesNV::minHeight and less than or equal to PhysicalDeviceOpticalFlowPropertiesNV::maxHeight
imageFormat must be one of the formats returned by getPhysicalDeviceOpticalFlowImageFormatsNV for OPTICAL_FLOW_USAGE_INPUT_BIT_NV
flowVectorFormat must be one of the formats returned by getPhysicalDeviceOpticalFlowImageFormatsNV for OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV
costFormat must be one of the formats returned by getPhysicalDeviceOpticalFlowImageFormatsNV for OPTICAL_FLOW_USAGE_COST_BIT_NV if OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV is set in flags
outputGridSize must be exactly one of the bits reported in PhysicalDeviceOpticalFlowPropertiesNV::supportedOutputGridSizes
hintGridSize must be exactly one of the bits reported in PhysicalDeviceOpticalFlowPropertiesNV::supportedHintGridSizes if OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV is set in flags
OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV must not be set in flags if PhysicalDeviceOpticalFlowPropertiesNV::hintSupported is FALSE
OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV must not be set in flags if PhysicalDeviceOpticalFlowPropertiesNV::costSupported is FALSE
OPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NV must not be set in flags if PhysicalDeviceOpticalFlowPropertiesNV::globalFlowSupported is FALSE
OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV must not be set in flags if PhysicalDeviceOpticalFlowPropertiesNV::maxNumRegionsOfInterest is 0
OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV must not be set in flags if PhysicalDeviceOpticalFlowPropertiesNV::bidirectionalFlowSupported is FALSE

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_INFO_NV

pNext must be NULL or a pointer to a valid instance of OpticalFlowSessionCreatePrivateDataInfoNV
The sType value of each structure in the pNext chain must be unique
imageFormat must be a valid Format value
flowVectorFormat must be a valid Format value
If costFormat is not 0, costFormat must be a valid Format value
outputGridSize must be a valid combination of OpticalFlowGridSizeFlagBitsNV values
outputGridSize must not be 0
hintGridSize must be a valid combination of OpticalFlowGridSizeFlagBitsNV values
If performanceLevel is not 0, performanceLevel must be a valid OpticalFlowPerformanceLevelNV value
flags must be a valid combination of OpticalFlowSessionCreateFlagBitsNV values

Constructors

OpticalFlowSessionCreateInfoNV
- next :: Chain es
  pNext is NULL or a pointer to a structure extending this structure.
- width :: Word32
  width is the width in pixels of the input or reference frame to be bound to this optical flow session.
- height :: Word32
  height is the height in pixels of the input or reference frame to be bound to this optical flow session.
- imageFormat :: Format
  imageFormat is the Format of the input and reference frame to be bound to this optical flow session.
- flowVectorFormat :: Format
  flowVectorFormat is the Format of the flow vector maps (output or hint) to be bound to this optical flow session.
- costFormat :: Format
  costFormat is the Format of the cost maps to be bound to this optical flow session.
- outputGridSize :: OpticalFlowGridSizeFlagsNV
  outputGridSize is exactly one bit of OpticalFlowGridSizeFlagsNV specifying the grid size of the output flow and cost maps to be bound to this optical flow session. The size of the output flow and cost maps is determined by OpticalFlowSessionCreateInfoNV::width and OpticalFlowSessionCreateInfoNV::height divided by OpticalFlowSessionCreateInfoNV::outputGridSize.
- hintGridSize :: OpticalFlowGridSizeFlagsNV
  hintGridSize is one exactly bit of OpticalFlowGridSizeFlagsNV specifying the grid size of the hint flow vector maps to be bound to this optical flow session. The size of the hint maps is determined by OpticalFlowSessionCreateInfoNV::width and OpticalFlowSessionCreateInfoNV::height divided by OpticalFlowSessionCreateInfoNV::hintGridSize.
- performanceLevel :: OpticalFlowPerformanceLevelNV
  performanceLevel is the OpticalFlowPerformanceLevelNV used for this optical flow session.
- flags :: OpticalFlowSessionCreateFlagsNV
  flags are the OpticalFlowSessionCreateFlagsNV used for this optical flow session.

Instances5Extensible, Show, FromCStruct, ToCStruct, Zero

Extensible OpticalFlowSessionCreateInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show (Chain es) => Show (OpticalFlowSessionCreateInfoNV es)Defined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
(Extendss OpticalFlowSessionCreateInfoNV es, PeekChain es) => FromCStruct (OpticalFlowSessionCreateInfoNV es)Defined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
(Extendss OpticalFlowSessionCreateInfoNV es, PokeChain es) => ToCStruct (OpticalFlowSessionCreateInfoNV es)Defined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
es ~ '[] => Zero (OpticalFlowSessionCreateInfoNV es)Defined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata OpticalFlowSessionCreatePrivateDataInfoNV

VkOpticalFlowSessionCreatePrivateDataInfoNV - Structure for NV internal use only

Structure Chaining

Extends the structure

OpticalFlowSessionCreateInfoNV

Constructors

OpticalFlowSessionCreatePrivateDataInfoNV
- id' :: Word32
  id is an identifier for data which is passed at a memory location specified in OpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.
- size :: Word32
  size is the size of data in bytes which is passed at a memory location specified in OpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.
- privateData :: Ptr ()
  pPrivateData is a pointer to NV internal data.
  pPrivateData must be a pointer value

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show OpticalFlowSessionCreatePrivateDataInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowSessionCreatePrivateDataInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct OpticalFlowSessionCreatePrivateDataInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct OpticalFlowSessionCreatePrivateDataInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowSessionCreatePrivateDataInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

datadata OpticalFlowExecuteInfoNV

VkOpticalFlowExecuteInfoNV - Structure specifying parameters of an optical flow vector calculation

Valid Usage

regionCount must be 0 if OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV was not set for OpticalFlowSessionNV on which this command is operating

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV

pNext must be NULL
flags must be a valid combination of OpticalFlowExecuteFlagBitsNV values
If regionCount is not 0, pRegions must be a valid pointer to an array of regionCount Rect2D structures

Constructors

OpticalFlowExecuteInfoNV
- flags :: OpticalFlowExecuteFlagsNV
  flags are the OpticalFlowExecuteFlagsNV used for this command.
- regions :: Vector Rect2D
  pRegions is a pointer to regionCount Rect2D regions of interest.

Instances4Show, FromCStruct, ToCStruct, Zero

Show OpticalFlowExecuteInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FromCStruct OpticalFlowExecuteInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
ToCStruct OpticalFlowExecuteInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowExecuteInfoNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

typetype OpticalFlowGridSizeFlagsNV = OpticalFlowGridSizeFlagBitsNV

newtypenewtype OpticalFlowGridSizeFlagBitsNV

VkOpticalFlowGridSizeFlagBitsNV - Bits specifying grid sizes for optical flow operations

Description

OPTICAL_FLOW_GRID_SIZE_1X1_BIT_NV specifies that grid is 1x1 pixel.

OPTICAL_FLOW_GRID_SIZE_2X2_BIT_NV specifies that grid is 2x2 pixel.
OPTICAL_FLOW_GRID_SIZE_4X4_BIT_NV specifies that grid is 4x4 pixel.
OPTICAL_FLOW_GRID_SIZE_8X8_BIT_NV specifies that grid is 8x8 pixel.

Constructors

OpticalFlowGridSizeFlagBitsNV Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Bits OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FiniteBits OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowGridSizeFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_GRID_SIZE_UNKNOWN_NV :: OpticalFlowGridSizeFlagBitsNV

patternpattern OPTICAL_FLOW_GRID_SIZE_1X1_BIT_NV :: OpticalFlowGridSizeFlagBitsNV

patternpattern OPTICAL_FLOW_GRID_SIZE_2X2_BIT_NV :: OpticalFlowGridSizeFlagBitsNV

patternpattern OPTICAL_FLOW_GRID_SIZE_4X4_BIT_NV :: OpticalFlowGridSizeFlagBitsNV

patternpattern OPTICAL_FLOW_GRID_SIZE_8X8_BIT_NV :: OpticalFlowGridSizeFlagBitsNV

typetype OpticalFlowUsageFlagsNV = OpticalFlowUsageFlagBitsNV

newtypenewtype OpticalFlowUsageFlagBitsNV

VkOpticalFlowUsageFlagBitsNV - Bits specifying usage for optical flow operations

Description

OPTICAL_FLOW_USAGE_INPUT_BIT_NV specifies that the image can be used as input or reference frame for an optical flow operation.

OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV specifies that the image can be used as output flow vector map for an optical flow operation.
OPTICAL_FLOW_USAGE_HINT_BIT_NV specifies that the image can be used as hint flow vector map for an optical flow operation.
OPTICAL_FLOW_USAGE_COST_BIT_NV specifies that the image can be used as output cost map for an optical flow operation.
OPTICAL_FLOW_USAGE_GLOBAL_FLOW_BIT_NV specifies that the image can be used as global flow vector for an optical flow operation.

Constructors

OpticalFlowUsageFlagBitsNV Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Bits OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FiniteBits OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowUsageFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_USAGE_UNKNOWN_NV :: OpticalFlowUsageFlagBitsNV

patternpattern OPTICAL_FLOW_USAGE_INPUT_BIT_NV :: OpticalFlowUsageFlagBitsNV

patternpattern OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV :: OpticalFlowUsageFlagBitsNV

patternpattern OPTICAL_FLOW_USAGE_HINT_BIT_NV :: OpticalFlowUsageFlagBitsNV

patternpattern OPTICAL_FLOW_USAGE_COST_BIT_NV :: OpticalFlowUsageFlagBitsNV

patternpattern OPTICAL_FLOW_USAGE_GLOBAL_FLOW_BIT_NV :: OpticalFlowUsageFlagBitsNV

newtypenewtype OpticalFlowPerformanceLevelNV

VkOpticalFlowPerformanceLevelNV - Optical flow performance level types

Description

OPTICAL_FLOW_PERFORMANCE_LEVEL_SLOW_NV is a level with slower performance but higher quality.

OPTICAL_FLOW_PERFORMANCE_LEVEL_MEDIUM_NV is a level with medium performance and medium quality.
OPTICAL_FLOW_PERFORMANCE_LEVEL_FAST_NV is a preset with higher performance but lower quality.

Constructors

OpticalFlowPerformanceLevelNV Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowPerformanceLevelNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_PERFORMANCE_LEVEL_UNKNOWN_NV :: OpticalFlowPerformanceLevelNV

patternpattern OPTICAL_FLOW_PERFORMANCE_LEVEL_SLOW_NV :: OpticalFlowPerformanceLevelNV

patternpattern OPTICAL_FLOW_PERFORMANCE_LEVEL_MEDIUM_NV :: OpticalFlowPerformanceLevelNV

patternpattern OPTICAL_FLOW_PERFORMANCE_LEVEL_FAST_NV :: OpticalFlowPerformanceLevelNV

newtypenewtype OpticalFlowSessionBindingPointNV

VkOpticalFlowSessionBindingPointNV - Binding points of an optical flow session

Description

OPTICAL_FLOW_SESSION_BINDING_POINT_INPUT_NV specifies the binding point for the input frame.

OPTICAL_FLOW_SESSION_BINDING_POINT_REFERENCE_NV specifies the binding point for the input reference frame.
OPTICAL_FLOW_SESSION_BINDING_POINT_HINT_NV specifies the binding point for the optional external hint flow vectors.
OPTICAL_FLOW_SESSION_BINDING_POINT_FLOW_VECTOR_NV specifies the binding point for output flow vectors of default forward flow calculation.
OPTICAL_FLOW_SESSION_BINDING_POINT_BACKWARD_FLOW_VECTOR_NV specifies the binding point for the optional output flow vector map of optional backward flow calculation.
OPTICAL_FLOW_SESSION_BINDING_POINT_COST_NV specifies the binding point for the optional output cost map of default forward flow calculation.
OPTICAL_FLOW_SESSION_BINDING_POINT_BACKWARD_COST_NV specifies the binding point for the optional output cost map of optional backward flow calculation.
OPTICAL_FLOW_SESSION_BINDING_POINT_GLOBAL_FLOW_NV specifies the binding point for the optional global flow value of default forward flow calculation.

Constructors

OpticalFlowSessionBindingPointNV Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowSessionBindingPointNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_UNKNOWN_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_INPUT_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_REFERENCE_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_HINT_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_FLOW_VECTOR_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_BACKWARD_FLOW_VECTOR_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_COST_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_BACKWARD_COST_NV :: OpticalFlowSessionBindingPointNV

patternpattern OPTICAL_FLOW_SESSION_BINDING_POINT_GLOBAL_FLOW_NV :: OpticalFlowSessionBindingPointNV

typetype OpticalFlowSessionCreateFlagsNV = OpticalFlowSessionCreateFlagBitsNV

newtypenewtype OpticalFlowSessionCreateFlagBitsNV

VkOpticalFlowSessionCreateFlagBitsNV - Bits specifying flags for optical flow session

Description

OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV specifies that a ImageView with external flow vectors will be used as hints in performing the motion search and must be bound to OPTICAL_FLOW_SESSION_BINDING_POINT_HINT_NV.

OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV specifies that the cost for the forward flow is generated in a ImageView which must be bound to OPTICAL_FLOW_SESSION_BINDING_POINT_COST_NV. Additionally, if OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV is also set, the cost for backward flow is generated in a ImageView which must be bound to OPTICAL_FLOW_SESSION_BINDING_POINT_BACKWARD_COST_NV. The cost is the confidence level of the flow vector for each grid in the frame. The Cost implies how (in)accurate the flow vector is. Higher cost value implies the flow vector to be less accurate and vice-versa.
OPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NV specifies that a global flow vector is estimated from forward flow in a single pixel ImageView which must be bound to OPTICAL_FLOW_SESSION_BINDING_POINT_GLOBAL_FLOW_NV.
OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV specifies that regions of interest can be specified in OpticalFlowExecuteInfoNV.
OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV specifies that backward flow is generated in addition to forward flow which is always generated.

Constructors

OpticalFlowSessionCreateFlagBitsNV Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Bits OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FiniteBits OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowSessionCreateFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV :: OpticalFlowSessionCreateFlagBitsNV

patternpattern OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV :: OpticalFlowSessionCreateFlagBitsNV

patternpattern OPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NV :: OpticalFlowSessionCreateFlagBitsNV

patternpattern OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV :: OpticalFlowSessionCreateFlagBitsNV

patternpattern OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV :: OpticalFlowSessionCreateFlagBitsNV

typetype OpticalFlowExecuteFlagsNV = OpticalFlowExecuteFlagBitsNV

newtypenewtype OpticalFlowExecuteFlagBitsNV

VkOpticalFlowExecuteFlagBitsNV - Bits specifying flags for an optical flow vector calculation

Description

OPTICAL_FLOW_EXECUTE_DISABLE_TEMPORAL_HINTS_BIT_NV specifies that temporal hints from previously generated flow vectors are not used. If temporal hints are enabled, optical flow vectors from previous cmdOpticalFlowExecuteNV call are automatically used as hints for the current cmdOpticalFlowExecuteNV call, to take advantage of temporal correlation in a video sequence. Temporal hints should be disabled if there is a-priori knowledge of no temporal correlation (e.g. a scene change, independent successive frame pairs).

Constructors

OpticalFlowExecuteFlagBitsNV Flags

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …

Eq OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Ord OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Read OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Show OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Bits OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
FiniteBits OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Storable OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow
Zero OpticalFlowExecuteFlagBitsNVDefined in vulkan-3.27 · Vulkan.Extensions.VK_NV_optical_flow

patternpattern OPTICAL_FLOW_EXECUTE_DISABLE_TEMPORAL_HINTS_BIT_NV :: OpticalFlowExecuteFlagBitsNV

typetype NV_OPTICAL_FLOW_SPEC_VERSION = 1

patternpattern NV_OPTICAL_FLOW_SPEC_VERSION :: Integral a => a

typetype NV_OPTICAL_FLOW_EXTENSION_NAME = "VK_NV_optical_flow"

patternpattern NV_OPTICAL_FLOW_EXTENSION_NAME :: (Eq a, IsString a) => a

newtypenewtype OpticalFlowSessionNV

VkOpticalFlowSessionNV - Opaque handle to an optical flow session object

Constructors

OpticalFlowSessionNV Word64

Instances7Eq, Ord, Show, Storable, HasObjectType, IsHandle, …

Eq OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Ord OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Show OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Storable OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
HasObjectType OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
IsHandle OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles
Zero OpticalFlowSessionNVDefined in vulkan-3.27 · Vulkan.Extensions.Handles

Description

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Members

Description

Structure Chaining

See Also

Constructors

Description

Structure Chaining

See Also

Constructors

Structure Chaining

See Also

Constructors

Valid Usage (Implicit)

See Also

Constructors

Valid Usage

Valid Usage (Implicit)

See Also

Constructors

Structure Chaining

See Also

Constructors

Valid Usage

Valid Usage (Implicit)

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors

See Also

Constructors