Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindImageMemorySwapchainInfoKHR

extends Struct<VkBindImageMemorySwapchainInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying swapchain image memory to bind to.
Description

If swapchain is not NULL, the swapchain and imageIndex are used to determine the memory that the image is bound to, instead of memory and memoryOffset.

Memory can be bound to a swapchain and use the pDeviceIndices or pSplitInstanceBindRegions members of VkBindImageMemoryDeviceGroupInfo.

Valid Usage
Valid Usage (Implicit)
Host Synchronization

Layout


struct VkBindImageMemorySwapchainInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkSwapchainKHR swapchain;
    uint32_t imageIndex;
}

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
IMAGEINDEX

The struct member offsets.

public static final int
PNEXT

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
SWAPCHAIN

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkBindImageMemorySwapchainInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkBindImageMemorySwapchainInfoKHR
calloc()

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with memCalloc.

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

Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBindImageMemorySwapchainInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkBindImageMemorySwapchainInfoKHR
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 VkBindImageMemorySwapchainInfoKHR
create()

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with BufferUtils.

public static VkBindImageMemorySwapchainInfoKHR
create(long address)

Returns a new VkBindImageMemorySwapchainInfoKHR instance for the specified memory address.

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

Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkBindImageMemorySwapchainInfoKHR.Buffer instance at the specified memory.

public static VkBindImageMemorySwapchainInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageIndex()

an image index within swapchain.

public VkBindImageMemorySwapchainInfoKHR
imageIndex(int value)

Sets the specified value to the imageIndex field.

public static VkBindImageMemorySwapchainInfoKHR
malloc()

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with memAlloc.

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

Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkBindImageMemorySwapchainInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBindImageMemorySwapchainInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nimageIndex(long struct)

Unsafe version of imageIndex.

public static void
nimageIndex(long struct, int value)

Unsafe version of imageIndex.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static long
nswapchain(long struct)

Unsafe version of swapchain.

public static void
nswapchain(long struct, long value)

Unsafe version of swapchain.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBindImageMemorySwapchainInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkBindImageMemorySwapchainInfoKHR
set(int sType, long pNext, long swapchain, int imageIndex)

Initializes this struct with the specified values.

public VkBindImageMemorySwapchainInfoKHR

Returns:

