Image - Extensions

oneAPI Level Zero Specification - Version 1.18.31

Image - Extension Functions

zeImageGetAllocPropertiesExt

Added in version 1.3

ZE_APIEXPORT ze_result_t ZE_APICALL zeImageGetAllocPropertiesExt(ze_context_handle_t hContext, ze_image_handle_t hImage, ze_image_allocation_ext_properties_t *pImageAllocProperties)

Retrieves attributes of an image allocation.

• The application may call this function from simultaneous threads.

Parameters:

• hContext – [in] handle of the context object

• hImage – [in] handle of image object to query

• pImageAllocProperties – [in,out] query result for image allocation properties

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hContext

  • nullptr == hImage

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pImageAllocProperties

zeImageViewCreateExt

Added in version 1.5

ZE_APIEXPORT ze_result_t ZE_APICALL zeImageViewCreateExt(ze_context_handle_t hContext, ze_device_handle_t hDevice, const ze_image_desc_t *desc, ze_image_handle_t hImage, ze_image_handle_t *phImageView)

Create image view on the context.

• The application must only use the image view for the device, or its sub-devices, which was provided during creation.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

• The implementation must support ZE_IMAGE_VIEW_EXT_NAME extension.

• Image views are treated as images from the API.

• Image views provide a mechanism to redescribe how an image is interpreted (e.g. different format).

• Image views become disabled when their corresponding image resource is destroyed.

• Use zeImageDestroy to destroy image view objects.

Remark

Analogues

• None

Parameters:

• hContext – [in] handle of the context object

• hDevice – [in] handle of the device

• desc – [in] pointer to image descriptor

• hImage – [in] handle of image object to create view from

• phImageView – [out] pointer to handle of image object created for view

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hContext

  • nullptr == hDevice

  • nullptr == hImage

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == desc

  • nullptr == phImageView

• ZE_RESULT_ERROR_INVALID_ENUMERATION

  • 0x3 < desc->flags

  • ZE_IMAGE_TYPE_BUFFER < desc->type

• ZE_RESULT_ERROR_UNSUPPORTED_ENUMERATION

• ZE_RESULT_ERROR_UNSUPPORTED_IMAGE_FORMAT

Image - Extension Structures

ze_image_view_planar_ext_desc_t

Added in version 1.5

struct ze_image_view_planar_ext_desc_t

Image view planar descriptor.

Public Members

ze_structure_type_t stype

[in] type of this structure

const void *pNext

[in][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

uint32_t planeIndex

[in] the 0-based plane index (e.g. NV12 is 0 = Y plane, 1 UV plane)

ze_srgb_ext_desc_t

Added in version 1.3

struct ze_srgb_ext_desc_t

sRGB image descriptor

• This structure may be passed to zeImageCreate via the pNext member of ze_image_desc_t

• Used for specifying that the image is in sRGB format.

Public Members

ze_structure_type_t stype

[in] type of this structure

const void *pNext

[in][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

ze_bool_t sRGB

[in] Is sRGB.

ze_image_allocation_ext_properties_t

Added in version 1.3

struct ze_image_allocation_ext_properties_t

Image allocation properties queried using zeImageGetAllocPropertiesExt.

Public Members

ze_structure_type_t stype

[in] type of this structure

void *pNext

[in,out][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

uint64_t id

[out] identifier for this allocation

ze_image_format_support_ext_properties_t

Added in version 1.15

struct ze_image_format_support_ext_properties_t

Image format support query properties.

• This structure may be passed to zeImageGetProperties via the pNext member of ze_image_properties_t.

• The implementation shall populate the supported field based on the ze_image_desc_t and ze_device_handle_t passed to zeImageGetProperties.

• This provides a mechanism to query format support without requiring image creation.

Public Members

ze_structure_type_t stype

[in] type of this structure

void *pNext

[in,out][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

ze_bool_t supported

[out] boolean flag indicating whether the image format is supported on the queried device