Package org.lwjgl.vulkan

Class VkFenceCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkFenceCreateInfo>

org.lwjgl.vulkan.VkFenceCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkFenceCreateInfo
extends Struct<VkFenceCreateInfo>
implements NativeResource

Structure specifying parameters of a newly created fence.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_FENCE_CREATE_INFO
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkExportFenceCreateInfo or VkExportFenceWin32HandleInfoKHR
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of VkFenceCreateFlagBits values

See Also

CreateFence

Layout

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

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkFenceCreateInfo	calloc()	Returns a new VkFenceCreateInfo instance allocated with memCalloc.
static VkFenceCreateInfo.Buffer	calloc(int capacity)	Returns a new VkFenceCreateInfo.Buffer instance allocated with memCalloc.
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.
static VkFenceCreateInfo	calloc(MemoryStack stack)	Returns a new VkFenceCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFenceCreateInfo	callocStack()	Deprecated.
static VkFenceCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkFenceCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkFenceCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkFenceCreateInfo	create()	Returns a new VkFenceCreateInfo instance allocated with BufferUtils.
static VkFenceCreateInfo.Buffer	create(int capacity)	Returns a new VkFenceCreateInfo.Buffer instance allocated with BufferUtils.
static VkFenceCreateInfo	create(long address)	Returns a new VkFenceCreateInfo instance for the specified memory address.
static VkFenceCreateInfo.Buffer	create(long address, int capacity)	Create a VkFenceCreateInfo.Buffer instance at the specified memory.
static VkFenceCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkFenceCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkFenceCreateFlagBits specifying the initial state and behavior of the fence.
VkFenceCreateInfo	flags(int value)	Sets the specified value to the flags() field.
static VkFenceCreateInfo	malloc()	Returns a new VkFenceCreateInfo instance allocated with memAlloc.
static VkFenceCreateInfo.Buffer	malloc(int capacity)	Returns a new VkFenceCreateInfo.Buffer instance allocated with memAlloc.
static VkFenceCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkFenceCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkFenceCreateInfo	malloc(MemoryStack stack)	Returns a new VkFenceCreateInfo instance allocated on the specified MemoryStack.
static VkFenceCreateInfo	mallocStack()	Deprecated.
static VkFenceCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkFenceCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkFenceCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkFenceCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkFenceCreateInfo	pNext(VkExportFenceCreateInfo value)	Prepends the specified VkExportFenceCreateInfo value to the pNext chain.
VkFenceCreateInfo	pNext(VkExportFenceCreateInfoKHR value)	Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.
VkFenceCreateInfo	pNext(VkExportFenceWin32HandleInfoKHR value)	Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.
VkFenceCreateInfo	set(int sType, long pNext, int flags)	Initializes this struct with the specified values.
VkFenceCreateInfo	set(VkFenceCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkFenceCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkFenceCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkFenceCreateInfo

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkFenceCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

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

sType

public VkFenceCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkFenceCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_FENCE_CREATE_INFO value to the sType() field.

pNext

public VkFenceCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkFenceCreateInfo pNext(VkExportFenceCreateInfo value)

Prepends the specified VkExportFenceCreateInfo value to the pNext chain.

pNext

public VkFenceCreateInfo pNext(VkExportFenceCreateInfoKHR value)

Prepends the specified VkExportFenceCreateInfoKHR value to the pNext chain.

pNext

public VkFenceCreateInfo pNext(VkExportFenceWin32HandleInfoKHR value)

Prepends the specified VkExportFenceWin32HandleInfoKHR value to the pNext chain.

flags

public VkFenceCreateInfo flags(int value)

Sets the specified value to the flags() field.

set

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

Initializes this struct with the specified values.

set

public VkFenceCreateInfo set(VkFenceCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkFenceCreateInfo malloc()

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

calloc

public static VkFenceCreateInfo calloc()

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

create

public static VkFenceCreateInfo create()

Returns a new VkFenceCreateInfo instance allocated with BufferUtils.

create

public static VkFenceCreateInfo create(long address)

Returns a new VkFenceCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkFenceCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkFenceCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkFenceCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkFenceCreateInfo.Buffer create(int capacity)

Returns a new VkFenceCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkFenceCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkFenceCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkFenceCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkFenceCreateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkFenceCreateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkFenceCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkFenceCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkFenceCreateInfo malloc(MemoryStack stack)

Returns a new VkFenceCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.