MLGraphicsImportedMediaSurface

Module: Graphics Utilities

Handles to and information about an imported surface. More...

#include <ml_graphics_utils.h>

Public Attributes

Type	Name
VkImage	imported_image
VkDeviceMemory	imported_memory
VkFormat	format The Vulkan format corresponding to the imported surface’s format, or VK_FORMAT_UNDEFINED if there isn’t an equivalent Vulkan format.
uint64_t	external_format
VkFormatFeatureFlags	format_features
VkComponentMapping	sampler_ycbcr_conversion_components
VkSamplerYcbcrModelConversion	suggested_ycbcr_model
VkSamplerYcbcrRange	suggested_ycbcr_range
VkChromaLocation	suggested_x_chroma_offset
VkChromaLocation	suggested_y_chroma_offset

Detailed Description

struct MLGraphicsImportedMediaSurface;

Handles to and information about an imported surface.

Populated by MLGraphicsImportVkImageFromMediaHandle. Provides all information, necessary for creating a VkImageView and VkSampler for the imported surface.

Refer to the Vulkan specification's equivalent parameters in VkAndroidHardwareBufferFormatPropertiesANDROID. Also refer to usage of VkExternalFormatANDROID and VkSamplerYcbcrConversionCreateInfo.

---

Public Attributes Documentation

imported_image

VkImage imported_image;

The VkImage bound to the imported surface.

---

imported_memory

VkDeviceMemory imported_memory;

The VkDevice memory representing the imported surface.

---

format

VkFormat format;

The Vulkan format corresponding to the imported surface’s format, or VK_FORMAT_UNDEFINED if there isn’t an equivalent Vulkan format.

---

external_format

uint64_t external_format;

An implementation-defined external format identifier for use with VkExternalFormatANDROID.

---

format_features

VkFormatFeatureFlags format_features;

Describes the capabilities of this external format.

---

sampler_ycbcr_conversion_components

VkComponentMapping sampler_ycbcr_conversion_components;

The component swizzle that should be used in VkSamplerYcbcrConversionCreateInfo.

---

suggested_ycbcr_model

VkSamplerYcbcrModelConversion suggested_ycbcr_model;

Suggested color model to use in the VkSamplerYcbcrConversionCreateInfo.

---

suggested_ycbcr_range

VkSamplerYcbcrRange suggested_ycbcr_range;

Suggested numerical value range to use in VkSamplerYcbcrConversionCreateInfo.

---

suggested_x_chroma_offset

VkChromaLocation suggested_x_chroma_offset;

Suggested X chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

---

suggested_y_chroma_offset

VkChromaLocation suggested_y_chroma_offset;

Suggested Y chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

---