Package org.lwjgl.vulkan
Class VkPhysicalDeviceImageFormatInfo2
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceImageFormatInfo2>
org.lwjgl.vulkan.VkPhysicalDeviceImageFormatInfo2
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPhysicalDeviceImageFormatInfo2KHR
public class VkPhysicalDeviceImageFormatInfo2
extends org.lwjgl.system.Struct<VkPhysicalDeviceImageFormatInfo2>
implements org.lwjgl.system.NativeResource
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
tilingmust beIMAGE_TILING_DRM_FORMAT_MODIFIER_EXTif and only if thepNextchain includesVkPhysicalDeviceImageDrmFormatModifierInfoEXT- If
tilingisIMAGE_TILING_DRM_FORMAT_MODIFIER_EXTandflagscontainsIMAGE_CREATE_MUTABLE_FORMAT_BIT, then thepNextchain must include aVkImageFormatListCreateInfostructure with non-zeroviewFormatCount
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkImageCompressionControlEXT,VkImageFormatListCreateInfo,VkImageStencilUsageCreateInfo,VkOpticalFlowImageFormatInfoNV,VkPhysicalDeviceExternalImageFormatInfo,VkPhysicalDeviceImageDrmFormatModifierInfoEXT,VkPhysicalDeviceImageViewImageFormatInfoEXT, orVkVideoProfileListInfoKHR - The
sTypevalue of each struct in thepNextchain must be unique formatmust be a validVkFormatvaluetypemust be a validVkImageTypevaluetilingmust be a validVkImageTilingvalueusagemust be a valid combination ofVkImageUsageFlagBitsvaluesusagemust not be 0flagsmust be a valid combination ofVkImageCreateFlagBitsvalues
See Also
GetPhysicalDeviceImageFormatProperties2, GetPhysicalDeviceImageFormatProperties2KHR
Layout
struct VkPhysicalDeviceImageFormatInfo2 {
VkStructureType sType();
void const * pNext();
VkFormat format();
VkImageType type();
VkImageTiling tiling();
VkImageUsageFlags usage();
VkImageCreateFlags flags();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPhysicalDeviceImageFormatInfo2structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPhysicalDeviceImageFormatInfo2(ByteBuffer container) Creates aVkPhysicalDeviceImageFormatInfo2instance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemCalloc.calloc(int capacity) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withBufferUtils.create(int capacity) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPhysicalDeviceImageFormatInfo2instance for the specified memory address.create(long address, int capacity) Create aVkPhysicalDeviceImageFormatInfo2.Bufferinstance at the specified memory.static @Nullable VkPhysicalDeviceImageFormatInfo2createSafe(long address) static @Nullable VkPhysicalDeviceImageFormatInfo2.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkImageCreateFlagBitsindicating additional parameters of the image, corresponding toVkImageCreateInfo::flags.flags(int value) Sets the specified value to theflags()field.intformat()format(int value) Sets the specified value to theformat()field.malloc()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemAlloc.malloc(int capacity) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intnformat(long struct) Unsafe version offormat().static voidnformat(long struct, int value) Unsafe version offormat.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntiling(long struct) Unsafe version oftiling().static voidntiling(long struct, int value) Unsafe version oftiling.static intntype(long struct) Unsafe version oftype().static voidntype(long struct, int value) Unsafe version oftype.static intnusage(long struct) Unsafe version ofusage().static voidnusage(long struct, int value) Unsafe version ofusage.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkImageCompressionControlEXTvalue to thepNextchain.pNext(VkImageFormatListCreateInfo value) Prepends the specifiedVkImageFormatListCreateInfovalue to thepNextchain.Prepends the specifiedVkImageFormatListCreateInfoKHRvalue to thepNextchain.Prepends the specifiedVkImageStencilUsageCreateInfovalue to thepNextchain.Prepends the specifiedVkImageStencilUsageCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkOpticalFlowImageFormatInfoNVvalue to thepNextchain.Prepends the specifiedVkPhysicalDeviceExternalImageFormatInfovalue to thepNextchain.Prepends the specifiedVkPhysicalDeviceExternalImageFormatInfoKHRvalue to thepNextchain.Prepends the specifiedVkPhysicalDeviceImageDrmFormatModifierInfoEXTvalue to thepNextchain.Prepends the specifiedVkPhysicalDeviceImageViewImageFormatInfoEXTvalue to thepNextchain.pNext(VkVideoProfileListInfoKHR value) Prepends the specifiedVkVideoProfileListInfoKHRvalue to thepNextchain.set(int sType, long pNext, int format, int type, int tiling, int usage, int flags) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2value to thesType()field.inttiling()tiling(int value) Sets the specified value to thetiling()field.inttype()type(int value) Sets the specified value to thetype()field.intusage()a bitmask ofVkImageUsageFlagBitsindicating the intended usage of the image, corresponding toVkImageCreateInfo::usage.usage(int value) Sets the specified value to theusage()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FORMAT
public static final int FORMATThe struct member offsets. -
TYPE
public static final int TYPEThe struct member offsets. -
TILING
public static final int TILINGThe struct member offsets. -
USAGE
public static final int USAGEThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceImageFormatInfo2
Creates aVkPhysicalDeviceImageFormatInfo2instance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPhysicalDeviceImageFormatInfo2>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. ThepNextchain ofVkPhysicalDeviceImageFormatInfo2is used to provide additional image parameters tovkGetPhysicalDeviceImageFormatProperties2. -
format
public int format() -
type
public int type() -
tiling
public int tiling() -
usage
public int usage()a bitmask ofVkImageUsageFlagBitsindicating the intended usage of the image, corresponding toVkImageCreateInfo::usage. -
flags
public int flags()a bitmask ofVkImageCreateFlagBitsindicating additional parameters of the image, corresponding toVkImageCreateInfo::flags. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2value to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkImageCompressionControlEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkImageFormatListCreateInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkImageStencilUsageCreateInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkOpticalFlowImageFormatInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkPhysicalDeviceExternalImageFormatInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkPhysicalDeviceExternalImageFormatInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkPhysicalDeviceImageDrmFormatModifierInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkPhysicalDeviceImageViewImageFormatInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoProfileListInfoKHRvalue to thepNextchain. -
format
Sets the specified value to theformat()field. -
type
Sets the specified value to thetype()field. -
tiling
Sets the specified value to thetiling()field. -
usage
Sets the specified value to theusage()field. -
flags
Sets the specified value to theflags()field. -
set
public VkPhysicalDeviceImageFormatInfo2 set(int sType, long pNext, int format, int type, int tiling, int usage, int flags) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withBufferUtils. -
create
Returns a newVkPhysicalDeviceImageFormatInfo2instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPhysicalDeviceImageFormatInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPhysicalDeviceImageFormatInfo2.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPhysicalDeviceImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceImageFormatInfo2.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPhysicalDeviceImageFormatInfo2.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nformat
public static int nformat(long struct) Unsafe version offormat(). -
ntype
public static int ntype(long struct) Unsafe version oftype(). -
ntiling
public static int ntiling(long struct) Unsafe version oftiling(). -
nusage
public static int nusage(long struct) Unsafe version ofusage(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nformat
public static void nformat(long struct, int value) Unsafe version offormat. -
ntype
public static void ntype(long struct, int value) Unsafe version oftype. -
ntiling
public static void ntiling(long struct, int value) Unsafe version oftiling. -
nusage
public static void nusage(long struct, int value) Unsafe version ofusage. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags.
-