Vulkan.Extensions.VK_ARM_data_graph_optical_flow

vkGetPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM - Query image formats for data graph 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 user 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 a optical flow image, obtain the supported image creation parameters by querying with getPhysicalDeviceFormatProperties2 and getPhysicalDeviceImageFormatProperties2 using one of the reported formats and adding DataGraphOpticalFlowImageFormatInfoARM to the pNext chain of PhysicalDeviceImageFormatInfo2. When querying the parameters with getPhysicalDeviceImageFormatProperties2 for images used for optical flow operations, the DataGraphOpticalFlowImageFormatInfoARM::usage field should contain one or more of the bits defined in DataGraphOpticalFlowImageUsageFlagBitsARM.

Valid Usage

• pQueueFamilyDataGraphProperties must point to a structure whose operation member has its name member equal to OpticalFlow

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• pQueueFamilyDataGraphProperties must be a valid pointer to a valid QueueFamilyDataGraphPropertiesARM structure

• pOpticalFlowImageFormatInfo must be a valid pointer to a valid DataGraphOpticalFlowImageFormatInfoARM 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 DataGraphOpticalFlowImageFormatPropertiesARM structures

Return Codes

Success

• INCOMPLETE

• SUCCESS

Failure

• ERROR_EXTENSION_NOT_PRESENT

• ERROR_FORMAT_NOT_SUPPORTED

• ERROR_INITIALIZATION_FAILED

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

FORMAT_B8G8R8A8_UNORM, FORMAT_R8G8B8A8_UNORM, FORMAT_R8G8B8_UNORM, FORMAT_B8G8R8_UNORM, FORMAT_R8_UNORM, and FORMAT_B10G11R11_UFLOAT_PACK32 are initially supported for images with optical flow usage DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_INPUT_BIT_ARM.

FORMAT_R16G16_SFLOAT is initially supported for images with optical flow usage DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_OUTPUT_BIT_ARM and DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_HINT_BIT_ARM.

FORMAT_R16_UINT is initially supported for images with optical flow usage DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_COST_BIT_ARM.

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowImageFormatInfoARM, DataGraphOpticalFlowImageFormatPropertiesARM, PhysicalDevice, QueueFamilyDataGraphPropertiesARM

VkDataGraphPipelineResourceInfoImageLayoutARM - Structure specifying parameters of a graph pipeline image resource

Structure Chaining

Extends the structure

• DataGraphPipelineResourceInfoARM

See Also

VK_ARM_data_graph_optical_flow, ImageLayout, StructureType

VkDataGraphPipelineSingleNodeConnectionARM - Structure describing a single connection between a data graph node and the pipeline layout of a graph pipeline

Valid Usage (Implicit)

See Also

VK_ARM_data_graph_optical_flow, DataGraphPipelineNodeConnectionTypeARM, DataGraphPipelineSingleNodeCreateInfoARM, StructureType

VkPhysicalDeviceDataGraphOpticalFlowFeaturesARM - Structure describing the data graph optical flow features supported by the implementation

Members

This structure describes the following feature: * sType is a StructureType value identifying this structure. * pNext is NULL or a pointer to a structure extending this structure. * dataGraphOpticalFlow indicates whether the implementation supports optical flow graph pipelines.

If the PhysicalDeviceDataGraphOpticalFlowFeaturesARM 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 PhysicalDeviceDataGraphOpticalFlowFeaturesARM, 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

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_ARM_data_graph_optical_flow, Bool32, StructureType

VkQueueFamilyDataGraphOpticalFlowPropertiesARM - Structure describing optical flow properties of a processing engine and operation set for a specific queue family of a physical device

Valid Usage (Implicit)

See Also

VK_ARM_data_graph_optical_flow, Bool32, DataGraphOpticalFlowGridSizeFlagsARM, StructureType

VkDataGraphOpticalFlowImageFormatInfoARM - Structure describing data graph optical flow image format info

Structure Chaining

Extends the structures

• ImageCreateInfo

• PhysicalDeviceImageFormatInfo2

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowImageUsageFlagsARM, StructureType, getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM

VkDataGraphOpticalFlowImageFormatPropertiesARM - Structure describing properties of an optical flow image format

Valid Usage (Implicit)

See Also

VK_ARM_data_graph_optical_flow, Format, StructureType, getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM

VkDataGraphPipelineSingleNodeCreateInfoARM - Structure specifying parameters of a newly-created single fixed-function node graph pipeline

Valid Usage

• If nodeType is DATA_GRAPH_PIPELINE_NODE_TYPE_OPTICAL_FLOW_ARM, then a DataGraphPipelineOpticalFlowCreateInfoARM structure must be included in the pNext chain of this structure

