Package org.lwjgl.vulkan

Class VkPhysicalDeviceExternalFenceInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceExternalFenceInfo>

org.lwjgl.vulkan.VkPhysicalDeviceExternalFenceInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceExternalFenceInfoKHR

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

Structure specifying fence creation parameters.

Description

Note

Handles of type EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT generated by the implementation may represent either Linux Sync Files or Android Fences at the implementation’s discretion. Applications should only use operations defined for both types of file descriptors, unless they know via means external to Vulkan the type of the file descriptor, or are prepared to deal with the system-defined operation failures resulting from using the wrong type.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO
• pNext must be NULL
• handleType must be a valid VkExternalFenceHandleTypeFlagBits value

See Also

GetPhysicalDeviceExternalFenceProperties, GetPhysicalDeviceExternalFencePropertiesKHR

Layout

 struct VkPhysicalDeviceExternalFenceInfo {
     VkStructureType sType();
     void const * pNext();
     VkExternalFenceHandleTypeFlagBits handleType();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceExternalFenceInfo.Buffer	An array of VkPhysicalDeviceExternalFenceInfo 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	HANDLETYPE	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
VkPhysicalDeviceExternalFenceInfo(ByteBuffer container)	Creates a VkPhysicalDeviceExternalFenceInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceExternalFenceInfo	calloc()	Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with memCalloc.
static VkPhysicalDeviceExternalFenceInfo.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceExternalFenceInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExternalFenceInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExternalFenceInfo	callocStack()	Deprecated.
static VkPhysicalDeviceExternalFenceInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceExternalFenceInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalFenceInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalFenceInfo	create()	Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with BufferUtils.
static VkPhysicalDeviceExternalFenceInfo.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceExternalFenceInfo	create(long address)	Returns a new VkPhysicalDeviceExternalFenceInfo instance for the specified memory address.
static VkPhysicalDeviceExternalFenceInfo.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceExternalFenceInfo.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceExternalFenceInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceExternalFenceInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	handleType()	a VkExternalFenceHandleTypeFlagBits value specifying an external fence handle type for which capabilities will be returned.
VkPhysicalDeviceExternalFenceInfo	handleType(int value)	Sets the specified value to the handleType() field.
static VkPhysicalDeviceExternalFenceInfo	malloc()	Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with memAlloc.
static VkPhysicalDeviceExternalFenceInfo.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceExternalFenceInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceExternalFenceInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated on the specified MemoryStack.
static VkPhysicalDeviceExternalFenceInfo	mallocStack()	Deprecated.
static VkPhysicalDeviceExternalFenceInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceExternalFenceInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalFenceInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nhandleType(long struct)	Unsafe version of handleType().
static void	nhandleType(long struct, int value)	Unsafe version of handleType.
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.
VkPhysicalDeviceExternalFenceInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceExternalFenceInfo	set(int sType, long pNext, int handleType)	Initializes this struct with the specified values.
VkPhysicalDeviceExternalFenceInfo	set(VkPhysicalDeviceExternalFenceInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceExternalFenceInfo	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceExternalFenceInfo	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO value to the sType() 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.

HANDLETYPE

public static final int HANDLETYPE

The struct member offsets.

Constructor Details

VkPhysicalDeviceExternalFenceInfo

public VkPhysicalDeviceExternalFenceInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

handleType

public int handleType()

a VkExternalFenceHandleTypeFlagBits value specifying an external fence handle type for which capabilities will be returned.

sType

public VkPhysicalDeviceExternalFenceInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceExternalFenceInfo sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO value to the sType() field.

pNext

public VkPhysicalDeviceExternalFenceInfo pNext(long value)

Sets the specified value to the pNext() field.

handleType

public VkPhysicalDeviceExternalFenceInfo handleType(int value)

Sets the specified value to the handleType() field.

set

public VkPhysicalDeviceExternalFenceInfo set(int sType,
 long pNext,
 int handleType)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceExternalFenceInfo set(VkPhysicalDeviceExternalFenceInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceExternalFenceInfo malloc()

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

calloc

public static VkPhysicalDeviceExternalFenceInfo calloc()

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

create

public static VkPhysicalDeviceExternalFenceInfo create()

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with BufferUtils.

create

public static VkPhysicalDeviceExternalFenceInfo create(long address)

Returns a new VkPhysicalDeviceExternalFenceInfo instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceExternalFenceInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceExternalFenceInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceExternalFenceInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceExternalFenceInfo.Buffer create(int capacity)

Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceExternalFenceInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceExternalFenceInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceExternalFenceInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceExternalFenceInfo.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 VkPhysicalDeviceExternalFenceInfo.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 VkPhysicalDeviceExternalFenceInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nhandleType

public static int nhandleType(long struct)

Unsafe version of handleType().

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.

nhandleType

public static void nhandleType(long struct,
 int value)

Unsafe version of handleType.