LWJGL 3.3.3 · org.lwjgl.vulkan.VkPhysicalDeviceImageFormatInfo2

Structure specifying image creation parameters.

Description

The members of VkPhysicalDeviceImageFormatInfo2 correspond to the arguments to GetPhysicalDeviceImageFormatProperties, with sType and pNext added for extensibility.

Valid Usage

tiling must be IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT if and only if the pNext chain includes VkPhysicalDeviceImageDrmFormatModifierInfoEXT
If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT and flags contains IMAGE_CREATE_MUTABLE_FORMAT_BIT, then the pNext chain must include a VkImageFormatListCreateInfo structure with non-zero viewFormatCount

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkImageCompressionControlEXT, VkImageFormatListCreateInfo, VkImageStencilUsageCreateInfo, VkOpticalFlowImageFormatInfoNV, VkPhysicalDeviceExternalImageFormatInfo, VkPhysicalDeviceImageDrmFormatModifierInfoEXT, VkPhysicalDeviceImageViewImageFormatInfoEXT, or VkVideoProfileListInfoKHR
The sType value of each struct in the pNext chain must be unique
format must be a valid VkFormat value
type must be a valid VkImageType value
tiling must be a valid VkImageTiling value
usage must be a valid combination of VkImageUsageFlagBits values
usage must not be 0
flags must be a valid combination of VkImageCreateFlagBits values

Layout


struct VkPhysicalDeviceImageFormatInfo2 {
    VkStructureType sType;
    void const * pNext;
    VkFormat format;
    VkImageType type;
    VkImageTiling tiling;
    VkImageUsageFlags usage;
    VkImageCreateFlags flags;
}

Modifier and Type	Class and Description
public static class	VkPhysicalDeviceImageFormatInfo2.Buffer An array of `VkPhysicalDeviceImageFormatInfo2` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	FORMAT The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	TILING The struct member offsets.
public static final int	TYPE The struct member offsets.
public static final int	USAGE The struct member offsets.

Access	Constructor and Description
protected	VkPhysicalDeviceImageFormatInfo2(long address, ByteBuffer container)
public	VkPhysicalDeviceImageFormatInfo2(ByteBuffer container) Creates a `VkPhysicalDeviceImageFormatInfo2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkPhysicalDeviceImageFormatInfo2	calloc() Returns a new `VkPhysicalDeviceImageFormatInfo2` instance allocated with `memCalloc`.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceImageFormatInfo2.Buffer` instance allocated with `memCalloc`.
public static VkPhysicalDeviceImageFormatInfo2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceImageFormatInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceImageFormatInfo2	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceImageFormatInfo2	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkPhysicalDeviceImageFormatInfo2	create() Returns a new `VkPhysicalDeviceImageFormatInfo2` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceImageFormatInfo2	create(long address) Returns a new `VkPhysicalDeviceImageFormatInfo2` instance for the specified memory address.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	create(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceImageFormatInfo2.Buffer` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPhysicalDeviceImageFormatInfo2.Buffer` instance at the specified memory.
public static VkPhysicalDeviceImageFormatInfo2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkImageCreateFlagBits` indicating additional parameters of the image, corresponding to `VkImageCreateInfo::flags`.
public VkPhysicalDeviceImageFormatInfo2	flags(int value) Sets the specified value to the `flags` field.
public int	format() a `VkFormat` value indicating the image format, corresponding to `VkImageCreateInfo::format`.
public VkPhysicalDeviceImageFormatInfo2	format(int value) Sets the specified value to the `format` field.
public static VkPhysicalDeviceImageFormatInfo2	malloc() Returns a new `VkPhysicalDeviceImageFormatInfo2` instance allocated with `memAlloc`.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceImageFormatInfo2.Buffer` instance allocated with `memAlloc`.
public static VkPhysicalDeviceImageFormatInfo2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceImageFormatInfo2` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceImageFormatInfo2	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceImageFormatInfo2.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	nformat(long struct) Unsafe version of `format`.
public static void	nformat(long struct, int value) Unsafe version of `format`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	ntiling(long struct) Unsafe version of `tiling`.
public static void	ntiling(long struct, int value) Unsafe version of `tiling`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public static int	nusage(long struct) Unsafe version of `usage`.
public static void	nusage(long struct, int value) Unsafe version of `usage`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPhysicalDeviceImageFormatInfo2	pNext(long value) Sets the specified value to the `pNext` field.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkImageCompressionControlEXT value) Prepends the specified `VkImageCompressionControlEXT` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkImageFormatListCreateInfo value) Prepends the specified `VkImageFormatListCreateInfo` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkImageFormatListCreateInfoKHR value) Prepends the specified `VkImageFormatListCreateInfoKHR` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkImageStencilUsageCreateInfo value) Prepends the specified `VkImageStencilUsageCreateInfo` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkImageStencilUsageCreateInfoEXT value) Prepends the specified `VkImageStencilUsageCreateInfoEXT` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkOpticalFlowImageFormatInfoNV value) Prepends the specified `VkOpticalFlowImageFormatInfoNV` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkPhysicalDeviceExternalImageFormatInfo value) Prepends the specified `VkPhysicalDeviceExternalImageFormatInfo` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkPhysicalDeviceExternalImageFormatInfoKHR value) Prepends the specified `VkPhysicalDeviceExternalImageFormatInfoKHR` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkPhysicalDeviceImageDrmFormatModifierInfoEXT value) Prepends the specified `VkPhysicalDeviceImageDrmFormatModifierInfoEXT` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkPhysicalDeviceImageViewImageFormatInfoEXT value) Prepends the specified `VkPhysicalDeviceImageViewImageFormatInfoEXT` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	pNext(VkVideoProfileListInfoKHR value) Prepends the specified `VkVideoProfileListInfoKHR` value to the `pNext` chain.
public VkPhysicalDeviceImageFormatInfo2	set(int sType, long pNext, int format, int type, int tiling, int usage, int flags) Initializes this struct with the specified values.
public VkPhysicalDeviceImageFormatInfo2	Returns: this struct set(VkPhysicalDeviceImageFormatInfo2 the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkPhysicalDeviceImageFormatInfo2	sType(int value) Sets the specified value to the `sType` field.
public VkPhysicalDeviceImageFormatInfo2	sType$Default() Sets the `STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2` value to the `sType` field.
public int	tiling() a `VkImageTiling` value indicating the image tiling, corresponding to `VkImageCreateInfo::tiling`.
public VkPhysicalDeviceImageFormatInfo2	tiling(int value) Sets the specified value to the `tiling` field.
public int	type() a `VkImageType` value indicating the image type, corresponding to `VkImageCreateInfo::imageType`.
public VkPhysicalDeviceImageFormatInfo2	type(int value) Sets the specified value to the `type` field.
public int	usage() a bitmask of `VkImageUsageFlagBits` indicating the intended usage of the image, corresponding to `VkImageCreateInfo::usage`.
public VkPhysicalDeviceImageFormatInfo2	usage(int value) Sets the specified value to the `usage` field.

public Class VkPhysicalDeviceImageFormatInfo2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary