LWJGL 3.3.3 · org.lwjgl.vulkan.VkWin32KeyedMutexAcquireReleaseInfoNV

Use Windows keyex mutex mechanism to synchronize work.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_NV
If acquireCount is not 0, pAcquireSyncs must be a valid pointer to an array of acquireCount valid VkDeviceMemory handles
If acquireCount is not 0, pAcquireKeys must be a valid pointer to an array of acquireCount uint64_t values
If acquireCount is not 0, pAcquireTimeoutMilliseconds must be a valid pointer to an array of acquireCount uint32_t values
If releaseCount is not 0, pReleaseSyncs must be a valid pointer to an array of releaseCount valid VkDeviceMemory handles
If releaseCount is not 0, pReleaseKeys must be a valid pointer to an array of releaseCount uint64_t values
Both of the elements of pAcquireSyncs, and the elements of pReleaseSyncs that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

Layout


struct VkWin32KeyedMutexAcquireReleaseInfoNV {
    VkStructureType sType;
    void const * pNext;
    uint32_t acquireCount;
    VkDeviceMemory const * pAcquireSyncs;
    uint64_t const * pAcquireKeys;
    uint32_t const * pAcquireTimeoutMilliseconds;
    uint32_t releaseCount;
    VkDeviceMemory const * pReleaseSyncs;
    uint64_t const * pReleaseKeys;
}

Modifier and Type	Class and Description
public static class	VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer An array of `VkWin32KeyedMutexAcquireReleaseInfoNV` structs.

Modifier and Type	Field and Description
public static final int	ACQUIRECOUNT The struct member offsets.
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PACQUIREKEYS The struct member offsets.
public static final int	PACQUIRESYNCS The struct member offsets.
public static final int	PACQUIRETIMEOUTMILLISECONDS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PRELEASEKEYS The struct member offsets.
public static final int	PRELEASESYNCS The struct member offsets.
public static final int	RELEASECOUNT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkWin32KeyedMutexAcquireReleaseInfoNV(long address, ByteBuffer container)
public	VkWin32KeyedMutexAcquireReleaseInfoNV(ByteBuffer container) Creates a `VkWin32KeyedMutexAcquireReleaseInfoNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public int	acquireCount() the number of entries in the `pAcquireSyncs`, `pAcquireKeys`, and `pAcquireTimeoutMilliseconds` arrays.
public VkWin32KeyedMutexAcquireReleaseInfoNV	acquireCount(int value) Sets the specified value to the `acquireCount` field.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	calloc() Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance allocated with `memCalloc`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance allocated with `memCalloc`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkWin32KeyedMutexAcquireReleaseInfoNV	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 VkWin32KeyedMutexAcquireReleaseInfoNV	create() Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance allocated with `BufferUtils`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	create(long address) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance for the specified memory address.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	create(int the buffer capacity capacity) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance allocated with `BufferUtils`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance at the specified memory.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	malloc() Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance allocated with `memAlloc`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance allocated with `memAlloc`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV` instance allocated on the specified `MemoryStack`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer` instance allocated on the specified `MemoryStack`.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkWin32KeyedMutexAcquireReleaseInfoNV.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nacquireCount(long struct) Unsafe version of `acquireCount`.
public static void	nacquireCount(long struct, int value) Sets the specified value to the `acquireCount` field of the specified `struct`.
public static LongBuffer	npAcquireKeys(long struct) Unsafe version of `pAcquireKeys`.
public static void	npAcquireKeys(long struct, LongBuffer value) Unsafe version of `pAcquireKeys`.
public static LongBuffer	npAcquireSyncs(long struct) Unsafe version of `pAcquireSyncs`.
public static void	npAcquireSyncs(long struct, LongBuffer value) Unsafe version of `pAcquireSyncs`.
public static IntBuffer	npAcquireTimeoutMilliseconds(long struct) Unsafe version of `pAcquireTimeoutMilliseconds`.
public static void	npAcquireTimeoutMilliseconds(long struct, IntBuffer value) Unsafe version of `pAcquireTimeoutMilliseconds`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static LongBuffer	npReleaseKeys(long struct) Unsafe version of `pReleaseKeys`.
public static void	npReleaseKeys(long struct, LongBuffer value) Unsafe version of `pReleaseKeys`.
public static LongBuffer	npReleaseSyncs(long struct) Unsafe version of `pReleaseSyncs`.
public static void	npReleaseSyncs(long struct, LongBuffer value) Unsafe version of `pReleaseSyncs`.
public static int	nreleaseCount(long struct) Unsafe version of `releaseCount`.
public static void	nreleaseCount(long struct, int value) Sets the specified value to the `releaseCount` field of the specified `struct`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public LongBuffer	pAcquireKeys() a pointer to an array of mutex key values to wait for prior to beginning the submitted work.
public VkWin32KeyedMutexAcquireReleaseInfoNV	pAcquireKeys(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pAcquireKeys` field.
public LongBuffer	pAcquireSyncs() a pointer to an array of `VkDeviceMemory` objects which were imported from Direct3D 11 resources.
public VkWin32KeyedMutexAcquireReleaseInfoNV	pAcquireSyncs(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pAcquireSyncs` field.
public IntBuffer	pAcquireTimeoutMilliseconds() a pointer to an array of timeout values, in millisecond units, for each acquire specified in `pAcquireKeys`.
public VkWin32KeyedMutexAcquireReleaseInfoNV	pAcquireTimeoutMilliseconds(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pAcquireTimeoutMilliseconds` field.
public long	Returns: the value of the `pNext` field. pNext()
public VkWin32KeyedMutexAcquireReleaseInfoNV	pNext(long value) Sets the specified value to the `pNext` field.
public LongBuffer	pReleaseKeys() a pointer to an array of mutex key values to set when the submitted work has completed.
public VkWin32KeyedMutexAcquireReleaseInfoNV	pReleaseKeys(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pReleaseKeys` field.
public LongBuffer	pReleaseSyncs() a pointer to an array of `VkDeviceMemory` objects which were imported from Direct3D 11 resources.
public VkWin32KeyedMutexAcquireReleaseInfoNV	pReleaseSyncs(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pReleaseSyncs` field.
public int	releaseCount() the number of entries in the `pReleaseSyncs` and `pReleaseKeys` arrays.
public VkWin32KeyedMutexAcquireReleaseInfoNV	releaseCount(int value) Sets the specified value to the `releaseCount` field.
public VkWin32KeyedMutexAcquireReleaseInfoNV	set(int sType, long pNext, int acquireCount, LongBuffer pAcquireSyncs, LongBuffer pAcquireKeys, IntBuffer pAcquireTimeoutMilliseconds, int releaseCount, LongBuffer pReleaseSyncs, LongBuffer pReleaseKeys) Initializes this struct with the specified values.
public VkWin32KeyedMutexAcquireReleaseInfoNV	Returns: this struct set(VkWin32KeyedMutexAcquireReleaseInfoNV 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 VkWin32KeyedMutexAcquireReleaseInfoNV	sType(int value) Sets the specified value to the `sType` field.
public VkWin32KeyedMutexAcquireReleaseInfoNV	sType$Default() Sets the `STRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_NV` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

public Class VkWin32KeyedMutexAcquireReleaseInfoNV

Valid Usage (Implicit)

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary