Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSwapchainPresentFenceInfoEXT

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

Fences associated with a vkQueuePresentKHR operation.
Description

The set of queue operations defined by queuing an image for presentation, as well as operations performed by the presentation engine access the payloads of objects associated with the presentation operation. The associated objects include:

The application can provide a fence that the implementation will signal when all such queue operations have completed and the presentation engine has taken a reference to the payload of any objects it accesses as part of the present operation. For all binary wait semaphores imported by the presentation engine using the equivalent of reference transference, as described in Importing Semaphore Payloads, this fence must not signal until all such semaphore payloads have been reset by the presentation engine.

The application can destroy the wait semaphores associated with a given presentation operation when at least one of the associated fences is signaled, and can destroy the swapchain when the fences associated with all past presentation requests referring to that swapchain have signaled.

Fences associated with presentations to the same swapchain on the same VkQueue must be signaled in the same order as the present operations.

To specify a fence for each swapchain in a present operation, include the VkSwapchainPresentFenceInfoEXT structure in the pNext chain of the VkPresentInfoKHR structure.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkSwapchainPresentFenceInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint32_t swapchainCount;
    VkFence const * pFences;
}

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
PFENCES

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
SWAPCHAINCOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkSwapchainPresentFenceInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSwapchainPresentFenceInfoEXT
calloc()

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated with memCalloc.

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

Returns a new VkSwapchainPresentFenceInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkSwapchainPresentFenceInfoEXT
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 VkSwapchainPresentFenceInfoEXT
create()

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated with BufferUtils.

public static VkSwapchainPresentFenceInfoEXT
create(long address)

Returns a new VkSwapchainPresentFenceInfoEXT instance for the specified memory address.

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

Returns a new VkSwapchainPresentFenceInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSwapchainPresentFenceInfoEXT.Buffer instance at the specified memory.

public static VkSwapchainPresentFenceInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSwapchainPresentFenceInfoEXT
malloc()

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated with memAlloc.

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

Returns a new VkSwapchainPresentFenceInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated on the specified MemoryStack.

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

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

public static LongBuffer
npFences(long struct)

Unsafe version of pFences.

public static void
npFences(long struct, LongBuffer value)

Unsafe version of pFences.

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 int
nswapchainCount(long struct)

Unsafe version of swapchainCount.

public static void
nswapchainCount(long struct, int value)

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

public LongBuffer
pFences()

a list of fences with swapchainCount entries.

public VkSwapchainPresentFenceInfoEXT
pFences(LongBuffer value)

Sets the address of the specified LongBuffer to the pFences field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSwapchainPresentFenceInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkSwapchainPresentFenceInfoEXT
set(int sType, long pNext, LongBuffer pFences)

Initializes this struct with the specified values.

public VkSwapchainPresentFenceInfoEXT

Returns:

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

Sets the specified value to the sType field.

public VkSwapchainPresentFenceInfoEXT
public int
swapchainCount()

the number of swapchains being presented to by this command.

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

Validates pointer members that should not be NULL.

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.

PFENCESback to summary
public static final int PFENCES

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.

SWAPCHAINCOUNTback to summary
public static final int SWAPCHAINCOUNT

The struct member offsets.

Constructor Detail

VkSwapchainPresentFenceInfoEXTback to summary
protected VkSwapchainPresentFenceInfoEXT(long address, ByteBuffer container)
VkSwapchainPresentFenceInfoEXTback to summary
public VkSwapchainPresentFenceInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSwapchainPresentFenceInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkSwapchainPresentFenceInfoEXT create(long address)

Returns a new VkSwapchainPresentFenceInfoEXT instance for the specified memory address.

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

Returns a new VkSwapchainPresentFenceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSwapchainPresentFenceInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSwapchainPresentFenceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSwapchainPresentFenceInfoEXT malloc(MemoryStack stack)

Returns a new VkSwapchainPresentFenceInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npFencesback to summary
public static LongBuffer npFences(long struct)

Unsafe version of pFences.

npFencesback to summary
public static void npFences(long struct, LongBuffer value)

Unsafe version of pFences.

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.

nswapchainCountback to summary
public static int nswapchainCount(long struct)

Unsafe version of swapchainCount.

nswapchainCountback to summary
public static void nswapchainCount(long struct, int value)

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

pFencesback to summary
public LongBuffer pFences()

a list of fences with swapchainCount entries. Each entry must be NULL_HANDLE or the handle of a fence to signal when the relevant operations on the associated swapchain have completed.

Annotations
@NativeType:VkFence const *
pFencesback to summary
public VkSwapchainPresentFenceInfoEXT pFences(LongBuffer value)

Sets the address of the specified LongBuffer to the pFences field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkSwapchainPresentFenceInfoEXT set(int sType, long pNext, LongBuffer pFences)

Initializes this struct with the specified values.

setback to summary
public VkSwapchainPresentFenceInfoEXT set(VkSwapchainPresentFenceInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSwapchainPresentFenceInfoEXT

the source struct

Returns:VkSwapchainPresentFenceInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT value to the sType field.

swapchainCountback to summary
public int swapchainCount()

the number of swapchains being presented to by this command.

Annotations
@NativeType:uint32_t
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkSwapchainPresentFenceInfoEXT.Buffer

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

An array of VkSwapchainPresentFenceInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSwapchainPresentFenceInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSwapchainPresentFenceInfoEXT.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 VkSwapchainPresentFenceInfoEXT
public LongBuffer

Returns:

a LongBuffer view of the data pointed to by the VkSwapchainPresentFenceInfoEXT#pFences field.
pFences
()

public VkSwapchainPresentFenceInfoEXT.Buffer
pFences(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSwapchainPresentFenceInfoEXT#pFences field.

public long

Returns:

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

public VkSwapchainPresentFenceInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkSwapchainPresentFenceInfoEXT#pNext field.

protected VkSwapchainPresentFenceInfoEXT.Buffer
public int

Returns:

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

public VkSwapchainPresentFenceInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkSwapchainPresentFenceInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSwapchainPresentFenceInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
pFencesback to summary
public LongBuffer pFences()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkSwapchainPresentFenceInfoEXT#pFences field.

Annotations
@NativeType:VkFence const *
pFencesback to summary
public VkSwapchainPresentFenceInfoEXT.Buffer pFences(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSwapchainPresentFenceInfoEXT#pFences field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkSwapchainPresentFenceInfoEXT#pNext field.

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

Sets the specified value to the VkSwapchainPresentFenceInfoEXT#pNext field.

selfback to summary
protected VkSwapchainPresentFenceInfoEXT.Buffer self()

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

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

the value of the VkSwapchainPresentFenceInfoEXT#sType field.

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

Sets the specified value to the VkSwapchainPresentFenceInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT value to the VkSwapchainPresentFenceInfoEXT#sType field.

swapchainCountback to summary
public int swapchainCount()
Returns:int

the value of the VkSwapchainPresentFenceInfoEXT#swapchainCount field.

Annotations
@NativeType:uint32_t