Package org.lwjgl.vulkan

Class VkExternalSemaphoreProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalSemaphoreProperties>

org.lwjgl.vulkan.VkExternalSemaphoreProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

VkExternalSemaphorePropertiesKHR

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

Structure describing supported external semaphore handle features.

Description

If handleType is not supported by the implementation, then VkExternalSemaphoreProperties::externalSemaphoreFeatures will be zero.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXTERNAL_SEMAPHORE_PROPERTIES
• pNext must be NULL

See Also

GetPhysicalDeviceExternalSemaphoreProperties, GetPhysicalDeviceExternalSemaphorePropertiesKHR

Layout

 struct VkExternalSemaphoreProperties {
     VkStructureType sType();
     void * pNext();
     VkExternalSemaphoreHandleTypeFlags exportFromImportedHandleTypes();
     VkExternalSemaphoreHandleTypeFlags compatibleHandleTypes();
     VkExternalSemaphoreFeatureFlags externalSemaphoreFeatures();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExternalSemaphoreProperties.Buffer	An array of VkExternalSemaphoreProperties 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	COMPATIBLEHANDLETYPES	The struct member offsets.
static final int	EXPORTFROMIMPORTEDHANDLETYPES	The struct member offsets.
static final int	EXTERNALSEMAPHOREFEATURES	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
VkExternalSemaphoreProperties(ByteBuffer container)	Creates a VkExternalSemaphoreProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExternalSemaphoreProperties	calloc()	Returns a new VkExternalSemaphoreProperties instance allocated with memCalloc.
static VkExternalSemaphoreProperties.Buffer	calloc(int capacity)	Returns a new VkExternalSemaphoreProperties.Buffer instance allocated with memCalloc.
static VkExternalSemaphoreProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalSemaphoreProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalSemaphoreProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalSemaphoreProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalSemaphoreProperties	callocStack()	Deprecated.
static VkExternalSemaphoreProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkExternalSemaphoreProperties.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalSemaphoreProperties	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	compatibleHandleTypes()	a bitmask of VkExternalSemaphoreHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating a semaphore.
static VkExternalSemaphoreProperties	create()	Returns a new VkExternalSemaphoreProperties instance allocated with BufferUtils.
static VkExternalSemaphoreProperties.Buffer	create(int capacity)	Returns a new VkExternalSemaphoreProperties.Buffer instance allocated with BufferUtils.
static VkExternalSemaphoreProperties	create(long address)	Returns a new VkExternalSemaphoreProperties instance for the specified memory address.
static VkExternalSemaphoreProperties.Buffer	create(long address, int capacity)	Create a VkExternalSemaphoreProperties.Buffer instance at the specified memory.
static @Nullable VkExternalSemaphoreProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExternalSemaphoreProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	exportFromImportedHandleTypes()	a bitmask of VkExternalSemaphoreHandleTypeFlagBits specifying which types of imported handle handleType can be exported from.
int	externalSemaphoreFeatures()	a bitmask of VkExternalSemaphoreFeatureFlagBits describing the features of handleType.
static VkExternalSemaphoreProperties	malloc()	Returns a new VkExternalSemaphoreProperties instance allocated with memAlloc.
static VkExternalSemaphoreProperties.Buffer	malloc(int capacity)	Returns a new VkExternalSemaphoreProperties.Buffer instance allocated with memAlloc.
static VkExternalSemaphoreProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalSemaphoreProperties.Buffer instance allocated on the specified MemoryStack.
static VkExternalSemaphoreProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalSemaphoreProperties instance allocated on the specified MemoryStack.
static VkExternalSemaphoreProperties	mallocStack()	Deprecated.
static VkExternalSemaphoreProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkExternalSemaphoreProperties.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalSemaphoreProperties	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ncompatibleHandleTypes(long struct)	Unsafe version of compatibleHandleTypes().
static int	nexportFromImportedHandleTypes(long struct)	Unsafe version of exportFromImportedHandleTypes().
static int	nexternalSemaphoreFeatures(long struct)	Unsafe version of externalSemaphoreFeatures().
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.
VkExternalSemaphoreProperties	pNext(long value)	Sets the specified value to the pNext() field.
VkExternalSemaphoreProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkExternalSemaphoreProperties	set(VkExternalSemaphoreProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExternalSemaphoreProperties	sType(int value)	Sets the specified value to the sType() field.
VkExternalSemaphoreProperties	sType$Default()	Sets the STRUCTURE_TYPE_EXTERNAL_SEMAPHORE_PROPERTIES 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.

EXPORTFROMIMPORTEDHANDLETYPES

public static final int EXPORTFROMIMPORTEDHANDLETYPES

The struct member offsets.

COMPATIBLEHANDLETYPES

public static final int COMPATIBLEHANDLETYPES

The struct member offsets.

EXTERNALSEMAPHOREFEATURES

public static final int EXTERNALSEMAPHOREFEATURES

The struct member offsets.

Constructor Details

VkExternalSemaphoreProperties

public VkExternalSemaphoreProperties(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

exportFromImportedHandleTypes

public int exportFromImportedHandleTypes()

a bitmask of VkExternalSemaphoreHandleTypeFlagBits specifying which types of imported handle handleType can be exported from.

compatibleHandleTypes

public int compatibleHandleTypes()

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

externalSemaphoreFeatures

public int externalSemaphoreFeatures()

a bitmask of VkExternalSemaphoreFeatureFlagBits describing the features of handleType.

sType

public VkExternalSemaphoreProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExternalSemaphoreProperties sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_SEMAPHORE_PROPERTIES value to the sType() field.

pNext

public VkExternalSemaphoreProperties pNext(long value)

Sets the specified value to the pNext() field.

set

public VkExternalSemaphoreProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkExternalSemaphoreProperties set(VkExternalSemaphoreProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExternalSemaphoreProperties malloc()

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

calloc

public static VkExternalSemaphoreProperties calloc()

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

create

public static VkExternalSemaphoreProperties create()

Returns a new VkExternalSemaphoreProperties instance allocated with BufferUtils.

create

public static VkExternalSemaphoreProperties create(long address)

Returns a new VkExternalSemaphoreProperties instance for the specified memory address.

createSafe

public static @Nullable VkExternalSemaphoreProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExternalSemaphoreProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExternalSemaphoreProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExternalSemaphoreProperties.Buffer create(int capacity)

Returns a new VkExternalSemaphoreProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExternalSemaphoreProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExternalSemaphoreProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkExternalSemaphoreProperties callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkExternalSemaphoreProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nexportFromImportedHandleTypes

public static int nexportFromImportedHandleTypes(long struct)

Unsafe version of exportFromImportedHandleTypes().

ncompatibleHandleTypes

public static int ncompatibleHandleTypes(long struct)

Unsafe version of compatibleHandleTypes().

nexternalSemaphoreFeatures

public static int nexternalSemaphoreFeatures(long struct)

Unsafe version of externalSemaphoreFeatures().

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.