Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageFormatListCreateInfo

extends Struct<VkImageFormatListCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkImageFormatListCreateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 the VkImageFormatListCreateInfo structure were not included in the pNext chain of VkImageCreateInfo.

Valid Usage (Implicit)

Layout


struct VkImageFormatListCreateInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t viewFormatCount;
    VkFormat const * pViewFormats;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PVIEWFORMATS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
VIEWFORMATCOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImageFormatListCreateInfo(long address, ByteBuffer container)

public
VkImageFormatListCreateInfo(ByteBuffer container)

Creates a VkImageFormatListCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImageFormatListCreateInfo
calloc()

Returns a new VkImageFormatListCreateInfo instance allocated with memCalloc.

public static VkImageFormatListCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with memCalloc.

public static VkImageFormatListCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImageFormatListCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkImageFormatListCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkImageFormatListCreateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImageFormatListCreateInfo
create()

Returns a new VkImageFormatListCreateInfo instance allocated with BufferUtils.

public static VkImageFormatListCreateInfo
create(long address)

Returns a new VkImageFormatListCreateInfo instance for the specified memory address.

public static VkImageFormatListCreateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with BufferUtils.

public static VkImageFormatListCreateInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkImageFormatListCreateInfo.Buffer instance at the specified memory.

public static VkImageFormatListCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImageFormatListCreateInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkImageFormatListCreateInfo
malloc()

Returns a new VkImageFormatListCreateInfo instance allocated with memAlloc.

public static VkImageFormatListCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with memAlloc.

public static VkImageFormatListCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImageFormatListCreateInfo instance allocated on the specified MemoryStack.

public static VkImageFormatListCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated on the specified MemoryStack.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static IntBuffer
npViewFormats(long struct)

Unsafe version of pViewFormats.

public static void
npViewFormats(long struct, IntBuffer value)

Unsafe version of pViewFormats.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nviewFormatCount(long struct)

Unsafe version of viewFormatCount.

public static void
nviewFormatCount(long struct, int value)

Sets the specified value to the viewFormatCount field of the specified struct.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageFormatListCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public IntBuffer
pViewFormats()

a pointer to an array of VkFormat values specifying all formats which can be used when creating views of this image.

public VkImageFormatListCreateInfo
pViewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the pViewFormats field.

public VkImageFormatListCreateInfo
set(int sType, long pNext, IntBuffer pViewFormats)

Initializes this struct with the specified values.

public VkImageFormatListCreateInfo

Returns:

this struct
set
(VkImageFormatListCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImageFormatListCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkImageFormatListCreateInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
viewFormatCount()

the number of entries in the pViewFormats array.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PVIEWFORMATSback to summary
public static final int PVIEWFORMATS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

VIEWFORMATCOUNTback to summary
public static final int VIEWFORMATCOUNT

The struct member offsets.

Constructor Detail

VkImageFormatListCreateInfoback to summary
protected VkImageFormatListCreateInfo(long address, ByteBuffer container)
VkImageFormatListCreateInfoback to summary
public VkImageFormatListCreateInfo(ByteBuffer container)

Creates a VkImageFormatListCreateInfo instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkImageFormatListCreateInfo calloc()

Returns a new VkImageFormatListCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkImageFormatListCreateInfo.Buffer calloc(int capacity)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageFormatListCreateInfo calloc(MemoryStack stack)

Returns a new VkImageFormatListCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImageFormatListCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkImageFormatListCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImageFormatListCreateInfo create()

Returns a new VkImageFormatListCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkImageFormatListCreateInfo create(long address)

Returns a new VkImageFormatListCreateInfo instance for the specified memory address.

createback to summary
public static VkImageFormatListCreateInfo.Buffer create(int capacity)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkImageFormatListCreateInfo.Buffer create(long address, int capacity)

Create a VkImageFormatListCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageFormatListCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImageFormatListCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkImageFormatListCreateInfo malloc()

Returns a new VkImageFormatListCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkImageFormatListCreateInfo.Buffer malloc(int capacity)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageFormatListCreateInfo malloc(MemoryStack stack)

Returns a new VkImageFormatListCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImageFormatListCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkImageFormatListCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npViewFormatsback to summary
public static IntBuffer npViewFormats(long struct)

Unsafe version of pViewFormats.

Annotations
@Nullable
npViewFormatsback to summary
public static void npViewFormats(long struct, IntBuffer value)

Unsafe version of pViewFormats.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nviewFormatCountback to summary
public static int nviewFormatCount(long struct)

Unsafe version of viewFormatCount.

nviewFormatCountback to summary
public static void nviewFormatCount(long struct, int value)

Sets the specified value to the viewFormatCount field of the specified struct.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageFormatListCreateInfo pNext(long value)

Sets the specified value to the pNext field.

pViewFormatsback to summary
public IntBuffer pViewFormats()

a pointer to an array of VkFormat values specifying all formats which can be used when creating views of this image.

Annotations
@Nullable
@NativeType:VkFormat const *
pViewFormatsback to summary
public VkImageFormatListCreateInfo pViewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the pViewFormats field.

setback to summary
public VkImageFormatListCreateInfo set(int sType, long pNext, IntBuffer pViewFormats)

Initializes this struct with the specified values.

setback to summary
public VkImageFormatListCreateInfo set(VkImageFormatListCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkImageFormatListCreateInfo

the source struct

Returns:VkImageFormatListCreateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageFormatListCreateInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImageFormatListCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

viewFormatCountback to summary
public int viewFormatCount()

the number of entries in the pViewFormats array.

Annotations
@NativeType:uint32_t
org.lwjgl.vulkan back to summary

public Class VkImageFormatListCreateInfo.Buffer

extends StructBuffer<VkImageFormatListCreateInfo, VkImageFormatListCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkImageFormatListCreateInfoKHR.Buffer

An array of VkImageFormatListCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageFormatListCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageFormatListCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkImageFormatListCreateInfo
public long

Returns:

the value of the VkImageFormatListCreateInfo#pNext field.
pNext
()

public VkImageFormatListCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkImageFormatListCreateInfo#pNext field.

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkImageFormatListCreateInfo#pViewFormats field.
pViewFormats
()

public VkImageFormatListCreateInfo.Buffer
pViewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the VkImageFormatListCreateInfo#pViewFormats field.

protected VkImageFormatListCreateInfo.Buffer
public int

Returns:

the value of the VkImageFormatListCreateInfo#sType field.
sType
()

public VkImageFormatListCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkImageFormatListCreateInfo#sType field.

public VkImageFormatListCreateInfo.Buffer
public int
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageFormatListCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageFormatListCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImageFormatListCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkImageFormatListCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkImageFormatListCreateInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageFormatListCreateInfo.Buffer pNext(long value)

Sets the specified value to the VkImageFormatListCreateInfo#pNext field.

pViewFormatsback to summary
public IntBuffer pViewFormats()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkImageFormatListCreateInfo#pViewFormats field.

Annotations
@Nullable
@NativeType:VkFormat const *
pViewFormatsback to summary
public VkImageFormatListCreateInfo.Buffer pViewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the VkImageFormatListCreateInfo#pViewFormats field.

selfback to summary
protected VkImageFormatListCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImageFormatListCreateInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageFormatListCreateInfo.Buffer sType(int value)

Sets the specified value to the VkImageFormatListCreateInfo#sType field.

sType$Defaultback to summary
public VkImageFormatListCreateInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO value to the VkImageFormatListCreateInfo#sType field.

viewFormatCountback to summary
public int viewFormatCount()
Returns:int

the value of the VkImageFormatListCreateInfo#viewFormatCount field.

Annotations
@NativeType:uint32_t