Vulkan
概述
提供OpenHarmony平台扩展的Vulkan能力，扩展了使用OHNativeWindow创建Vulkan Surface的能力，以及获取OH_NativeBuffer和OH_NativeBuffer属性的能力。
@syscap SystemCapability.Graphic.Vulkan
起始版本：
10
汇总
文件
| 名称 | 描述 |
|---|---|
| vulkan_ohos.h | 定义了OpenHarmony平台扩展的Vulkan接口。 引用文件：<vulkan/vulkan.h> 库：libvulkan.so |
结构体
| 名称 | 描述 |
|---|---|
| VkSurfaceCreateInfoOHOS | 包含创建Vulkan Surface时必要的参数。 |
| VkNativeBufferUsageOHOS | 提供OpenHarmony NativeBuffer用途的说明。 |
| VkNativeBufferPropertiesOHOS | 包含了NativeBuffer的属性。 |
| VkNativeBufferFormatPropertiesOHOS | 包含了NativeBuffer的一些格式属性。 |
| VkImportNativeBufferInfoOHOS | 包含了OH_NativeBuffer结构体的指针。 |
| VkMemoryGetNativeBufferInfoOHOS | 用于从Vulkan内存中获取OH_NativeBuffer。 |
| VkExternalFormatOHOS | 表示外部定义的格式标识符。 |
宏定义
| 名称 | 描述 |
|---|---|
| VK_OHOS_surface 1 | OpenHarmony平台Surface扩展宏定义。 |
| VK_OHOS_SURFACE_SPEC_VERSION 1 | OpenHarmony平台Surface扩展版本号。 |
| VK_OHOS_SURFACE_EXTENSION_NAME "VK_OHOS_surface" | OpenHarmony平台Surface扩展名。 |
| VK_OHOS_external_memory 1 | OpenHarmony平台external_memory扩展宏定义。 |
| VK_OHOS_EXTERNAL_MEMORY_SPEC_VERSION 1 | OpenHarmony平台external_memory扩展版本号。 |
| VK_OHOS_EXTERNAL_MEMORY_EXTENSION_NAME "VK_OHOS_external_memory" | OpenHarmony平台external_memory扩展名。 |
类型定义
| 名称 | 描述 |
|---|---|
| OHNativeWindow | OH本地窗口。 |
| VkSurfaceCreateFlagsOHOS | 用于Vulkan Surface创建时使用到的VkFlags类型位掩码，预留的标志类型。 |
| VkSurfaceCreateInfoOHOS | 包含创建Vulkan Surface时必要的参数。 |
| VkResult (VKAPI_PTR *PFN_vkCreateSurfaceOHOS) (VkInstance instance, const VkSurfaceCreateInfoOHOS *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface) | 创建Vulkan Surface的函数指针定义。 |
| VkNativeBufferUsageOHOS | 提供OpenHarmony NativeBuffer用途的说明。 |
| VkNativeBufferPropertiesOHOS | 包含了NativeBuffer的属性。 |
| VkNativeBufferFormatPropertiesOHOS | 包含了NativeBuffer的一些格式属性。 |
| VkImportNativeBufferInfoOHOS | 包含了OH_NativeBuffer结构体的指针。 |
| VkMemoryGetNativeBufferInfoOHOS | 用于从Vulkan内存中获取OH_NativeBuffer。 |
| VkExternalFormatOHOS | 表示外部定义的格式标识符。 |
| VkResult (VKAPI_PTR *PFN_vkGetNativeBufferPropertiesOHOS) (VkDevice device, const struct OH_NativeBuffer *buffer, VkNativeBufferPropertiesOHOS *pProperties) | 获取OH_NativeBuffer属性的函数指针定义。 |
| VkResult (VKAPI_PTR *PFN_vkGetMemoryNativeBufferOHOS) (VkDevice device, const VkMemoryGetNativeBufferInfoOHOS *pInfo, struct OH_NativeBuffer **pBuffer) | 获取OH_NativeBuffer的函数指针定义。 |
函数
| 名称 | 描述 |
|---|---|
| vkCreateSurfaceOHOS (VkInstance instance, const VkSurfaceCreateInfoOHOS *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface) | 创建Vulkan Surface。 |
| vkGetNativeBufferPropertiesOHOS (VkDevice device, const struct OH_NativeBuffer *buffer, VkNativeBufferPropertiesOHOS *pProperties) | 获取OH_NativeBuffer属性。 |
| vkGetMemoryNativeBufferOHOS (VkDevice device, const VkMemoryGetNativeBufferInfoOHOS *pInfo, struct OH_NativeBuffer **pBuffer) | 获取OH_NativeBuffer。 |
变量
宏定义说明
VK_OHOS_external_memory
#define VK_OHOS_external_memory 1
描述:
OpenHarmony平台external_memory扩展宏定义。
VK_OHOS_EXTERNAL_MEMORY_EXTENSION_NAME
#define VK_OHOS_EXTERNAL_MEMORY_EXTENSION_NAME "VK_OHOS_external_memory"
描述:
OpenHarmony平台external_memory扩展名。
VK_OHOS_EXTERNAL_MEMORY_SPEC_VERSION
#define VK_OHOS_EXTERNAL_MEMORY_SPEC_VERSION 1
描述:
OpenHarmony平台external_memory扩展版本号。
VK_OHOS_surface
#define VK_OHOS_surface 1
描述:
OpenHarmony平台Surface扩展宏定义。
VK_OHOS_SURFACE_EXTENSION_NAME
#define VK_OHOS_SURFACE_EXTENSION_NAME "VK_OHOS_surface"
描述:
OpenHarmony平台Surface扩展名。
VK_OHOS_SURFACE_SPEC_VERSION
#define VK_OHOS_SURFACE_SPEC_VERSION 1
描述:
OpenHarmony平台Surface扩展版本号。
类型定义说明
OHNativeWindow
typedef struct NativeWindow OHNativeWindow
描述:
OH本地窗口。
PFN_vkCreateSurfaceOHOS
typedef VkResult(VKAPI_PTR * PFN_vkCreateSurfaceOHOS) (VkInstance instance, const VkSurfaceCreateInfoOHOS *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
描述:
创建Vulkan Surface的函数指针定义。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| instance | Vulkan实例。 |
| pCreateInfo | 一个VkSurfaceCreateInfoOHOS结构体的指针，包含创建Vulkan Surface时必要的参数。 |
| pAllocator | 用户自定义内存分配的回调函数，如果不需要可以传入NULL，接口会使用默认的内存分配函数。 |
| pSurface | 出参，用于接收创建的Vulkan Surface，类型为VkSurfaceKHR。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
PFN_vkGetMemoryNativeBufferOHOS
typedef VkResult(VKAPI_PTR * PFN_vkGetMemoryNativeBufferOHOS) (VkDevice device, const VkMemoryGetNativeBufferInfoOHOS *pInfo, struct OH_NativeBuffer **pBuffer)
描述:
获取OH_NativeBuffer的函数指针定义。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| device | VkDevice对象。 |
| pInfo | VkMemoryGetNativeBufferInfoOHOS结构体对象。 |
| pBuffer | 用于接收获取到的OH_NativeBuffer。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
PFN_vkGetNativeBufferPropertiesOHOS
typedef VkResult(VKAPI_PTR * PFN_vkGetNativeBufferPropertiesOHOS) (VkDevice device, const struct OH_NativeBuffer *buffer, VkNativeBufferPropertiesOHOS *pProperties)
描述:
获取OH_NativeBuffer属性的函数指针定义。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| device | VkDevice对象。 |
| buffer | OH_NativeBuffer结构体指针。 |
| pProperties | 用于接收OH_NativeBuffer属性的结构体。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
VkExternalFormatOHOS
typedef struct VkExternalFormatOHOS VkExternalFormatOHOS
描述:
表示外部定义的格式标识符。
VkImportNativeBufferInfoOHOS
typedef struct VkImportNativeBufferInfoOHOS VkImportNativeBufferInfoOHOS
描述:
包含了OH_NativeBuffer结构体的指针。
VkMemoryGetNativeBufferInfoOHOS
typedef struct VkMemoryGetNativeBufferInfoOHOS VkMemoryGetNativeBufferInfoOHOS
描述:
用于从Vulkan内存中获取OH_NativeBuffer。
VkNativeBufferFormatPropertiesOHOS
typedef struct VkNativeBufferFormatPropertiesOHOS VkNativeBufferFormatPropertiesOHOS
描述:
包含了NativeBuffer的一些格式属性。
VkNativeBufferPropertiesOHOS
typedef struct VkNativeBufferPropertiesOHOS VkNativeBufferPropertiesOHOS
描述:
包含了NativeBuffer的属性。
VkNativeBufferUsageOHOS
typedef struct VkNativeBufferUsageOHOS VkNativeBufferUsageOHOS
描述:
提供OpenHarmony NativeBuffer用途的说明。
VkSurfaceCreateFlagsOHOS
typedef VkFlags VkSurfaceCreateFlagsOHOS
描述:
用于Vulkan Surface创建时使用到的VkFlags类型位掩码，预留的标志类型。
VkSurfaceCreateInfoOHOS
typedef struct VkSurfaceCreateInfoOHOS VkSurfaceCreateInfoOHOS
描述:
包含创建Vulkan Surface时必要的参数。
函数说明
vkCreateSurfaceOHOS()
VKAPI_ATTR VkResult VKAPI_CALL vkCreateSurfaceOHOS (VkInstance instance, const VkSurfaceCreateInfoOHOS * pCreateInfo, const VkAllocationCallbacks * pAllocator, VkSurfaceKHR * pSurface )
描述:
创建Vulkan Surface。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| instance | Vulkan实例。 |
| pCreateInfo | 一个VkSurfaceCreateInfoOHOS结构体的指针，包含创建Vulkan Surface时必要的参数。 |
| pAllocator | 用户自定义内存分配的回调函数，如果不需要可以传入NULL，接口会使用默认的内存分配函数。 |
| pSurface | 出参，用于接收创建的Vulkan Surface，类型为VkSurfaceKHR。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
vkGetMemoryNativeBufferOHOS()
VKAPI_ATTR VkResult VKAPI_CALL vkGetMemoryNativeBufferOHOS (VkDevice device, const VkMemoryGetNativeBufferInfoOHOS * pInfo, struct OH_NativeBuffer ** pBuffer )
描述:
获取OH_NativeBuffer。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| device | VkDevice对象。 |
| pInfo | VkMemoryGetNativeBufferInfoOHOS结构体对象。 |
| pBuffer | 用于接收获取到的OH_NativeBuffer。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
vkGetNativeBufferPropertiesOHOS()
VKAPI_ATTR VkResult VKAPI_CALL vkGetNativeBufferPropertiesOHOS (VkDevice device, const struct OH_NativeBuffer * buffer, VkNativeBufferPropertiesOHOS * pProperties )
描述:
获取OH_NativeBuffer属性。
@syscap SystemCapability.Graphic.Vulkan
参数:
| 名称 | 描述 |
|---|---|
| device | VkDevice对象。 |
| buffer | OH_NativeBuffer结构体指针。 |
| pProperties | 用于接收OH_NativeBuffer属性的结构体。 |
返回:
返回一个VkResult类型的错误码，返回值为VK_SUCCESS表示执行成功。
变量说明
allocationSize
VkDeviceSize VkNativeBufferPropertiesOHOS::allocationSize
描述:
占用的内存大小。
buffer
struct OH_NativeBuffer* VkImportNativeBufferInfoOHOS::buffer
描述:
OH_NativeBuffer结构体的指针。
externalFormat [1/2]
uint64_t VkNativeBufferFormatPropertiesOHOS::externalFormat
描述:
外部定义的格式标识符。
externalFormat [2/2]
uint64_t VkExternalFormatOHOS::externalFormat
描述:
外部定义的格式标识符。
flags
VkSurfaceCreateFlagsOHOS VkSurfaceCreateInfoOHOS::flags
描述:
预留的标志类型参数。
format
VkFormat VkNativeBufferFormatPropertiesOHOS::format
描述:
格式说明。
formatFeatures
VkFormatFeatureFlags VkNativeBufferFormatPropertiesOHOS::formatFeatures
描述:
描述了与externalFormat对应的能力。
memory
VkDeviceMemory VkMemoryGetNativeBufferInfoOHOS::memory
描述:
VkDeviceMemory对象。
memoryTypeBits
uint32_t VkNativeBufferPropertiesOHOS::memoryTypeBits
描述:
内存类型。
OHOSNativeBufferUsage
uint64_t VkNativeBufferUsageOHOS::OHOSNativeBufferUsage
描述:
NativeBuffer的用途说明。
pNext [1/7]
const void* VkSurfaceCreateInfoOHOS::pNext
描述:
下一级结构体指针。
pNext [2/7]
void* VkNativeBufferUsageOHOS::pNext
描述:
下一级结构体指针。
pNext [3/7]
void* VkNativeBufferPropertiesOHOS::pNext
描述:
下一级结构体指针。
pNext [4/7]
void* VkNativeBufferFormatPropertiesOHOS::pNext
描述:
下一级结构体指针。
pNext [5/7]
const void* VkImportNativeBufferInfoOHOS::pNext
描述:
下一级结构体指针。
pNext [6/7]
const void* VkMemoryGetNativeBufferInfoOHOS::pNext
描述:
下一级结构体指针。
pNext [7/7]
void* VkExternalFormatOHOS::pNext
描述:
下一级结构体指针。
samplerYcbcrConversionComponents
VkComponentMapping VkNativeBufferFormatPropertiesOHOS::samplerYcbcrConversionComponents
描述:
表示一组VkComponentSwizzle。
sType [1/7]
VkStructureType VkSurfaceCreateInfoOHOS::sType
描述:
结构体类型。
sType [2/7]
VkStructureType VkNativeBufferUsageOHOS::sType
描述:
结构体类型。
sType [3/7]
VkStructureType VkNativeBufferPropertiesOHOS::sType
描述:
结构体类型。
sType [4/7]
VkStructureType VkNativeBufferFormatPropertiesOHOS::sType
描述:
结构体类型。
sType [5/7]
VkStructureType VkImportNativeBufferInfoOHOS::sType
描述:
结构体类型。
sType [6/7]
VkStructureType VkMemoryGetNativeBufferInfoOHOS::sType
描述:
结构体类型。
sType [7/7]
VkStructureType VkExternalFormatOHOS::sType
描述:
结构体类型。
suggestedXChromaOffset
VkChromaLocation VkNativeBufferFormatPropertiesOHOS::suggestedXChromaOffset
描述:
X色度偏移。
suggestedYcbcrModel
VkSamplerYcbcrModelConversion VkNativeBufferFormatPropertiesOHOS::suggestedYcbcrModel
描述:
色彩模型。
suggestedYcbcrRange
VkSamplerYcbcrRange VkNativeBufferFormatPropertiesOHOS::suggestedYcbcrRange
描述:
色彩数值范围。
suggestedYChromaOffset
VkChromaLocation VkNativeBufferFormatPropertiesOHOS::suggestedYChromaOffset
描述:
Y色度偏移。
window
OHNativeWindow* VkSurfaceCreateInfoOHOS::window
描述:
OHNativeWindow指针。