Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFenceCreateInfo

extends Struct<VkFenceCreateInfo>
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 parameters of a newly created fence.
Valid Usage (Implicit)
See Also

CreateFence

Layout


struct VkFenceCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkFenceCreateFlags flags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkFenceCreateInfo.Buffer

An array of VkFenceCreateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkFenceCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkFenceCreateInfo
calloc()

Returns a new VkFenceCreateInfo instance allocated with memCalloc.

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

Returns a new VkFenceCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkFenceCreateInfo
callocStack()

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

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

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

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

Returns a new VkFenceCreateInfo instance allocated with BufferUtils.

public static VkFenceCreateInfo
create(long address)

Returns a new VkFenceCreateInfo instance for the specified memory address.

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

Returns a new VkFenceCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkFenceCreateInfo.Buffer instance at the specified memory.

public static VkFenceCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkFenceCreateFlagBits specifying the initial state and behavior of the fence.

public VkFenceCreateInfo
flags(int value)

Sets the specified value to the flags field.

public static VkFenceCreateInfo
malloc()

Returns a new VkFenceCreateInfo instance allocated with memAlloc.

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

Returns a new VkFenceCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkFenceCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkFenceCreateInfo
mallocStack()

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

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

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

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

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

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

NULL or a pointer to a structure extending this structure.

public VkFenceCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkFenceCreateInfo
pNext(VkExportFenceCreateInfo value)

Prepends the specified VkExportFenceCreateInfo value to the pNext chain.

public VkFenceCreateInfo
pNext(VkExportFenceCreateInfoKHR value)

Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.

public VkFenceCreateInfo
pNext(VkExportFenceWin32HandleInfoKHR value)

Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.

public VkFenceCreateInfo
set(int sType, long pNext, int flags)

Initializes this struct with the specified values.

public VkFenceCreateInfo

Returns:

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

Sets the specified value to the sType field.

public VkFenceCreateInfo
sType$Default()

Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the sType 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.

FLAGSback to summary
public static final int FLAGS

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.

Constructor Detail

VkFenceCreateInfoback to summary
protected VkFenceCreateInfo(long address, ByteBuffer container)
VkFenceCreateInfoback to summary
public VkFenceCreateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFenceCreateInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkFenceCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkFenceCreateInfo create(long address)

Returns a new VkFenceCreateInfo instance for the specified memory address.

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

Returns a new VkFenceCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkFenceCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFenceCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkFenceCreateFlagBits specifying the initial state and behavior of the fence.

Annotations
@NativeType:VkFenceCreateFlags
flagsback to summary
public VkFenceCreateInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkFenceCreateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFenceCreateInfo malloc(MemoryStack stack)

Returns a new VkFenceCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pNextback to summary
public VkFenceCreateInfo pNext(VkExportFenceCreateInfo value)

Prepends the specified VkExportFenceCreateInfo value to the pNext chain.

pNextback to summary
public VkFenceCreateInfo pNext(VkExportFenceCreateInfoKHR value)

Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.

pNextback to summary
public VkFenceCreateInfo pNext(VkExportFenceWin32HandleInfoKHR value)

Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.

setback to summary
public VkFenceCreateInfo set(int sType, long pNext, int flags)

Initializes this struct with the specified values.

setback to summary
public VkFenceCreateInfo set(VkFenceCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkFenceCreateInfo

the source struct

Returns:VkFenceCreateInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkFenceCreateInfo.Buffer

extends StructBuffer<VkFenceCreateInfo, VkFenceCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkFenceCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkFenceCreateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkFenceCreateInfo#flags field.
flags()

public VkFenceCreateInfo.Buffer
flags(int value)

Sets the specified value to the VkFenceCreateInfo#flags field.

protected VkFenceCreateInfo
getElementFactory()

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

public long

Returns:

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

public VkFenceCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkFenceCreateInfo#pNext field.

public VkFenceCreateInfo.Buffer
pNext(VkExportFenceCreateInfo value)

Prepends the specified VkExportFenceCreateInfo value to the pNext chain.

public VkFenceCreateInfo.Buffer
pNext(VkExportFenceCreateInfoKHR value)

Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.

public VkFenceCreateInfo.Buffer
pNext(VkExportFenceWin32HandleInfoKHR value)

Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.

protected VkFenceCreateInfo.Buffer
self()

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

public int

Returns:

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

public VkFenceCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkFenceCreateInfo#sType field.

public VkFenceCreateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the VkFenceCreateInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFenceCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkFenceCreateInfo.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 VkFenceCreateInfo#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

flagsback to summary
public int flags()
Returns:int

the value of the VkFenceCreateInfo#flags field.

Annotations
@NativeType:VkFenceCreateFlags
flagsback to summary
public VkFenceCreateInfo.Buffer flags(int value)

Sets the specified value to the VkFenceCreateInfo#flags field.

getElementFactoryback to summary
protected VkFenceCreateInfo getElementFactory()

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

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

the value of the VkFenceCreateInfo#pNext field.

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

Sets the specified value to the VkFenceCreateInfo#pNext field.

pNextback to summary
public VkFenceCreateInfo.Buffer pNext(VkExportFenceCreateInfo value)

Prepends the specified VkExportFenceCreateInfo value to the pNext chain.

pNextback to summary
public VkFenceCreateInfo.Buffer pNext(VkExportFenceCreateInfoKHR value)

Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.

pNextback to summary
public VkFenceCreateInfo.Buffer pNext(VkExportFenceWin32HandleInfoKHR value)

Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.

selfback to summary
protected VkFenceCreateInfo.Buffer self()

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

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

the value of the VkFenceCreateInfo#sType field.

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

Sets the specified value to the VkFenceCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the VkFenceCreateInfo#sType field.