Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceExternalFenceInfo

extends Struct<VkPhysicalDeviceExternalFenceInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceExternalFenceInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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)
See Also

GetPhysicalDeviceExternalFenceProperties, GetPhysicalDeviceExternalFencePropertiesKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPhysicalDeviceExternalFenceInfo.Buffer

An array of VkPhysicalDeviceExternalFenceInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HANDLETYPE

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
VkPhysicalDeviceExternalFenceInfo(long address, ByteBuffer container)

public
VkPhysicalDeviceExternalFenceInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceExternalFenceInfo
calloc()

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPhysicalDeviceExternalFenceInfo
callocStack()

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

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

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

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

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with BufferUtils.

public static VkPhysicalDeviceExternalFenceInfo
create(long address)

Returns a new VkPhysicalDeviceExternalFenceInfo instance for the specified memory address.

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

Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceExternalFenceInfo.Buffer instance at the specified memory.

public static VkPhysicalDeviceExternalFenceInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleType()

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

public VkPhysicalDeviceExternalFenceInfo
handleType(int value)

Sets the specified value to the handleType field.

public static VkPhysicalDeviceExternalFenceInfo
malloc()

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated on the specified MemoryStack.

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

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

public static VkPhysicalDeviceExternalFenceInfo
mallocStack()

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

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

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

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

Unsafe version of handleType.

public static void
nhandleType(long struct, int value)

Unsafe version of handleType.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkPhysicalDeviceExternalFenceInfo

Returns:

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

Sets the specified value to the sType field.

public VkPhysicalDeviceExternalFenceInfo
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_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.

HANDLETYPEback to summary
public static final int HANDLETYPE

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

VkPhysicalDeviceExternalFenceInfoback to summary
protected VkPhysicalDeviceExternalFenceInfo(long address, ByteBuffer container)
VkPhysicalDeviceExternalFenceInfoback to summary
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 Detail

callocback to summary
public static VkPhysicalDeviceExternalFenceInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceExternalFenceInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceExternalFenceInfo create(long address)

Returns a new VkPhysicalDeviceExternalFenceInfo instance for the specified memory address.

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

Returns a new VkPhysicalDeviceExternalFenceInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceExternalFenceInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceExternalFenceInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypeback to summary
public int handleType()

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

Annotations
@NativeType:VkExternalFenceHandleTypeFlagBits
handleTypeback to summary
public VkPhysicalDeviceExternalFenceInfo handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkPhysicalDeviceExternalFenceInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceExternalFenceInfo malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceExternalFenceInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhandleTypeback to summary
public static int nhandleType(long struct)

Unsafe version of handleType.

nhandleTypeback to summary
public static void nhandleType(long struct, int value)

Unsafe version of handleType.

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

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceExternalFenceInfo set(int sType, long pNext, int handleType)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceExternalFenceInfo set(VkPhysicalDeviceExternalFenceInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceExternalFenceInfo

the source struct

Returns:VkPhysicalDeviceExternalFenceInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceExternalFenceInfo.Buffer

extends StructBuffer<VkPhysicalDeviceExternalFenceInfo, VkPhysicalDeviceExternalFenceInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceExternalFenceInfoKHR.Buffer
An array of VkPhysicalDeviceExternalFenceInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceExternalFenceInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the VkPhysicalDeviceExternalFenceInfo#handleType field.
handleType()

public VkPhysicalDeviceExternalFenceInfo.Buffer
handleType(int value)

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#handleType field.

public long

Returns:

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

public VkPhysicalDeviceExternalFenceInfo.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#pNext field.

protected VkPhysicalDeviceExternalFenceInfo.Buffer
self()

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

public int

Returns:

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

public VkPhysicalDeviceExternalFenceInfo.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#sType field.

public VkPhysicalDeviceExternalFenceInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO value to the VkPhysicalDeviceExternalFenceInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceExternalFenceInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
handleTypeback to summary
public int handleType()
Returns:int

the value of the VkPhysicalDeviceExternalFenceInfo#handleType field.

Annotations
@NativeType:VkExternalFenceHandleTypeFlagBits
handleTypeback to summary
public VkPhysicalDeviceExternalFenceInfo.Buffer handleType(int value)

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceExternalFenceInfo#pNext field.

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

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#pNext field.

selfback to summary
protected VkPhysicalDeviceExternalFenceInfo.Buffer self()

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

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

the value of the VkPhysicalDeviceExternalFenceInfo#sType field.

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

Sets the specified value to the VkPhysicalDeviceExternalFenceInfo#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO value to the VkPhysicalDeviceExternalFenceInfo#sType field.