• If nodeType is DATA_GRAPH_PIPELINE_NODE_TYPE_OPTICAL_FLOW_ARM, then one and only DataGraphPipelineSingleNodeConnectionARM structure must be present in the pConnections array for each of the following values of its connection member:

  • DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_INPUT_ARM

  • DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_REFERENCE_ARM

  • DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_FLOW_VECTOR_ARM

• If nodeType is DATA_GRAPH_PIPELINE_NODE_TYPE_OPTICAL_FLOW_ARM and DataGraphPipelineOpticalFlowCreateInfoARM::hintGridSize is not 0, then one and only DataGraphPipelineSingleNodeConnectionARM structure whose connection member is DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_HINT_ARM must be present in the pConnections array

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DATA_GRAPH_PIPELINE_SINGLE_NODE_CREATE_INFO_ARM

• nodeType must be a valid DataGraphPipelineNodeTypeARM value

• pConnections must be a valid pointer to an array of connectionCount valid DataGraphPipelineSingleNodeConnectionARM structures

• connectionCount must be greater than 0

Structure Chaining

Extends the structure

• DataGraphPipelineCreateInfoARM

See Also

VK_ARM_data_graph_optical_flow, DataGraphPipelineNodeTypeARM, DataGraphPipelineSingleNodeConnectionARM, StructureType

VkDataGraphPipelineOpticalFlowCreateInfoARM - Structure specifying the parameters of a newly-created optical flow graph pipeline

Valid Usage

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

• height must be greater than or equal to QueueFamilyDataGraphOpticalFlowPropertiesARM::minHeight and less than or equal to QueueFamilyDataGraphOpticalFlowPropertiesARM::maxHeight

• imageFormat must be one of the formats returned by getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM for DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_INPUT_BIT_ARM

• flowVectorFormat must be one of the formats returned by getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM for DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_OUTPUT_BIT_ARM

• costFormat must be one of the formats returned by getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM for DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_COST_BIT_ARM if DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_COST_BIT_ARM is set in flags

• outputGridSize must be exactly one of the bits reported in QueueFamilyDataGraphOpticalFlowPropertiesARM::supportedOutputGridSizes

• hintGridSize must be 0 or exactly one of the bits reported in QueueFamilyDataGraphOpticalFlowPropertiesARM::supportedHintGridSizes if DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_HINT_BIT_ARM is set in flags

• hintGridSize must be the same as outputGridSize if hintGridSize is not 0

• DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_HINT_BIT_ARM must not be set in flags if QueueFamilyDataGraphOpticalFlowPropertiesARM::hintSupported is FALSE

• DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_COST_BIT_ARM must not be set in flags if QueueFamilyDataGraphOpticalFlowPropertiesARM::costSupported is FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DATA_GRAPH_PIPELINE_OPTICAL_FLOW_CREATE_INFO_ARM

• 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

• If performanceLevel is not 0, performanceLevel must be a valid DataGraphOpticalFlowPerformanceLevelARM value

• flags must be a valid combination of DataGraphOpticalFlowCreateFlagBitsARM values

Structure Chaining

Extends the structure

• DataGraphPipelineCreateInfoARM

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowCreateFlagsARM, DataGraphOpticalFlowGridSizeFlagsARM, DataGraphOpticalFlowPerformanceLevelARM, Format, StructureType

VkDataGraphPipelineOpticalFlowDispatchInfoARM - Structure specifying parameters of a optical flow vector calculation

Structure Chaining

Extends the structure

• DataGraphPipelineDispatchInfoARM

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowExecuteFlagsARM, StructureType

VkDataGraphOpticalFlowGridSizeFlagBitsARM - Bits specifying grid sizes for optical flow operations

Description

• DATA_GRAPH_OPTICAL_FLOW_GRID_SIZE_1X1_BIT_ARM specifies that grid is 1x1 pixel.

• DATA_GRAPH_OPTICAL_FLOW_GRID_SIZE_2X2_BIT_ARM specifies that grid is 2x2 pixel.

• DATA_GRAPH_OPTICAL_FLOW_GRID_SIZE_4X4_BIT_ARM specifies that grid is 4x4 pixel.

• DATA_GRAPH_OPTICAL_FLOW_GRID_SIZE_8X8_BIT_ARM specifies that grid is 8x8 pixel.

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowGridSizeFlagsARM

VkDataGraphOpticalFlowImageUsageFlagBitsARM - Bits specifying image usage for optical flow operations

Description

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

• DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_OUTPUT_BIT_ARM specifies that the image can be used as output flow vector map for an optical flow operation.

• DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_HINT_BIT_ARM specifies that the image can be used as hint flow vector map for an optical flow operation.

