Package org.lwjgl.vulkan

Class VkPhysicalDeviceTimelineSemaphoreProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceTimelineSemaphoreProperties>

org.lwjgl.vulkan.VkPhysicalDeviceTimelineSemaphoreProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceTimelineSemaphorePropertiesKHR

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

Structure describing timeline semaphore properties that can be supported by an implementation.

Description

If the VkPhysicalDeviceTimelineSemaphoreProperties structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES

Layout

 struct VkPhysicalDeviceTimelineSemaphoreProperties {
     VkStructureType sType();
     void * pNext();
     uint64_t maxTimelineSemaphoreValueDifference();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceTimelineSemaphoreProperties	calloc()	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated with memCalloc.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceTimelineSemaphoreProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceTimelineSemaphoreProperties	create()	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated with BufferUtils.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceTimelineSemaphoreProperties	create(long address)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance for the specified memory address.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceTimelineSemaphoreProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceTimelineSemaphoreProperties	malloc()	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated with memAlloc.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceTimelineSemaphoreProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated on the specified MemoryStack.
long	maxTimelineSemaphoreValueDifference()	indicates the maximum difference allowed by the implementation between the current value of a timeline semaphore and any pending signal or wait operations.
static long	nmaxTimelineSemaphoreValueDifference(long struct)	Unsafe version of maxTimelineSemaphoreValueDifference().
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.
VkPhysicalDeviceTimelineSemaphoreProperties	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceTimelineSemaphoreProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceTimelineSemaphoreProperties	set(VkPhysicalDeviceTimelineSemaphoreProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceTimelineSemaphoreProperties	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceTimelineSemaphoreProperties	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_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.

MAXTIMELINESEMAPHOREVALUEDIFFERENCE

public static final int MAXTIMELINESEMAPHOREVALUEDIFFERENCE

The struct member offsets.

Constructor Details

VkPhysicalDeviceTimelineSemaphoreProperties

public VkPhysicalDeviceTimelineSemaphoreProperties(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

maxTimelineSemaphoreValueDifference

public long maxTimelineSemaphoreValueDifference()

indicates the maximum difference allowed by the implementation between the current value of a timeline semaphore and any pending signal or wait operations.

sType

public VkPhysicalDeviceTimelineSemaphoreProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceTimelineSemaphoreProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_TIMELINE_SEMAPHORE_PROPERTIES value to the sType() field.

pNext

public VkPhysicalDeviceTimelineSemaphoreProperties pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceTimelineSemaphoreProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceTimelineSemaphoreProperties set(VkPhysicalDeviceTimelineSemaphoreProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceTimelineSemaphoreProperties malloc()

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

calloc

public static VkPhysicalDeviceTimelineSemaphoreProperties calloc()

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

create

public static VkPhysicalDeviceTimelineSemaphoreProperties create()

Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceTimelineSemaphoreProperties create(long address)

Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceTimelineSemaphoreProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceTimelineSemaphoreProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceTimelineSemaphoreProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceTimelineSemaphoreProperties malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceTimelineSemaphoreProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmaxTimelineSemaphoreValueDifference

public static long nmaxTimelineSemaphoreValueDifference(long struct)

Unsafe version of maxTimelineSemaphoreValueDifference().

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.