Package org.lwjgl.vulkan

Class VkReleaseSwapchainImagesInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkReleaseSwapchainImagesInfoEXT>

org.lwjgl.vulkan.VkReleaseSwapchainImagesInfoEXT

All Implemented Interfaces:

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

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

Structure describing a list of swapchain image indices to be released.

Valid Usage

• Each element of pImageIndices must be the index of a presentable image acquired from the swapchain specified by swapchain
• All uses of presentable images identified by elements of pImageIndices must have completed execution

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT
• pNext must be NULL
• swapchain must be a valid VkSwapchainKHR handle
• pImageIndices must be a valid pointer to an array of imageIndexCount uint32_t values
• imageIndexCount must be greater than 0

Host Synchronization

• Host access to swapchain must be externally synchronized

See Also

ReleaseSwapchainImagesEXT

Layout

 struct VkReleaseSwapchainImagesInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkSwapchainKHR swapchain();
     uint32_t imageIndexCount();
     uint32_t const * pImageIndices();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkReleaseSwapchainImagesInfoEXT.Buffer	An array of VkReleaseSwapchainImagesInfoEXT 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	IMAGEINDEXCOUNT	The struct member offsets.
static final int	PIMAGEINDICES	The struct member offsets.
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
VkReleaseSwapchainImagesInfoEXT(ByteBuffer container)	Creates a VkReleaseSwapchainImagesInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkReleaseSwapchainImagesInfoEXT	calloc()	Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated with memCalloc.
static VkReleaseSwapchainImagesInfoEXT.Buffer	calloc(int capacity)	Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated with memCalloc.
static VkReleaseSwapchainImagesInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkReleaseSwapchainImagesInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkReleaseSwapchainImagesInfoEXT	create()	Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated with BufferUtils.
static VkReleaseSwapchainImagesInfoEXT.Buffer	create(int capacity)	Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated with BufferUtils.
static VkReleaseSwapchainImagesInfoEXT	create(long address)	Returns a new VkReleaseSwapchainImagesInfoEXT instance for the specified memory address.
static VkReleaseSwapchainImagesInfoEXT.Buffer	create(long address, int capacity)	Create a VkReleaseSwapchainImagesInfoEXT.Buffer instance at the specified memory.
static @Nullable VkReleaseSwapchainImagesInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkReleaseSwapchainImagesInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageIndexCount()	the number of image indices to be released.
static VkReleaseSwapchainImagesInfoEXT	malloc()	Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated with memAlloc.
static VkReleaseSwapchainImagesInfoEXT.Buffer	malloc(int capacity)	Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated with memAlloc.
static VkReleaseSwapchainImagesInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkReleaseSwapchainImagesInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated on the specified MemoryStack.
static int	nimageIndexCount(long struct)	Unsafe version of imageIndexCount().
static void	nimageIndexCount(long struct, int value)	Sets the specified value to the imageIndexCount field of the specified struct.
static IntBuffer	npImageIndices(long struct)	Unsafe version of pImageIndices.
static void	npImageIndices(long struct, IntBuffer value)	Unsafe version of pImageIndices.
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.
IntBuffer	pImageIndices()	a pointer to an array of indices into the array of swapchain’s presentable images, with imageIndexCount entries.
VkReleaseSwapchainImagesInfoEXT	pImageIndices(IntBuffer value)	Sets the address of the specified IntBuffer to the pImageIndices() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkReleaseSwapchainImagesInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkReleaseSwapchainImagesInfoEXT	set(int sType, long pNext, long swapchain, IntBuffer pImageIndices)	Initializes this struct with the specified values.
VkReleaseSwapchainImagesInfoEXT	set(VkReleaseSwapchainImagesInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkReleaseSwapchainImagesInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkReleaseSwapchainImagesInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT value to the sType() field.
long	swapchain()	a swapchain to which images are being released.
VkReleaseSwapchainImagesInfoEXT	swapchain(long value)	Sets the specified value to the swapchain() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

IMAGEINDEXCOUNT

public static final int IMAGEINDEXCOUNT

The struct member offsets.

PIMAGEINDICES

public static final int PIMAGEINDICES

The struct member offsets.

Constructor Details

VkReleaseSwapchainImagesInfoEXT

public VkReleaseSwapchainImagesInfoEXT(ByteBuffer container)

Creates a VkReleaseSwapchainImagesInfoEXT 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<VkReleaseSwapchainImagesInfoEXT>

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()

a swapchain to which images are being released.

imageIndexCount

public int imageIndexCount()

the number of image indices to be released.

pImageIndices

public IntBuffer pImageIndices()

a pointer to an array of indices into the array of swapchain’s presentable images, with imageIndexCount entries.

sType

public VkReleaseSwapchainImagesInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkReleaseSwapchainImagesInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT value to the sType() field.

pNext

public VkReleaseSwapchainImagesInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

swapchain

public VkReleaseSwapchainImagesInfoEXT swapchain(long value)

Sets the specified value to the swapchain() field.

pImageIndices

public VkReleaseSwapchainImagesInfoEXT pImageIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the pImageIndices() field.

set

public VkReleaseSwapchainImagesInfoEXT set(int sType,
 long pNext,
 long swapchain,
 IntBuffer pImageIndices)

Initializes this struct with the specified values.

set

public VkReleaseSwapchainImagesInfoEXT set(VkReleaseSwapchainImagesInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkReleaseSwapchainImagesInfoEXT malloc()

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

calloc

public static VkReleaseSwapchainImagesInfoEXT calloc()

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

create

public static VkReleaseSwapchainImagesInfoEXT create()

Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated with BufferUtils.

create

public static VkReleaseSwapchainImagesInfoEXT create(long address)

Returns a new VkReleaseSwapchainImagesInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkReleaseSwapchainImagesInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkReleaseSwapchainImagesInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkReleaseSwapchainImagesInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkReleaseSwapchainImagesInfoEXT.Buffer create(int capacity)

Returns a new VkReleaseSwapchainImagesInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkReleaseSwapchainImagesInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkReleaseSwapchainImagesInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimageIndexCount

public static int nimageIndexCount(long struct)

Unsafe version of imageIndexCount().

npImageIndices

public static IntBuffer npImageIndices(long struct)

Unsafe version of pImageIndices.

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.

nimageIndexCount

public static void nimageIndexCount(long struct,
 int value)

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

npImageIndices

public static void npImageIndices(long struct,
 IntBuffer value)

Unsafe version of pImageIndices.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate