Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalFenceProperties

extends Struct<VkExternalFenceProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalFencePropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure describing supported external fence handle features.
Description

If handleType is not supported by the implementation, then VkExternalFenceProperties::externalFenceFeatures will be set to zero.

Valid Usage (Implicit)
See Also

GetPhysicalDeviceExternalFenceProperties, GetPhysicalDeviceExternalFencePropertiesKHR

Layout


struct VkExternalFenceProperties {
    VkStructureType sType;
    void * pNext;
    VkExternalFenceHandleTypeFlags exportFromImportedHandleTypes;
    VkExternalFenceHandleTypeFlags compatibleHandleTypes;
    VkExternalFenceFeatureFlags externalFenceFeatures;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExternalFenceProperties.Buffer

An array of VkExternalFenceProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMPATIBLEHANDLETYPES

The struct member offsets.

public static final int
EXPORTFROMIMPORTEDHANDLETYPES

The struct member offsets.

public static final int
EXTERNALFENCEFEATURES

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

public
VkExternalFenceProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExternalFenceProperties
calloc()

Returns a new VkExternalFenceProperties instance allocated with memCalloc.

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

Returns a new VkExternalFenceProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExternalFenceProperties
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
compatibleHandleTypes()

a bitmask of VkExternalFenceHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating a fence.

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

Returns a new VkExternalFenceProperties instance allocated with BufferUtils.

public static VkExternalFenceProperties
create(long address)

Returns a new VkExternalFenceProperties instance for the specified memory address.

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

Returns a new VkExternalFenceProperties.Buffer instance allocated with BufferUtils.

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

Create a VkExternalFenceProperties.Buffer instance at the specified memory.

public static VkExternalFenceProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
exportFromImportedHandleTypes()

a bitmask of VkExternalFenceHandleTypeFlagBits indicating which types of imported handle handleType can be exported from.

public int
externalFenceFeatures()

a bitmask of VkExternalFenceFeatureFlagBits indicating the features of handleType.

public static VkExternalFenceProperties
malloc()

Returns a new VkExternalFenceProperties instance allocated with memAlloc.

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

Returns a new VkExternalFenceProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkExternalFenceProperties instance allocated on the specified MemoryStack.

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

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

public static VkExternalFenceProperties
mallocStack()

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

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

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

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

Unsafe version of compatibleHandleTypes.

public static int
nexportFromImportedHandleTypes(long struct)

Unsafe version of exportFromImportedHandleTypes.

public static int
nexternalFenceFeatures(long struct)

Unsafe version of externalFenceFeatures.

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

Returns:

the value of the pNext field.
pNext()

public VkExternalFenceProperties
pNext(long value)

Sets the specified value to the pNext field.

public VkExternalFenceProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkExternalFenceProperties

Returns:

this struct
set(VkExternalFenceProperties
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

Returns:

the value of the sType field.
sType()

public VkExternalFenceProperties
sType(int value)

Sets the specified value to the sType field.

public VkExternalFenceProperties
sType$Default()

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

COMPATIBLEHANDLETYPESback to summary
public static final int COMPATIBLEHANDLETYPES

The struct member offsets.

EXPORTFROMIMPORTEDHANDLETYPESback to summary
public static final int EXPORTFROMIMPORTEDHANDLETYPES

The struct member offsets.

EXTERNALFENCEFEATURESback to summary
public static final int EXTERNALFENCEFEATURES

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

VkExternalFencePropertiesback to summary
protected VkExternalFenceProperties(long address, ByteBuffer container)
VkExternalFencePropertiesback to summary
public VkExternalFenceProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalFenceProperties calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalFenceProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
compatibleHandleTypesback to summary
public int compatibleHandleTypes()

a bitmask of VkExternalFenceHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating a fence.

Annotations
@NativeType:VkExternalFenceHandleTypeFlags
createback to summary
protected VkExternalFenceProperties 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 VkExternalFenceProperties create()

Returns a new VkExternalFenceProperties instance allocated with BufferUtils.

createback to summary
public static VkExternalFenceProperties create(long address)

Returns a new VkExternalFenceProperties instance for the specified memory address.

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

Returns a new VkExternalFenceProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalFenceProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalFenceProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
exportFromImportedHandleTypesback to summary
public int exportFromImportedHandleTypes()

a bitmask of VkExternalFenceHandleTypeFlagBits indicating which types of imported handle handleType can be exported from.

Annotations
@NativeType:VkExternalFenceHandleTypeFlags
externalFenceFeaturesback to summary
public int externalFenceFeatures()

a bitmask of VkExternalFenceFeatureFlagBits indicating the features of handleType.

Annotations
@NativeType:VkExternalFenceFeatureFlags
mallocback to summary
public static VkExternalFenceProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalFenceProperties malloc(MemoryStack stack)

Returns a new VkExternalFenceProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ncompatibleHandleTypesback to summary
public static int ncompatibleHandleTypes(long struct)

Unsafe version of compatibleHandleTypes.

nexportFromImportedHandleTypesback to summary
public static int nexportFromImportedHandleTypes(long struct)

Unsafe version of exportFromImportedHandleTypes.

nexternalFenceFeaturesback to summary
public static int nexternalFenceFeatures(long struct)

Unsafe version of externalFenceFeatures.

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()
Returns:long

the value of the pNext field.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkExternalFenceProperties set(VkExternalFenceProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalFenceProperties

the source struct

Returns:VkExternalFenceProperties

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()
Returns:int

the value of the sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkExternalFenceProperties sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalFenceProperties.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkExternalFenceProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExternalFenceProperties.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 VkExternalFenceProperties#compatibleHandleTypes field.
compatibleHandleTypes()

public int

Returns:

the value of the VkExternalFenceProperties#exportFromImportedHandleTypes field.
exportFromImportedHandleTypes()

public int

Returns:

the value of the VkExternalFenceProperties#externalFenceFeatures field.
externalFenceFeatures()

protected VkExternalFenceProperties
getElementFactory()

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

public long

Returns:

the value of the pNext field.
pNext()

public VkExternalFenceProperties.Buffer
pNext(long value)

Sets the specified value to the pNext field.

protected VkExternalFenceProperties.Buffer
self()

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

public int

Returns:

the value of the sType field.
sType()

public VkExternalFenceProperties.Buffer
sType(int value)

Sets the specified value to the sType field.

public VkExternalFenceProperties.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES value to the sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalFenceProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

compatibleHandleTypesback to summary
public int compatibleHandleTypes()
Returns:int

the value of the VkExternalFenceProperties#compatibleHandleTypes field.

Annotations
@NativeType:VkExternalFenceHandleTypeFlags
exportFromImportedHandleTypesback to summary
public int exportFromImportedHandleTypes()
Returns:int

the value of the VkExternalFenceProperties#exportFromImportedHandleTypes field.

Annotations
@NativeType:VkExternalFenceHandleTypeFlags
externalFenceFeaturesback to summary
public int externalFenceFeatures()
Returns:int

the value of the VkExternalFenceProperties#externalFenceFeatures field.

Annotations
@NativeType:VkExternalFenceFeatureFlags
getElementFactoryback to summary
protected VkExternalFenceProperties getElementFactory()

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

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

the value of the pNext field.

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

Sets the specified value to the pNext field.

selfback to summary
protected VkExternalFenceProperties.Buffer self()

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

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

the value of the sType field.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES value to the sType field.