Package org.lwjgl.vulkan

Class VkImageFormatProperties

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImageFormatProperties>
org.lwjgl.vulkan.VkImageFormatProperties
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkImageFormatProperties extends org.lwjgl.system.Struct<VkImageFormatProperties> implements org.lwjgl.system.NativeResource
Structure specifying an image format properties.
Description
Note

There is no mechanism to query the size of an image before creating it, to compare that size against maxResourceSize. If an application attempts to create an image that exceeds this limit, the creation will fail and CreateImage will return ERROR_OUT_OF_DEVICE_MEMORY. While the advertised limit must be at least 231, it may not be possible to create an image that approaches that size, particularly for IMAGE_TYPE_1D.

If the combination of parameters to vkGetPhysicalDeviceImageFormatProperties is not supported by the implementation for use in CreateImage, then all members of VkImageFormatProperties will be filled with zero.

Note

Filling VkImageFormatProperties with zero for unsupported formats is an exception to the usual rule that output structures have undefined contents on error. This exception was unintentional, but is preserved for backwards compatibility.

See Also

VkExtent3D, VkExternalImageFormatPropertiesNV, VkImageFormatProperties2, GetPhysicalDeviceImageFormatProperties

Layout


 struct VkImageFormatProperties {
     VkExtent3D maxExtent();
     uint32_t maxMipLevels();
     uint32_t maxArrayLayers();
     VkSampleCountFlags sampleCounts();
     VkDeviceSize maxResourceSize();
 }