Package org.lwjgl.vulkan

Class ANDROIDExternalMemoryAndroidHardwareBuffer

java.lang.Object

org.lwjgl.vulkan.ANDROIDExternalMemoryAndroidHardwareBuffer

public class ANDROIDExternalMemoryAndroidHardwareBuffer
extends Object

This extension enables an application to import Android AHardwareBuffer objects created outside of the Vulkan device into Vulkan memory objects, where they can be bound to images and buffers. It also allows exporting an AHardwareBuffer from a Vulkan memory object for symmetry with other operating systems. But since not all AHardwareBuffer usages and formats have Vulkan equivalents, exporting from Vulkan provides strictly less functionality than creating the AHardwareBuffer externally and importing it.

Some AHardwareBuffer images have implementation-defined external formats that may not correspond to Vulkan formats. Sampler Y′C_BC_R conversion can be used to sample from these images and convert them to a known color space.

Name String

VK_ANDROID_external_memory_android_hardware_buffer

Extension Type

Device extension

Registered Extension Number

130

Revision

5

Extension and Version Dependencies

VK_KHR_sampler_ycbcr_conversion and VK_KHR_external_memory and VK_KHR_dedicated_allocation or Version 1.1 and VK_EXT_queue_family_foreign

API Interactions

• Interacts with VK_VERSION_1_3
• Interacts with VK_KHR_format_feature_flags2

Contact

• Jesse Hall critsec

Other Extension Metadata

Last Modified Date

2021-09-30

IP Status

No known IP claims.

Contributors

• Ray Smith, ARM
• Lina Versace, Google
• Jesse Hall, Google
• Tobias Hector, Imagination
• James Jones, NVIDIA
• Tony Zlatinski, NVIDIA
• Matthew Netsch, Qualcomm
• Andrew Garrard, Samsung

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_EXTENSION_NAME	The extension name.
static final int	VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_SPEC_VERSION	The extension specification version.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetAndroidHardwareBufferPropertiesANDROID(org.lwjgl.vulkan.VkDevice device, long buffer, long pProperties)	Unsafe version of: GetAndroidHardwareBufferPropertiesANDROID
static int	nvkGetMemoryAndroidHardwareBufferANDROID(org.lwjgl.vulkan.VkDevice device, long pInfo, long pBuffer)	Unsafe version of: GetMemoryAndroidHardwareBufferANDROID
static int	vkGetAndroidHardwareBufferPropertiesANDROID(org.lwjgl.vulkan.VkDevice device, long buffer, VkAndroidHardwareBufferPropertiesANDROID pProperties)	Get Properties of External Memory Android Hardware Buffers.
static int	vkGetMemoryAndroidHardwareBufferANDROID(org.lwjgl.vulkan.VkDevice device, VkMemoryGetAndroidHardwareBufferInfoANDROID pInfo, org.lwjgl.PointerBuffer pBuffer)	Get an Android hardware buffer for a memory object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_SPEC_VERSION

public static final int VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_EXTENSION_NAME

public static final String VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID

Extends VkExternalMemoryHandleTypeFlagBits.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

public static final int VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

public static final int VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

public static final int VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
• STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID

Extends VkStructureType.

See Also:

• Constant Field Values

Method Details

nvkGetAndroidHardwareBufferPropertiesANDROID

public static int nvkGetAndroidHardwareBufferPropertiesANDROID(org.lwjgl.vulkan.VkDevice device,
 long buffer,
 long pProperties)

Unsafe version of: GetAndroidHardwareBufferPropertiesANDROID

vkGetAndroidHardwareBufferPropertiesANDROID

public static int vkGetAndroidHardwareBufferPropertiesANDROID(org.lwjgl.vulkan.VkDevice device,
 long buffer,
 VkAndroidHardwareBufferPropertiesANDROID pProperties)

Get Properties of External Memory Android Hardware Buffers.

C Specification

To determine the memory parameters to use when importing an Android hardware buffer, call:

 VkResult vkGetAndroidHardwareBufferPropertiesANDROID(
     VkDevice                                    device,
     const struct AHardwareBuffer*               buffer,
     VkAndroidHardwareBufferPropertiesANDROID*   pProperties);

Valid Usage

• buffer must be a valid Android hardware buffer object with at least one of the AHARDWAREBUFFER_USAGE_GPU_* flags in its AHardwareBuffer_Desc::usage

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• buffer must be a valid pointer to a valid AHardwareBuffer value
• pProperties must be a valid pointer to a VkAndroidHardwareBufferPropertiesANDROID structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_EXTERNAL_HANDLE_KHR

See Also

VkAndroidHardwareBufferPropertiesANDROID

Parameters:

device - the logical device that will be importing buffer.

buffer - the Android hardware buffer which will be imported.

pProperties - a pointer to a VkAndroidHardwareBufferPropertiesANDROID structure in which the properties of buffer are returned.

nvkGetMemoryAndroidHardwareBufferANDROID

public static int nvkGetMemoryAndroidHardwareBufferANDROID(org.lwjgl.vulkan.VkDevice device,
 long pInfo,
 long pBuffer)

Unsafe version of: GetMemoryAndroidHardwareBufferANDROID

vkGetMemoryAndroidHardwareBufferANDROID

public static int vkGetMemoryAndroidHardwareBufferANDROID(org.lwjgl.vulkan.VkDevice device,
 VkMemoryGetAndroidHardwareBufferInfoANDROID pInfo,
 org.lwjgl.PointerBuffer pBuffer)

Get an Android hardware buffer for a memory object.

C Specification

To export an Android hardware buffer referencing the payload of a Vulkan device memory object, call:

 VkResult vkGetMemoryAndroidHardwareBufferANDROID(
     VkDevice                                    device,
     const VkMemoryGetAndroidHardwareBufferInfoANDROID* pInfo,
     struct AHardwareBuffer**                    pBuffer);

Description

Each call to vkGetMemoryAndroidHardwareBufferANDROID must return an Android hardware buffer with a new reference acquired in addition to the reference held by the VkDeviceMemory. To avoid leaking resources, the application must release the reference by calling AHardwareBuffer_release when it is no longer needed. When called with the same handle in VkMemoryGetAndroidHardwareBufferInfoANDROID::memory, vkGetMemoryAndroidHardwareBufferANDROID must return the same Android hardware buffer object. If the device memory was created by importing an Android hardware buffer, vkGetMemoryAndroidHardwareBufferANDROID must return that same Android hardware buffer object.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pInfo must be a valid pointer to a valid VkMemoryGetAndroidHardwareBufferInfoANDROID structure
• pBuffer must be a valid pointer to a valid pointer to an AHardwareBuffer value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

VkMemoryGetAndroidHardwareBufferInfoANDROID

Parameters:

device - the logical device that created the device memory being exported.

pInfo - a pointer to a VkMemoryGetAndroidHardwareBufferInfoANDROID structure containing parameters of the export operation.

pBuffer - will return an Android hardware buffer referencing the payload of the device memory object.