Package org.lwjgl.vulkan
Class VkImageFormatListCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageFormatListCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkImageFormatListCreateInfoKHR
public class VkImageFormatListCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceSpecify that an image can be used with a particular set of formats.Description
If
viewFormatCountis zero,pViewFormatsis ignored and the image is created as if theVkImageFormatListCreateInfostructure were not included in thepNextchain ofVkImageCreateInfo.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO- If
viewFormatCountis not 0,pViewFormatsmust be a valid pointer to an array ofviewFormatCountvalidVkFormatvalues
Layout
struct VkImageFormatListCreateInfo { VkStructureTypesType(); void const *pNext(); uint32_tviewFormatCount(); VkFormat const *pViewFormats(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImageFormatListCreateInfo.BufferAn array ofVkImageFormatListCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intPNEXT
PVIEWFORMATSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
VIEWFORMATCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageFormatListCreateInfo(java.nio.ByteBuffer container)Creates aVkImageFormatListCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageFormatListCreateInfocalloc()Returns a newVkImageFormatListCreateInfoinstance allocated withmemCalloc.static VkImageFormatListCreateInfo.Buffercalloc(int capacity)Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withmemCalloc.static VkImageFormatListCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageFormatListCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageFormatListCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageFormatListCreateInfocreate()Returns a newVkImageFormatListCreateInfoinstance allocated withBufferUtils.static VkImageFormatListCreateInfo.Buffercreate(int capacity)Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withBufferUtils.static VkImageFormatListCreateInfocreate(long address)Returns a newVkImageFormatListCreateInfoinstance for the specified memory address.static VkImageFormatListCreateInfo.Buffercreate(long address, int capacity)Create aVkImageFormatListCreateInfo.Bufferinstance at the specified memory.static VkImageFormatListCreateInfocreateSafe(long address)static VkImageFormatListCreateInfo.BuffercreateSafe(long address, int capacity)static VkImageFormatListCreateInfomalloc()Returns a newVkImageFormatListCreateInfoinstance allocated withmemAlloc.static VkImageFormatListCreateInfo.Buffermalloc(int capacity)Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withmemAlloc.static VkImageFormatListCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkImageFormatListCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkImageFormatListCreateInfoinstance allocated on the specifiedMemoryStack.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.IntBuffernpViewFormats(long struct)Unsafe version ofpViewFormats.static voidnpViewFormats(long struct, java.nio.IntBuffer value)Unsafe version ofpViewFormats.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnviewFormatCount(long struct)Unsafe version ofviewFormatCount().static voidnviewFormatCount(long struct, int value)Sets the specified value to theviewFormatCountfield of the specifiedstruct.longpNext()NULLor a pointer to a structure extending this structure.VkImageFormatListCreateInfopNext(long value)Sets the specified value to thepNext()field.java.nio.IntBufferpViewFormats()a pointer to an array ofVkFormatvalues specifying all formats which can be used when creating views of this image.VkImageFormatListCreateInfopViewFormats(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepViewFormats()field.VkImageFormatListCreateInfoset(int sType, long pNext, java.nio.IntBuffer pViewFormats)Initializes this struct with the specified values.VkImageFormatListCreateInfoset(VkImageFormatListCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkImageFormatListCreateInfosType(int value)Sets the specified value to thesType()field.VkImageFormatListCreateInfosType$Default()Sets theSTRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.intviewFormatCount()the number of entries in thepViewFormatsarray.
-
-
-
Constructor Detail
-
VkImageFormatListCreateInfo
public VkImageFormatListCreateInfo(java.nio.ByteBuffer container)
Creates aVkImageFormatListCreateInfoinstance 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()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
viewFormatCount
public int viewFormatCount()
the number of entries in thepViewFormatsarray.
-
pViewFormats
@Nullable public java.nio.IntBuffer pViewFormats()
a pointer to an array ofVkFormatvalues specifying all formats which can be used when creating views of this image.
-
sType
public VkImageFormatListCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkImageFormatListCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFOvalue to thesType()field.
-
pNext
public VkImageFormatListCreateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pViewFormats
public VkImageFormatListCreateInfo pViewFormats(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepViewFormats()field.
-
set
public VkImageFormatListCreateInfo set(int sType, long pNext, @Nullable java.nio.IntBuffer pViewFormats)
Initializes this struct with the specified values.
-
set
public VkImageFormatListCreateInfo set(VkImageFormatListCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkImageFormatListCreateInfo malloc()
Returns a newVkImageFormatListCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageFormatListCreateInfo calloc()
Returns a newVkImageFormatListCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageFormatListCreateInfo create()
Returns a newVkImageFormatListCreateInfoinstance allocated withBufferUtils.
-
create
public static VkImageFormatListCreateInfo create(long address)
Returns a newVkImageFormatListCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkImageFormatListCreateInfo createSafe(long address)
-
malloc
public static VkImageFormatListCreateInfo.Buffer malloc(int capacity)
Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageFormatListCreateInfo.Buffer calloc(int capacity)
Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageFormatListCreateInfo.Buffer create(int capacity)
Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageFormatListCreateInfo.Buffer create(long address, int capacity)
Create aVkImageFormatListCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImageFormatListCreateInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static VkImageFormatListCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkImageFormatListCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageFormatListCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkImageFormatListCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageFormatListCreateInfo.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().
-
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 theviewFormatCountfield 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
-
-