• DATA_GRAPH_OPTICAL_FLOW_IMAGE_USAGE_COST_BIT_ARM specifies that the image can be used as output cost map for an optical flow operation.

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowImageUsageFlagsARM

VkDataGraphOpticalFlowPerformanceLevelARM - Optical flow performance level types

Description

• DATA_GRAPH_OPTICAL_FLOW_PERFORMANCE_LEVEL_SLOW_ARM is a level with slower performance but higher quality.

• DATA_GRAPH_OPTICAL_FLOW_PERFORMANCE_LEVEL_MEDIUM_ARM is a level with medium performance and medium quality.

• DATA_GRAPH_OPTICAL_FLOW_PERFORMANCE_LEVEL_FAST_ARM is a preset with higher performance but lower quality.

See Also

VK_ARM_data_graph_optical_flow, DataGraphPipelineOpticalFlowCreateInfoARM

VkDataGraphPipelineNodeConnectionTypeARM - Connection points for a fixed-function data graph node

Description

• DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_INPUT_ARM specifies the connection point for the input image of an optical flow node.

• DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_REFERENCE_ARM specifies the connection point for the input reference image of an optical flow node.

• DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_HINT_ARM specifies the connection point for the optional external hint flow vector map of an optical flow node.

• DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_FLOW_VECTOR_ARM specifies the connection point for the output flow vector map of an optical flow node.

• DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_COST_ARM specifies the connection point for the optional output cost map of an optical flow node.

See Also

VK_ARM_data_graph_optical_flow, DataGraphPipelineSingleNodeConnectionARM

VkDataGraphPipelineNodeTypeARM - Enumeration describing the type of a data graph pipeline node

Description

• DATA_GRAPH_PIPELINE_NODE_TYPE_OPTICAL_FLOW_ARM corresponds to an optical flow node.

See Also

VK_ARM_data_graph_optical_flow, DataGraphPipelineSingleNodeCreateInfoARM

VkDataGraphOpticalFlowCreateFlagBitsARM - Bits specifying flags for newly created optical flow data graph node

Description

• DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_HINT_BIT_ARM specifies that a ImageView with external flow vector map will be used as hints in performing the motion search and must be connected to DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_HINT_ARM.

• DATA_GRAPH_OPTICAL_FLOW_CREATE_ENABLE_COST_BIT_ARM specifies that the cost for the forward flow is generated in a ImageView which must be connected to DATA_GRAPH_PIPELINE_NODE_CONNECTION_TYPE_OPTICAL_FLOW_COST_ARM. The cost is the confidence level of the flow vector for each grid in the image. The cost implies how (in)accurate the flow vector is. Higher cost value implies the flow vector to be less accurate and vice-versa.

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowCreateFlagsARM

VkDataGraphOpticalFlowExecuteFlagBitsARM - Bits specifying flags for a optical flow vector calculation

Description

• DATA_GRAPH_OPTICAL_FLOW_EXECUTE_DISABLE_TEMPORAL_HINTS_BIT_ARM specifies that temporal hints from previously generated flow vector map are not used. If temporal hints are enabled, the optical flow vector map from previous cmdDispatchDataGraphARM calls in the same graph pipeline session may be automatically used as hints for the current cmdDispatchDataGraphARM 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 image pairs).

• DATA_GRAPH_OPTICAL_FLOW_EXECUTE_INPUT_UNCHANGED_BIT_ARM specifies that the contents of the input image are the same as in the previously executed cmdDispatchDataGraphARM call in the same graph pipeline session.

• DATA_GRAPH_OPTICAL_FLOW_EXECUTE_REFERENCE_UNCHANGED_BIT_ARM specifies that the contents of the reference image are the same as in the previously executed cmdDispatchDataGraphARM call in the same graph pipeline session.

• DATA_GRAPH_OPTICAL_FLOW_EXECUTE_INPUT_IS_PREVIOUS_REFERENCE_BIT_ARM specifies that the contents of the input image are the same as the contents of the reference image in the previously executed cmdDispatchDataGraphARM call in the same graph pipeline session.

• DATA_GRAPH_OPTICAL_FLOW_EXECUTE_REFERENCE_IS_PREVIOUS_INPUT_BIT_ARM specifies that the contents of the reference image are the same as the contents of the input image in the previously executed cmdDispatchDataGraphARM call in the same graph pipeline session.

See Also

VK_ARM_data_graph_optical_flow, DataGraphOpticalFlowExecuteFlagsARM

VkPhysicalDeviceDataGraphProcessingEngineARM - Structure describing a data graph processing engine supported by a physical device

See Also

VK_ARM_data_graph, Bool32, DataGraphProcessingEngineCreateInfoARM, PhysicalDeviceDataGraphProcessingEngineTypeARM, QueueFamilyDataGraphPropertiesARM

