Package org.lwjgl.vulkan

Class VkImageSwapchainCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageSwapchainCreateInfoKHR>

org.lwjgl.vulkan.VkImageSwapchainCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImageSwapchainCreateInfoKHR
extends org.lwjgl.system.Struct<VkImageSwapchainCreateInfoKHR>
implements org.lwjgl.system.NativeResource

Specify that an image will be bound to swapchain memory.

Valid Usage

• If swapchain is not NULL_HANDLE, the fields of VkImageCreateInfo must match the implied image creation parameters of the swapchain

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• If swapchain is not NULL_HANDLE, swapchain must be a valid VkSwapchainKHR handle

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageSwapchainCreateInfoKHR.Buffer	An array of VkImageSwapchainCreateInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SWAPCHAIN	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkImageSwapchainCreateInfoKHR(ByteBuffer container)	Creates a VkImageSwapchainCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageSwapchainCreateInfoKHR	calloc()	Returns a new VkImageSwapchainCreateInfoKHR instance allocated with memCalloc.
static VkImageSwapchainCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkImageSwapchainCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSwapchainCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageSwapchainCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSwapchainCreateInfoKHR	callocStack()	Deprecated.
static VkImageSwapchainCreateInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkImageSwapchainCreateInfoKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageSwapchainCreateInfoKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageSwapchainCreateInfoKHR	create()	Returns a new VkImageSwapchainCreateInfoKHR instance allocated with BufferUtils.
static VkImageSwapchainCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkImageSwapchainCreateInfoKHR	create(long address)	Returns a new VkImageSwapchainCreateInfoKHR instance for the specified memory address.
static VkImageSwapchainCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkImageSwapchainCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkImageSwapchainCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageSwapchainCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImageSwapchainCreateInfoKHR	malloc()	Returns a new VkImageSwapchainCreateInfoKHR instance allocated with memAlloc.
static VkImageSwapchainCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkImageSwapchainCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkImageSwapchainCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.
static VkImageSwapchainCreateInfoKHR	mallocStack()	Deprecated.
static VkImageSwapchainCreateInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageSwapchainCreateInfoKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageSwapchainCreateInfoKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static long	nswapchain(long struct)	Unsafe version of swapchain().
static void	nswapchain(long struct, long value)	Unsafe version of swapchain.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageSwapchainCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkImageSwapchainCreateInfoKHR	set(int sType, long pNext, long swapchain)	Initializes this struct with the specified values.
VkImageSwapchainCreateInfoKHR	set(VkImageSwapchainCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageSwapchainCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkImageSwapchainCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR value to the sType() field.
long	swapchain()	NULL_HANDLE or a handle of a swapchain that the image will be bound to.
VkImageSwapchainCreateInfoKHR	swapchain(long value)	Sets the specified value to the swapchain() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SWAPCHAIN

public static final int SWAPCHAIN

The struct member offsets.

Constructor Details

VkImageSwapchainCreateInfoKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkImageSwapchainCreateInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

swapchain

public long swapchain()

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

sType

public VkImageSwapchainCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageSwapchainCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR value to the sType() field.

pNext

public VkImageSwapchainCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

swapchain

public VkImageSwapchainCreateInfoKHR swapchain(long value)

Sets the specified value to the swapchain() field.

set

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

Initializes this struct with the specified values.

set

public VkImageSwapchainCreateInfoKHR set(VkImageSwapchainCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageSwapchainCreateInfoKHR malloc()

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

calloc

public static VkImageSwapchainCreateInfoKHR calloc()

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

create

public static VkImageSwapchainCreateInfoKHR create()

Returns a new VkImageSwapchainCreateInfoKHR instance allocated with BufferUtils.

create

public static VkImageSwapchainCreateInfoKHR create(long address)

Returns a new VkImageSwapchainCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkImageSwapchainCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageSwapchainCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageSwapchainCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageSwapchainCreateInfoKHR.Buffer create(int capacity)

Returns a new VkImageSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageSwapchainCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageSwapchainCreateInfoKHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkImageSwapchainCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageSwapchainCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkImageSwapchainCreateInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkImageSwapchainCreateInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nswapchain

public static long nswapchain(long struct)

Unsafe version of swapchain().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nswapchain

public static void nswapchain(long struct,
 long value)

Unsafe version of swapchain.