Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageSwapchainCreateInfoKHR

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

Specify that an image will be bound to swapchain memory.
Valid Usage
Valid Usage (Implicit)

Layout


struct VkImageSwapchainCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkSwapchainKHR swapchain;
}

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
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
VkImageSwapchainCreateInfoKHR(long address, ByteBuffer container)

public
VkImageSwapchainCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageSwapchainCreateInfoKHR
calloc()

Returns a new VkImageSwapchainCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageSwapchainCreateInfoKHR
callocStack()

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

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

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

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

Returns a new VkImageSwapchainCreateInfoKHR instance allocated with BufferUtils.

public static VkImageSwapchainCreateInfoKHR
create(long address)

Returns a new VkImageSwapchainCreateInfoKHR instance for the specified memory address.

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

Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkImageSwapchainCreateInfoKHR.Buffer instance at the specified memory.

public static VkImageSwapchainCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImageSwapchainCreateInfoKHR
malloc()

Returns a new VkImageSwapchainCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkImageSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkImageSwapchainCreateInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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 VkImageSwapchainCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkImageSwapchainCreateInfoKHR
set(int sType, long pNext, long swapchain)

Initializes this struct with the specified values.

public VkImageSwapchainCreateInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkImageSwapchainCreateInfoKHR
public long
swapchain()

NULL_HANDLE or a handle of a swapchain that the image will be bound to.

public VkImageSwapchainCreateInfoKHR
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.

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

VkImageSwapchainCreateInfoKHRback to summary
protected VkImageSwapchainCreateInfoKHR(long address, ByteBuffer container)
VkImageSwapchainCreateInfoKHRback to summary
public VkImageSwapchainCreateInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageSwapchainCreateInfoKHR calloc(MemoryStack stack)

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

Returns a new VkImageSwapchainCreateInfoKHR.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 VkImageSwapchainCreateInfoKHR callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageSwapchainCreateInfoKHR.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 VkImageSwapchainCreateInfoKHR 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 VkImageSwapchainCreateInfoKHR create()

Returns a new VkImageSwapchainCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkImageSwapchainCreateInfoKHR create(long address)

Returns a new VkImageSwapchainCreateInfoKHR instance for the specified memory address.

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

Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageSwapchainCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageSwapchainCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageSwapchainCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkImageSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkImageSwapchainCreateInfoKHR.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 VkImageSwapchainCreateInfoKHR mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
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 VkImageSwapchainCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkImageSwapchainCreateInfoKHR set(VkImageSwapchainCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkImageSwapchainCreateInfoKHR

the source struct

Returns:VkImageSwapchainCreateInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR value to the sType field.

swapchainback to summary
public long swapchain()

NULL_HANDLE or a handle of a swapchain that the image will be bound to.

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

Sets the specified value to the swapchain field.

org.lwjgl.vulkan back to summary

public Class VkImageSwapchainCreateInfoKHR.Buffer

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

An array of VkImageSwapchainCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageSwapchainCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageSwapchainCreateInfoKHR.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 VkImageSwapchainCreateInfoKHR
public long

Returns:

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

public VkImageSwapchainCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkImageSwapchainCreateInfoKHR#pNext field.

protected VkImageSwapchainCreateInfoKHR.Buffer
public int

Returns:

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

public VkImageSwapchainCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkImageSwapchainCreateInfoKHR#sType field.

public VkImageSwapchainCreateInfoKHR.Buffer
public long

Returns:

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

public VkImageSwapchainCreateInfoKHR.Buffer
swapchain(long value)

Sets the specified value to the VkImageSwapchainCreateInfoKHR#swapchain field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageSwapchainCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkImageSwapchainCreateInfoKHR#pNext field.

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

Sets the specified value to the VkImageSwapchainCreateInfoKHR#pNext field.

selfback to summary
protected VkImageSwapchainCreateInfoKHR.Buffer self()

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

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

the value of the VkImageSwapchainCreateInfoKHR#sType field.

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

Sets the specified value to the VkImageSwapchainCreateInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR value to the VkImageSwapchainCreateInfoKHR#sType field.

swapchainback to summary
public long swapchain()
Returns:long

the value of the VkImageSwapchainCreateInfoKHR#swapchain field.

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

Sets the specified value to the VkImageSwapchainCreateInfoKHR#swapchain field.