Package org.lwjgl.vulkan
Class VkImageFormatListCreateInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageFormatListCreateInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkImageFormatListCreateInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specify that an image can be used with a particular set of formats.Description
If
viewFormatCount
is zero,pViewFormats
is ignored and the image is created as if theVkImageFormatListCreateInfoKHR
structure were not included in thepNext
list ofVkImageCreateInfo
.Valid Usage
- If
viewFormatCount
is not 0, all of the formats in thepViewFormats
array must be compatible with the format specified in theformat
field ofVkImageCreateInfo
, as described in the compatibility table. - If
VkImageCreateInfo
::flags
does not containIMAGE_CREATE_MUTABLE_FORMAT_BIT
,viewFormatCount
must be 0 or 1. - If
viewFormatCount
is not 0,VkImageCreateInfo
::format
must be inpViewFormats
.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO_KHR
- If
viewFormatCount
is not 0,pViewFormats
must be a valid pointer to an array ofviewFormatCount
validVkFormat
values
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.viewFormatCount
– the number of entries in thepViewFormats
array.pViewFormats
– an array which lists of all formats which can be used when creating views of this image.
Layout
struct VkImageFormatListCreateInfoKHR { VkStructureType sType; void const * pNext; uint32_t viewFormatCount; VkFormat const * pViewFormats; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImageFormatListCreateInfoKHR.Buffer
An array ofVkImageFormatListCreateInfoKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PNEXT
PVIEWFORMATSThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
VIEWFORMATCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageFormatListCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkImageFormatListCreateInfoKHR
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 VkImageFormatListCreateInfoKHR
calloc()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withmemCalloc
.static VkImageFormatListCreateInfoKHR.Buffer
calloc(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withmemCalloc
.static VkImageFormatListCreateInfoKHR
callocStack()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatListCreateInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatListCreateInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatListCreateInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatListCreateInfoKHR
create()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withBufferUtils
.static VkImageFormatListCreateInfoKHR.Buffer
create(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withBufferUtils
.static VkImageFormatListCreateInfoKHR
create(long address)
Returns a newVkImageFormatListCreateInfoKHR
instance for the specified memory address.static VkImageFormatListCreateInfoKHR.Buffer
create(long address, int capacity)
Create aVkImageFormatListCreateInfoKHR.Buffer
instance at the specified memory.static VkImageFormatListCreateInfoKHR
createSafe(long address)
static VkImageFormatListCreateInfoKHR.Buffer
createSafe(long address, int capacity)
static VkImageFormatListCreateInfoKHR
malloc()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withmemAlloc
.static VkImageFormatListCreateInfoKHR.Buffer
malloc(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withmemAlloc
.static VkImageFormatListCreateInfoKHR
mallocStack()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the thread-localMemoryStack
.static VkImageFormatListCreateInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageFormatListCreateInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageFormatListCreateInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the specifiedMemoryStack
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.IntBuffer
npViewFormats(long struct)
Unsafe version ofpViewFormats
.static void
npViewFormats(long struct, java.nio.IntBuffer value)
Unsafe version ofpViewFormats
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nviewFormatCount(long struct)
Unsafe version ofviewFormatCount()
.static void
nviewFormatCount(long struct, int value)
Sets the specified value to theviewFormatCount
field of the specifiedstruct
.long
pNext()
Returns the value of thepNext
field.VkImageFormatListCreateInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.java.nio.IntBuffer
pViewFormats()
Returns aIntBuffer
view of the data pointed to by thepViewFormats
field.VkImageFormatListCreateInfoKHR
pViewFormats(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepViewFormats
field.VkImageFormatListCreateInfoKHR
set(int sType, long pNext, java.nio.IntBuffer pViewFormats)
Initializes this struct with the specified values.VkImageFormatListCreateInfoKHR
set(VkImageFormatListCreateInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkImageFormatListCreateInfoKHR
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.int
viewFormatCount()
Returns the value of theviewFormatCount
field.
-
-
-
Constructor Detail
-
VkImageFormatListCreateInfoKHR
public VkImageFormatListCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkImageFormatListCreateInfoKHR
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.
-
viewFormatCount
public int viewFormatCount()
Returns the value of theviewFormatCount
field.
-
pViewFormats
@Nullable public java.nio.IntBuffer pViewFormats()
Returns aIntBuffer
view of the data pointed to by thepViewFormats
field.
-
sType
public VkImageFormatListCreateInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImageFormatListCreateInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
pViewFormats
public VkImageFormatListCreateInfoKHR pViewFormats(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepViewFormats
field.
-
set
public VkImageFormatListCreateInfoKHR set(int sType, long pNext, @Nullable java.nio.IntBuffer pViewFormats)
Initializes this struct with the specified values.
-
set
public VkImageFormatListCreateInfoKHR set(VkImageFormatListCreateInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageFormatListCreateInfoKHR malloc()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageFormatListCreateInfoKHR calloc()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageFormatListCreateInfoKHR create()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkImageFormatListCreateInfoKHR create(long address)
Returns a newVkImageFormatListCreateInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageFormatListCreateInfoKHR createSafe(long address)
-
malloc
public static VkImageFormatListCreateInfoKHR.Buffer malloc(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageFormatListCreateInfoKHR.Buffer calloc(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatListCreateInfoKHR.Buffer create(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatListCreateInfoKHR.Buffer create(long address, int capacity)
Create aVkImageFormatListCreateInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImageFormatListCreateInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageFormatListCreateInfoKHR mallocStack()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageFormatListCreateInfoKHR callocStack()
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageFormatListCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageFormatListCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageFormatListCreateInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageFormatListCreateInfoKHR.Buffer callocStack(int capacity)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageFormatListCreateInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageFormatListCreateInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoKHR.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()
.
-
nviewFormatCount
public static int nviewFormatCount(long struct)
Unsafe version ofviewFormatCount()
.
-
npViewFormats
@Nullable public static java.nio.IntBuffer npViewFormats(long struct)
Unsafe version ofpViewFormats
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nviewFormatCount
public static void nviewFormatCount(long struct, int value)
Sets the specified value to theviewFormatCount
field of the specifiedstruct
.
-
npViewFormats
public static void npViewFormats(long struct, @Nullable java.nio.IntBuffer value)
Unsafe version ofpViewFormats
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-