Package org.lwjgl.vulkan
Class VkPhysicalDeviceImageFormatInfo2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceImageFormatInfo2
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPhysicalDeviceImageFormatInfo2KHR
public class VkPhysicalDeviceImageFormatInfo2 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying image creation parameters.Description
The members of
VkPhysicalDeviceImageFormatInfo2correspond to the arguments toGetPhysicalDeviceImageFormatProperties, withsTypeandpNextadded for extensibility.Valid Usage
tilingmust beIMAGE_TILING_DRM_FORMAT_MODIFIER_EXTif and only if thepNextchain containsVkPhysicalDeviceImageDrmFormatModifierInfoEXT.- If
tilingisIMAGE_TILING_DRM_FORMAT_MODIFIER_EXTandflagscontainsIMAGE_CREATE_MUTABLE_FORMAT_BIT, then thepNextchain must containVkImageFormatListCreateInfoKHRwith 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 ofVkImageFormatListCreateInfoKHR,VkImageStencilUsageCreateInfoEXT,VkPhysicalDeviceExternalImageFormatInfo,VkPhysicalDeviceImageDrmFormatModifierInfoEXT, orVkPhysicalDeviceImageViewImageFormatInfoEXT - Each
sTypemember 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,GetPhysicalDeviceImageFormatProperties2KHRMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure. ThepNextchain ofVkPhysicalDeviceImageFormatInfo2is used to provide additional image parameters tovkGetPhysicalDeviceImageFormatProperties2.format– aVkFormatvalue indicating the image format, corresponding toVkImageCreateInfo::format.type– aVkImageTypevalue indicating the image type, corresponding toVkImageCreateInfo::imageType.tiling– aVkImageTilingvalue indicating the image tiling, corresponding toVkImageCreateInfo::tiling.usage– a bitmask ofVkImageUsageFlagBitsindicating the intended usage of the image, corresponding toVkImageCreateInfo::usage.flags– a bitmask ofVkImageCreateFlagBitsindicating additional parameters of the image, corresponding toVkImageCreateInfo::flags.
Layout
struct VkPhysicalDeviceImageFormatInfo2 { VkStructureType sType; void const * pNext; VkFormat format; VkImageType type; VkImageTiling tiling; VkImageUsageFlags usage; VkImageCreateFlags flags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPhysicalDeviceImageFormatInfo2.BufferAn array ofVkPhysicalDeviceImageFormatInfo2structs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceImageFormatInfo2(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceImageFormatInfo2instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceImageFormatInfo2calloc()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemCalloc.static VkPhysicalDeviceImageFormatInfo2.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceImageFormatInfo2callocStack()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2.BuffercallocStack(int capacity)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2callocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2create()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withBufferUtils.static VkPhysicalDeviceImageFormatInfo2.Buffercreate(int capacity)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceImageFormatInfo2create(long address)Returns a newVkPhysicalDeviceImageFormatInfo2instance for the specified memory address.static VkPhysicalDeviceImageFormatInfo2.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceImageFormatInfo2.Bufferinstance at the specified memory.static VkPhysicalDeviceImageFormatInfo2createSafe(long address)static VkPhysicalDeviceImageFormatInfo2.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkPhysicalDeviceImageFormatInfo2flags(int value)Sets the specified value to theflagsfield.intformat()Returns the value of theformatfield.VkPhysicalDeviceImageFormatInfo2format(int value)Sets the specified value to theformatfield.static VkPhysicalDeviceImageFormatInfo2malloc()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemAlloc.static VkPhysicalDeviceImageFormatInfo2.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceImageFormatInfo2mallocStack()Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the thread-localMemoryStack.static VkPhysicalDeviceImageFormatInfo2.BuffermallocStack(int capacity)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceImageFormatInfo2.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceImageFormatInfo2mallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStack.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()Returns the value of thepNextfield.VkPhysicalDeviceImageFormatInfo2pNext(long value)Sets the specified value to thepNextfield.VkPhysicalDeviceImageFormatInfo2set(int sType, long pNext, int format, int type, int tiling, int usage, int flags)Initializes this struct with the specified values.VkPhysicalDeviceImageFormatInfo2set(VkPhysicalDeviceImageFormatInfo2 src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkPhysicalDeviceImageFormatInfo2sType(int value)Sets the specified value to thesTypefield.inttiling()Returns the value of thetilingfield.VkPhysicalDeviceImageFormatInfo2tiling(int value)Sets the specified value to thetilingfield.inttype()Returns the value of thetypefield.VkPhysicalDeviceImageFormatInfo2type(int value)Sets the specified value to thetypefield.intusage()Returns the value of theusagefield.VkPhysicalDeviceImageFormatInfo2usage(int value)Sets the specified value to theusagefield.
-
-
-
Constructor Detail
-
VkPhysicalDeviceImageFormatInfo2
public VkPhysicalDeviceImageFormatInfo2(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
format
public int format()
Returns the value of theformatfield.
-
type
public int type()
Returns the value of thetypefield.
-
tiling
public int tiling()
Returns the value of thetilingfield.
-
usage
public int usage()
Returns the value of theusagefield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
sType
public VkPhysicalDeviceImageFormatInfo2 sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPhysicalDeviceImageFormatInfo2 pNext(long value)
Sets the specified value to thepNextfield.
-
format
public VkPhysicalDeviceImageFormatInfo2 format(int value)
Sets the specified value to theformatfield.
-
type
public VkPhysicalDeviceImageFormatInfo2 type(int value)
Sets the specified value to thetypefield.
-
tiling
public VkPhysicalDeviceImageFormatInfo2 tiling(int value)
Sets the specified value to thetilingfield.
-
usage
public VkPhysicalDeviceImageFormatInfo2 usage(int value)
Sets the specified value to theusagefield.
-
flags
public VkPhysicalDeviceImageFormatInfo2 flags(int value)
Sets the specified value to theflagsfield.
-
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
public VkPhysicalDeviceImageFormatInfo2 set(VkPhysicalDeviceImageFormatInfo2 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceImageFormatInfo2 malloc()
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceImageFormatInfo2 calloc()
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceImageFormatInfo2 create()
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceImageFormatInfo2 create(long address)
Returns a newVkPhysicalDeviceImageFormatInfo2instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceImageFormatInfo2 createSafe(long address)
-
malloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceImageFormatInfo2.Buffer create(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceImageFormatInfo2.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceImageFormatInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceImageFormatInfo2.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPhysicalDeviceImageFormatInfo2 mallocStack()
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2 callocStack()
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceImageFormatInfo2.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceImageFormatInfo2.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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.
-
-