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.
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.
VkExtent3D, VkExternalImageFormatPropertiesNV, VkImageFormatProperties2, GetPhysicalDeviceImageFormatProperties
struct VkImageFormatProperties {
VkExtent3D maxExtent;
uint32_t maxMipLevels;
uint32_t maxArrayLayers;
VkSampleCountFlags sampleCounts;
VkDeviceSize maxResourceSize;
}
| Modifier and Type | Class and Description |
|---|---|
| public static class | VkImageFormatProperties.
An array of |
| Modifier and Type | Field and Description |
|---|---|
| public static final int | ALIGNOF
The struct alignment in bytes. |
| public static final int | MAXARRAYLAYERS
The struct member offsets. |
| public static final int | MAXEXTENT
The struct member offsets. |
| public static final int | MAXMIPLEVELS
The struct member offsets. |
| public static final int | MAXRESOURCESIZE
The struct member offsets. |
| public static final int | SAMPLECOUNTS
The struct member offsets. |
| public static final int | SIZEOF
The struct size in bytes. |
| Access | Constructor and Description |
|---|---|
| protected | |
| public | VkImageFormatProperties(ByteBuffer container)
Creates a |
| Modifier and Type | Method and Description |
|---|---|
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties. | calloc(int
the buffer capacity capacity)Returns a new |
| public static VkImageFormatProperties | calloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static VkImageFormatProperties. | calloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties. | |
| public static VkImageFormatProperties. | |
| protected VkImageFormatProperties | create(long
the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container)Implements abstract org. the constructor, but returns the exact type of the Struct subclass.
|
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties | create(long address)
Returns a new |
| public static VkImageFormatProperties. | create(int
the buffer capacity capacity)Returns a new |
| public static VkImageFormatProperties. | create(long
the memory address address, int the buffer capacity capacity)Create a |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties. | |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties. | malloc(int
the buffer capacity capacity)Returns a new |
| public static VkImageFormatProperties | malloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static VkImageFormatProperties. | malloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties | |
| public static VkImageFormatProperties. | |
| public static VkImageFormatProperties. | |
| public int | |
| public VkExtent3D | |
| public int | |
| public long | maxResourceSize()
an upper bound on the total image size in bytes, inclusive of all image subresources. |
| public static int | |
| public static VkExtent3D | |
| public static int | |
| public static long | |
| public static int | |
| public int | sampleCounts()
a bitmask of |
| public int |
| ALIGNOF | back to summary |
|---|---|
| public static final int ALIGNOF The struct alignment in bytes. | |
| MAXARRAYLAYERS | back to summary |
|---|---|
| public static final int MAXARRAYLAYERS The struct member offsets. | |
| MAXEXTENT | back to summary |
|---|---|
| public static final int MAXEXTENT The struct member offsets. | |
| MAXMIPLEVELS | back to summary |
|---|---|
| public static final int MAXMIPLEVELS The struct member offsets. | |
| MAXRESOURCESIZE | back to summary |
|---|---|
| public static final int MAXRESOURCESIZE The struct member offsets. | |
| SAMPLECOUNTS | back to summary |
|---|---|
| public static final int SAMPLECOUNTS The struct member offsets. | |
| SIZEOF | back to summary |
|---|---|
| public static final int SIZEOF The struct size in bytes. | |
| VkImageFormatProperties | back to summary |
|---|---|
| protected VkImageFormatProperties(long address, ByteBuffer container) | |
| VkImageFormatProperties | back to summary |
|---|---|
| public VkImageFormatProperties(ByteBuffer container) Creates a The created instance holds a strong reference to the container object. | |
| calloc | back to summary |
|---|---|
| public static VkImageFormatProperties calloc() Returns a new | |
| calloc | back to summary |
|---|---|
| public static VkImageFormatProperties. Returns a new
| |
| calloc | back to summary |
|---|---|
| public static VkImageFormatProperties calloc(MemoryStack stack) Returns a new
| |
| calloc | back to summary |
|---|---|
| public static VkImageFormatProperties. Returns a new
| |
| callocStack | back to summary |
|---|---|
| public static VkImageFormatProperties callocStack()
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkImageFormatProperties callocStack(MemoryStack stack)
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkImageFormatProperties. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkImageFormatProperties. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| create | back to summary |
|---|---|
| protected VkImageFormatProperties create(long address, ByteBuffer container) Implements abstract org. Doc from org. Similar to Effectively, every
| |
| create | back to summary |
|---|---|
| public static VkImageFormatProperties create() Returns a new | |
| create | back to summary |
|---|---|
| public static VkImageFormatProperties create(long address) Returns a new | |
| create | back to summary |
|---|---|
| public static VkImageFormatProperties. Returns a new
| |
| create | back to summary |
|---|---|
| public static VkImageFormatProperties. Create a
| |
| createSafe | back to summary |
|---|---|
| public static VkImageFormatProperties createSafe(long address) Like
| |
| createSafe | back to summary |
|---|---|
| public static VkImageFormatProperties. Like
| |
| malloc | back to summary |
|---|---|
| public static VkImageFormatProperties malloc() Returns a new | |
| malloc | back to summary |
|---|---|
| public static VkImageFormatProperties. Returns a new
| |
| malloc | back to summary |
|---|---|
| public static VkImageFormatProperties malloc(MemoryStack stack) Returns a new
| |
| malloc | back to summary |
|---|---|
| public static VkImageFormatProperties. Returns a new
| |
| mallocStack | back to summary |
|---|---|
| public static VkImageFormatProperties mallocStack()
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkImageFormatProperties mallocStack(MemoryStack stack)
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkImageFormatProperties. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkImageFormatProperties. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| maxArrayLayers | back to summary |
|---|---|
| public int maxArrayLayers() the maximum number of array layers.
| |
| maxExtent | back to summary |
|---|---|
| public VkExtent3D maxExtent() are the maximum image dimensions. See the Allowed Extent Values section below for how these values are constrained by | |
| maxMipLevels | back to summary |
|---|---|
| public int maxMipLevels() the maximum number of mipmap levels.
| |
| maxResourceSize | back to summary |
|---|---|
| public long maxResourceSize() an upper bound on the total image size in bytes, inclusive of all image subresources. Implementations may have an address space limit on total size of a resource, which is advertised by this property.
| |
| nmaxArrayLayers | back to summary |
|---|---|
| public static int nmaxArrayLayers(long struct) Unsafe version of | |
| nmaxExtent | back to summary |
|---|---|
| public static VkExtent3D nmaxExtent(long struct) Unsafe version of | |
| nmaxMipLevels | back to summary |
|---|---|
| public static int nmaxMipLevels(long struct) Unsafe version of | |
| nmaxResourceSize | back to summary |
|---|---|
| public static long nmaxResourceSize(long struct) Unsafe version of | |
| nsampleCounts | back to summary |
|---|---|
| public static int nsampleCounts(long struct) Unsafe version of | |
| sampleCounts | back to summary |
|---|---|
| public int sampleCounts() a bitmask of
| |
| sizeof | back to summary |
|---|---|
| public int sizeof() Implements abstract org. Doc from org. Returns
| |
VkImageFormatProperties structs.
| Modifier and Type | Field and Description |
|---|---|
| private static final VkImageFormatProperties |
| Access | Constructor and Description |
|---|---|
| public | Buffer(ByteBuffer container)
Creates a new |
| public | |
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| protected VkImageFormatProperties | |
| public int | |
| public VkExtent3D | |
| public int | |
| public long | |
| public int | |
| protected VkImageFormatProperties. |
| ELEMENT_FACTORY | back to summary |
|---|---|
| private static final VkImageFormatProperties ELEMENT_FACTORY | |
| Buffer | back to summary |
|---|---|
| public Buffer(ByteBuffer container) Creates a new Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
by The created buffer instance holds a strong reference to the container object. | |
| Buffer | back to summary |
|---|---|
| public Buffer(long address, int cap) | |
| Buffer | back to summary |
|---|---|
| pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) | |
| getElementFactory | back to summary |
|---|---|
| protected VkImageFormatProperties getElementFactory() Implements abstract org.
| |
| maxArrayLayers | back to summary |
|---|---|
public int maxArrayLayers()
| |
| maxExtent | back to summary |
|---|---|
public VkExtent3D maxExtent()
| |
| maxMipLevels | back to summary |
|---|---|
public int maxMipLevels()
| |
| maxResourceSize | back to summary |
|---|---|
public long maxResourceSize()
| |
| sampleCounts | back to summary |
|---|---|
public int sampleCounts()
| |
| self | back to summary |
|---|---|
| protected VkImageFormatProperties. Implements abstract org.
| |