VkPhysicalDeviceDataGraphOperationSupportARM - Structure describing an operation or set of operations supported by a data graph processing engine

See Also

VK_ARM_data_graph, DataGraphPipelineBuiltinModelCreateInfoQCOM, PhysicalDeviceDataGraphOperationTypeARM, QueueFamilyDataGraphPropertiesARM

VkQueueFamilyDataGraphPropertiesARM - Structure describing a data graph processing engine and operation it supports

Valid Usage (Implicit)

See Also

VK_ARM_data_graph, PhysicalDeviceDataGraphOperationSupportARM, PhysicalDeviceDataGraphProcessingEngineARM, StructureType, getPhysicalDeviceQueueFamilyDataGraphEngineOperationPropertiesARM, getPhysicalDeviceQueueFamilyDataGraphOpticalFlowImageFormatsARM, getPhysicalDeviceQueueFamilyDataGraphPropertiesARM

VkDataGraphPipelineSessionCreateFlagBitsARM - Bitmask specifying additional parameters of a data graph pipeline session

Description

• DATA_GRAPH_PIPELINE_SESSION_CREATE_PROTECTED_BIT_ARM specifies that the data graph pipeline session is backed by protected memory.

• DATA_GRAPH_PIPELINE_SESSION_CREATE_OPTICAL_FLOW_CACHE_BIT_ARM specifies that the data graph pipeline session has a cache for optical flow operations. Enabling the cache is required for the implementation to use temporal hints.

See Also

VK_ARM_data_graph, DataGraphPipelineSessionCreateFlagsARM

VkDataGraphPipelineSessionBindPointARM - Enumeration describing the bind points of a data graph pipeline session

Description

• DATA_GRAPH_PIPELINE_SESSION_BIND_POINT_TRANSIENT_ARM corresponds to the transient data produced and consumed during one dispatch of a data graph pipeline in a data graph pipeline session. This transient data is never reused by subsequent dispatches and can safely be clobbered once a cmdDispatchDataGraphARM command completes execution.

• DATA_GRAPH_PIPELINE_SESSION_BIND_POINT_OPTICAL_FLOW_CACHE_ARM corresponds to the cache for optical flow operations.

• DATA_GRAPH_PIPELINE_SESSION_BIND_POINT_NEURAL_ACCELERATOR_STATISTICS_ARM corresponds to neural statistics data produced during one dispatch of a data graph pipeline in a data graph pipeline session.

See Also

VK_ARM_data_graph, BindDataGraphPipelineSessionMemoryInfoARM, DataGraphPipelineSessionBindPointRequirementARM, DataGraphPipelineSessionMemoryRequirementsInfoARM

VkPhysicalDeviceDataGraphProcessingEngineTypeARM - Enumeration describing data graph processing engines

Description

• PHYSICAL_DEVICE_DATA_GRAPH_PROCESSING_ENGINE_TYPE_DEFAULT_ARM corresponds to the default data graph processing engine.

• PHYSICAL_DEVICE_DATA_GRAPH_PROCESSING_ENGINE_TYPE_NEURAL_QCOM specifies an engine that specializes in neural processing.

• PHYSICAL_DEVICE_DATA_GRAPH_PROCESSING_ENGINE_TYPE_COMPUTE_QCOM specifies an engine that uses compute processing to execute data graphs.

See Also

VK_ARM_data_graph, PhysicalDeviceDataGraphProcessingEngineARM, PhysicalDeviceQueueFamilyDataGraphProcessingEngineInfoARM

VkPhysicalDeviceDataGraphOperationTypeARM - Enumeration describing data graph operations

Description

• PHYSICAL_DEVICE_DATA_GRAPH_OPERATION_TYPE_SPIRV_EXTENDED_INSTRUCTION_SET_ARM corresponds to operations provided by a SPIR-V extended instruction set.

• PHYSICAL_DEVICE_DATA_GRAPH_OPERATION_TYPE_NEURAL_MODEL_QCOM specifies an operation that executes neural models provided by the application.

• PHYSICAL_DEVICE_DATA_GRAPH_OPERATION_TYPE_BUILTIN_MODEL_QCOM specifies an operation that executes specialized built-in models provided by the implementation.

• PHYSICAL_DEVICE_DATA_GRAPH_OPERATION_TYPE_OPTICAL_FLOW_ARM corresponds to fixed-function optical flow as defined by VK_ARM_data_graph_optical_flow.

See Also

VK_ARM_data_graph, PhysicalDeviceDataGraphOperationSupportARM

VK_MAX_PHYSICAL_DEVICE_DATA_GRAPH_OPERATION_SET_NAME_SIZE_ARM - Length of a data graph operation name string

See Also

VK_ARM_data_graph