vkGetImageDrmFormatModifierPropertiesEXT(3)

# vkGetImageDrmFormatModifierPropertiesEXT(3) Manual Page

## Name

vkGetImageDrmFormatModifierPropertiesEXT - Returns an image's DRM format modifier

Loading... please wait.

## C Specification

If an image was created with `VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT`, then the image has a Linux DRM format modifier. To query the modifier, call:

    VkResult vkGetImageDrmFormatModifierPropertiesEXT(
        VkDevice                                    device,
        VkImage                                     image,
        VkImageDrmFormatModifierPropertiesEXT*      pProperties);

## Parameters

- `device` is the logical device that owns the image.

- `image` is the queried image.

- `pProperties` will return properties of the image’s DRM format modifier.

## Description

Valid Usage

- `image` must have been created with `tiling` equal to `VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT`

Valid Usage (Implicit)

- `device` must be a valid VkDevice handle

- `image` must be a valid VkImage handle

- `pProperties` must be a valid pointer to a VkImageDrmFormatModifierPropertiesEXT structure

- `image` must have been created, allocated, or retrieved from `device`

Return Codes

On success, this command returns

  - `VK_SUCCESS`

## See Also

VkDevice, VkImage, VkImageDrmFormatModifierPropertiesEXT

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.