hi_mpi_rgn_create

Applicability

Product	Supported
Atlas 350 Accelerator Card	☓
Atlas A3 training product / Atlas A3 inference product	☓
Atlas A2 training product / Atlas A2 inference product	☓
Atlas 200I/500 A2 inference product	√
Atlas inference product	☓
Atlas training product	☓

Function Description

Creates different types of regions.

This API is not supported in the Ascend EP form of Atlas 200I/500 A2 inference product .

Prototype

hi_s32 hi_mpi_rgn_create(hi_rgn_handle handle, const hi_rgn_attr *rgn_attr)

Parameters

Parameter	Input/Output	Description
handle	Input	Region handle ID. The handle ID must be unused and is specified by the user. The meaning of the handle ID is the same as that of the ID. Value range: [0, 1024)
rgn_attr	Input	Pointer to the region attribute. This parameter cannot be null. Only the pixel format, region width, and region height are set. Other region attributes, such as the region position and layer, need to be specified when the hi_mpi_rgn_attach_to_chn API is called.

Parameter

Input/Output

Description

handle

Input

Region handle ID.

The handle ID must be unused and is specified by the user. The meaning of the handle ID is the same as that of the ID.

Value range: [0, 1024)

rgn_attr

Input

Pointer to the region attribute. This parameter cannot be null.

Only the pixel format, region width, and region height are set. Other region attributes, such as the region position and layer, need to be specified when the hi_mpi_rgn_attach_to_chn API is called.

Returns

0: success.
Other values: failure. For details, see 19.18.5-Region Management Return Codes.

Restrictions

Repeated creation is not supported.
When a region is created, this API checks only the basic parameters, such as the minimum width and height and the maximum width and height. When a region is overlaid on a channel by calling the hi_mpi_rgn_attach_to_chn API, the parameters (such as the supported pixel format) are checked based on the restrictions supported by each channel module.