this struct
set
(VkBindImageMemorySwapchainInfoKHR
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 VkBindImageMemorySwapchainInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkBindImageMemorySwapchainInfoKHR
public long
swapchain()

NULL_HANDLE or a swapchain handle.

public VkBindImageMemorySwapchainInfoKHR
swapchain(long value)

Sets the specified value to the swapchain field.

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.

IMAGEINDEXback to summary
public static final int IMAGEINDEX

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

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.

SWAPCHAINback to summary
public static final int SWAPCHAIN

The struct member offsets.

Constructor Detail

VkBindImageMemorySwapchainInfoKHRback to summary
protected VkBindImageMemorySwapchainInfoKHR(long address, ByteBuffer container)
VkBindImageMemorySwapchainInfoKHRback to summary
public VkBindImageMemorySwapchainInfoKHR(ByteBuffer container)

Creates a VkBindImageMemorySwapchainInfoKHR 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 VkBindImageMemorySwapchainInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBindImageMemorySwapchainInfoKHR calloc(MemoryStack stack)

Returns a new VkBindImageMemorySwapchainInfoKHR 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 VkBindImageMemorySwapchainInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkBindImageMemorySwapchainInfoKHR.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

callocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkBindImageMemorySwapchainInfoKHR 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 VkBindImageMemorySwapchainInfoKHR create()

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkBindImageMemorySwapchainInfoKHR create(long address)

Returns a new VkBindImageMemorySwapchainInfoKHR instance for the specified memory address.

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

Returns a new VkBindImageMemorySwapchainInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBindImageMemorySwapchainInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBindImageMemorySwapchainInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageIndexback to summary
public int imageIndex()

an image index within swapchain.

Annotations
@NativeType:uint32_t
imageIndexback to summary
public VkBindImageMemorySwapchainInfoKHR imageIndex(int value)

Sets the specified value to the imageIndex field.

mallocback to summary
public static VkBindImageMemorySwapchainInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBindImageMemorySwapchainInfoKHR malloc(MemoryStack stack)

Returns a new VkBindImageMemorySwapchainInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkBindImageMemorySwapchainInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nimageIndexback to summary
public static int nimageIndex(long struct)

Unsafe version of imageIndex.

nimageIndexback to summary
public static void nimageIndex(long struct, int value)

Unsafe version of imageIndex.

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.

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.

nswapchainback to summary
public static long nswapchain(long struct)

Unsafe version of swapchain.

nswapchainback to summary
public static void nswapchain(long struct, long value)

Unsafe version of swapchain.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkBindImageMemorySwapchainInfoKHR set(int sType, long pNext, long swapchain, int imageIndex)

Initializes this struct with the specified values.

setback to summary
public VkBindImageMemorySwapchainInfoKHR set(VkBindImageMemorySwapchainInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkBindImageMemorySwapchainInfoKHR

the source struct

Returns:VkBindImageMemorySwapchainInfoKHR

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 VkBindImageMemorySwapchainInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR value to the sType field.

swapchainback to summary
public long swapchain()

NULL_HANDLE or a swapchain handle.

Annotations
@NativeType:VkSwapchainKHR
swapchainback to summary
public VkBindImageMemorySwapchainInfoKHR swapchain(long value)

Sets the specified value to the swapchain field.

org.lwjgl.vulkan back to summary

public Class VkBindImageMemorySwapchainInfoKHR.Buffer

extends StructBuffer<VkBindImageMemorySwapchainInfoKHR, VkBindImageMemorySwapchainInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkBindImageMemorySwapchainInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkBindImageMemorySwapchainInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBindImageMemorySwapchainInfoKHR.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 VkBindImageMemorySwapchainInfoKHR
public int

Returns:

the value of the VkBindImageMemorySwapchainInfoKHR#imageIndex field.
imageIndex
()

public VkBindImageMemorySwapchainInfoKHR.Buffer
imageIndex(int value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#imageIndex field.

public long

Returns:

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

public VkBindImageMemorySwapchainInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#pNext field.

protected VkBindImageMemorySwapchainInfoKHR.Buffer
public int

Returns:

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

public VkBindImageMemorySwapchainInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#sType field.

public VkBindImageMemorySwapchainInfoKHR.Buffer
public long

Returns:

the value of the VkBindImageMemorySwapchainInfoKHR#swapchain field.
swapchain
()

public VkBindImageMemorySwapchainInfoKHR.Buffer
swapchain(long value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#swapchain field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBindImageMemorySwapchainInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkBindImageMemorySwapchainInfoKHR.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 VkBindImageMemorySwapchainInfoKHR#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 VkBindImageMemorySwapchainInfoKHR getElementFactory()

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

Annotations
@Override
imageIndexback to summary
public int imageIndex()
Returns:int

the value of the VkBindImageMemorySwapchainInfoKHR#imageIndex field.

Annotations
@NativeType:uint32_t
imageIndexback to summary
public VkBindImageMemorySwapchainInfoKHR.Buffer imageIndex(int value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#imageIndex field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkBindImageMemorySwapchainInfoKHR#pNext field.

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

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#pNext field.

selfback to summary
protected VkBindImageMemorySwapchainInfoKHR.Buffer self()

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

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

the value of the VkBindImageMemorySwapchainInfoKHR#sType field.

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

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR value to the VkBindImageMemorySwapchainInfoKHR#sType field.

swapchainback to summary
public long swapchain()
Returns:long

the value of the VkBindImageMemorySwapchainInfoKHR#swapchain field.

Annotations
@NativeType:VkSwapchainKHR
swapchainback to summary
public VkBindImageMemorySwapchainInfoKHR.Buffer swapchain(long value)

Sets the specified value to the VkBindImageMemorySwapchainInfoKHR#swapchain field.