LWJGL 3.3.3 · org.lwjgl.vulkan.ANDROIDExternalMemoryAndroidHardwareBuffer

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.

VK_ANDROID_external_memory_android_hardware_buffer

Name String

VK_ANDROID_external_memory_android_hardware_buffer

Extension Type

Device extension

Registered Extension Number

130

Revision

Extension and Version Dependencies

VK_KHR_sampler_ycbcr_conversion and VK_KHR_external_memory and VK_EXT_queue_family_foreign and VK_KHR_dedicated_allocation

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

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

Access	Constructor and Description
protected	ANDROIDExternalMemoryAndroidHardwareBuffer()

Method Summary

Modifier and Type	Method and Description
public static int	nvkGetAndroidHardwareBufferPropertiesANDROID(VkDevice device, long buffer, long pProperties) Unsafe version of: `GetAndroidHardwareBufferPropertiesANDROID`
public static int	nvkGetMemoryAndroidHardwareBufferANDROID(VkDevice device, long pInfo, long pBuffer) Unsafe version of: `GetMemoryAndroidHardwareBufferANDROID`
public static int	vkGetAndroidHardwareBufferPropertiesANDROID(VkDevice the logical device that will be importing `buffer`. device, long the Android hardware buffer which will be imported. buffer, VkAndroidHardwareBufferPropertiesANDROID a pointer to a `VkAndroidHardwareBufferPropertiesANDROID` structure in which the properties of `buffer` are returned. pProperties) Get Properties of External Memory Android Hardware Buffers.
public static int	vkGetMemoryAndroidHardwareBufferANDROID(VkDevice the logical device that created the device memory being exported. device, VkMemoryGetAndroidHardwareBufferInfoANDROID a pointer to a `VkMemoryGetAndroidHardwareBufferInfoANDROID` structure containing parameters of the export operation. pInfo, PointerBuffer will return an Android hardware buffer referencing the payload of the device memory object. pBuffer) Get an Android hardware buffer for a memory object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_EXTENSION_NAME	back to summary
public static final String VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_EXTENSION_NAME The extension name.

VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_SPEC_VERSION	back to summary
public static final int VK_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER_SPEC_VERSION The extension specification version.

VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID	back to summary
public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID Extends `VkExternalMemoryHandleTypeFlagBits`.

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID	back to summary
public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID Extends `VkStructureType`.

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID back to summary

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID back to summary

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID back to summary

VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID back to summary

VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID back to summary

VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID back to summary

VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID	back to summary
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`

public static final int VK_STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID

Extends VkStructureType.

Enum values:

Constructor Detail

ANDROIDExternalMemoryAndroidHardwareBuffer	back to summary
protected ANDROIDExternalMemoryAndroidHardwareBuffer()

Method Detail

nvkGetAndroidHardwareBufferPropertiesANDROID	back to summary
public static int nvkGetAndroidHardwareBufferPropertiesANDROID(VkDevice device, long buffer, long pProperties) Unsafe version of: `GetAndroidHardwareBufferPropertiesANDROID`

nvkGetMemoryAndroidHardwareBufferANDROID	back to summary
public static int nvkGetMemoryAndroidHardwareBufferANDROID(VkDevice device, long pInfo, long pBuffer) Unsafe version of: `GetMemoryAndroidHardwareBufferANDROID`

vkGetAndroidHardwareBufferPropertiesANDROID back to summary

vkGetAndroidHardwareBufferPropertiesANDROID	back to summary
public static int vkGetAndroidHardwareBufferPropertiesANDROID(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:VkDevice the logical device that will be importing `buffer`. buffer:long the Android hardware buffer which will be imported. pProperties:VkAndroidHardwareBufferPropertiesANDROID a pointer to a `VkAndroidHardwareBufferPropertiesANDROID` structure in which the properties of `buffer` are returned. Annotations @NativeType:VkResult

public static int vkGetAndroidHardwareBufferPropertiesANDROID(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

vkGetMemoryAndroidHardwareBufferANDROID	back to summary
public static int vkGetMemoryAndroidHardwareBufferANDROID(VkDevice device, VkMemoryGetAndroidHardwareBufferInfoANDROID pInfo, 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:VkDevice the logical device that created the device memory being exported. pInfo:VkMemoryGetAndroidHardwareBufferInfoANDROID a pointer to a `VkMemoryGetAndroidHardwareBufferInfoANDROID` structure containing parameters of the export operation. pBuffer:PointerBuffer will return an Android hardware buffer referencing the payload of the device memory object. Annotations @NativeType:VkResult

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

public Class ANDROIDExternalMemoryAndroidHardwareBuffer

VK_ANDROID_external_memory_android_hardware_buffer

Other Extension Metadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

C Specification

Description

Valid Usage (Implicit)

Return Codes

See Also