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.NativeResource
Structure specifying image creation parameters.Description
The members of
VkPhysicalDeviceImageFormatInfo2
correspond to the arguments toGetPhysicalDeviceImageFormatProperties
, withsType
andpNext
added for extensibility.Valid Usage
tiling
must beIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
if and only if thepNext
chain containsVkPhysicalDeviceImageDrmFormatModifierInfoEXT
.- If
tiling
isIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
andflags
containsIMAGE_CREATE_MUTABLE_FORMAT_BIT
, then thepNext
chain must containVkImageFormatListCreateInfoKHR
with non-zeroviewFormatCount
.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkImageFormatListCreateInfoKHR
,VkImageStencilUsageCreateInfoEXT
,VkPhysicalDeviceExternalImageFormatInfo
,VkPhysicalDeviceImageDrmFormatModifierInfoEXT
, orVkPhysicalDeviceImageViewImageFormatInfoEXT
- Each
sType
member in thepNext
chain must be unique format
must be a validVkFormat
valuetype
must be a validVkImageType
valuetiling
must be a validVkImageTiling
valueusage
must be a valid combination ofVkImageUsageFlagBits
valuesusage
must not be 0flags
must be a valid combination ofVkImageCreateFlagBits
values
See Also
GetPhysicalDeviceImageFormatProperties2
,GetPhysicalDeviceImageFormatProperties2KHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure. ThepNext
chain ofVkPhysicalDeviceImageFormatInfo2
is used to provide additional image parameters tovkGetPhysicalDeviceImageFormatProperties2
.format
– aVkFormat
value indicating the image format, corresponding toVkImageCreateInfo
::format
.type
– aVkImageType
value indicating the image type, corresponding toVkImageCreateInfo
::imageType
.tiling
– aVkImageTiling
value indicating the image tiling, corresponding toVkImageCreateInfo
::tiling
.usage
– a bitmask ofVkImageUsageFlagBits
indicating the intended usage of the image, corresponding toVkImageCreateInfo
::usage
.flags
– a bitmask ofVkImageCreateFlagBits
indicating 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 class
VkPhysicalDeviceImageFormatInfo2.Buffer
An array ofVkPhysicalDeviceImageFormatInfo2
structs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceImageFormatInfo2(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceImageFormatInfo2
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceImageFormatInfo2
calloc()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated withmemCalloc
.static VkPhysicalDeviceImageFormatInfo2.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceImageFormatInfo2
callocStack()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceImageFormatInfo2
create()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated withBufferUtils
.static VkPhysicalDeviceImageFormatInfo2.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceImageFormatInfo2
create(long address)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance for the specified memory address.static VkPhysicalDeviceImageFormatInfo2.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceImageFormatInfo2.Buffer
instance at the specified memory.static VkPhysicalDeviceImageFormatInfo2
createSafe(long address)
static VkPhysicalDeviceImageFormatInfo2.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkPhysicalDeviceImageFormatInfo2
flags(int value)
Sets the specified value to theflags
field.int
format()
Returns the value of theformat
field.VkPhysicalDeviceImageFormatInfo2
format(int value)
Sets the specified value to theformat
field.static VkPhysicalDeviceImageFormatInfo2
malloc()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated withmemAlloc
.static VkPhysicalDeviceImageFormatInfo2.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceImageFormatInfo2
mallocStack()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceImageFormatInfo2.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceImageFormatInfo2.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceImageFormatInfo2
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
nformat(long struct)
Unsafe version offormat()
.static void
nformat(long struct, int value)
Unsafe version offormat
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
ntiling(long struct)
Unsafe version oftiling()
.static void
ntiling(long struct, int value)
Unsafe version oftiling
.static int
ntype(long struct)
Unsafe version oftype()
.static void
ntype(long struct, int value)
Unsafe version oftype
.static int
nusage(long struct)
Unsafe version ofusage()
.static void
nusage(long struct, int value)
Unsafe version ofusage
.long
pNext()
Returns the value of thepNext
field.VkPhysicalDeviceImageFormatInfo2
pNext(long value)
Sets the specified value to thepNext
field.VkPhysicalDeviceImageFormatInfo2
set(int sType, long pNext, int format, int type, int tiling, int usage, int flags)
Initializes this struct with the specified values.VkPhysicalDeviceImageFormatInfo2
set(VkPhysicalDeviceImageFormatInfo2 src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPhysicalDeviceImageFormatInfo2
sType(int value)
Sets the specified value to thesType
field.int
tiling()
Returns the value of thetiling
field.VkPhysicalDeviceImageFormatInfo2
tiling(int value)
Sets the specified value to thetiling
field.int
type()
Returns the value of thetype
field.VkPhysicalDeviceImageFormatInfo2
type(int value)
Sets the specified value to thetype
field.int
usage()
Returns the value of theusage
field.VkPhysicalDeviceImageFormatInfo2
usage(int value)
Sets the specified value to theusage
field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceImageFormatInfo2
public VkPhysicalDeviceImageFormatInfo2(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceImageFormatInfo2
instance at the current position of the specifiedByteBuffer
container. 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:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
format
public int format()
Returns the value of theformat
field.
-
type
public int type()
Returns the value of thetype
field.
-
tiling
public int tiling()
Returns the value of thetiling
field.
-
usage
public int usage()
Returns the value of theusage
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
sType
public VkPhysicalDeviceImageFormatInfo2 sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPhysicalDeviceImageFormatInfo2 pNext(long value)
Sets the specified value to thepNext
field.
-
format
public VkPhysicalDeviceImageFormatInfo2 format(int value)
Sets the specified value to theformat
field.
-
type
public VkPhysicalDeviceImageFormatInfo2 type(int value)
Sets the specified value to thetype
field.
-
tiling
public VkPhysicalDeviceImageFormatInfo2 tiling(int value)
Sets the specified value to thetiling
field.
-
usage
public VkPhysicalDeviceImageFormatInfo2 usage(int value)
Sets the specified value to theusage
field.
-
flags
public VkPhysicalDeviceImageFormatInfo2 flags(int value)
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
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 newVkPhysicalDeviceImageFormatInfo2
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceImageFormatInfo2 calloc()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceImageFormatInfo2 create()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceImageFormatInfo2 create(long address)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceImageFormatInfo2 createSafe(long address)
-
malloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceImageFormatInfo2.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceImageFormatInfo2.Buffer create(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceImageFormatInfo2.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceImageFormatInfo2.Buffer
instance 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 newVkPhysicalDeviceImageFormatInfo2
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2 callocStack()
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceImageFormatInfo2
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceImageFormatInfo2.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-