Package org.lwjgl.vulkan
Class VkWin32KeyedMutexAcquireReleaseInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkWin32KeyedMutexAcquireReleaseInfoKHR>
org.lwjgl.vulkan.VkWin32KeyedMutexAcquireReleaseInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkWin32KeyedMutexAcquireReleaseInfoKHR
extends org.lwjgl.system.Struct<VkWin32KeyedMutexAcquireReleaseInfoKHR>
implements org.lwjgl.system.NativeResource
Use the Windows keyed mutex mechanism to synchronize work.
Valid Usage
- Each member of
pAcquireSyncsandpReleaseSyncsmust be a device memory object imported by settingVkImportMemoryWin32HandleInfoKHR::handleTypetoEXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BITorEXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_KHR- If
acquireCountis not 0,pAcquireSyncsmust be a valid pointer to an array ofacquireCountvalidVkDeviceMemoryhandles - If
acquireCountis not 0,pAcquireKeysmust be a valid pointer to an array ofacquireCountuint64_tvalues - If
acquireCountis not 0,pAcquireTimeoutsmust be a valid pointer to an array ofacquireCountuint32_tvalues - If
releaseCountis not 0,pReleaseSyncsmust be a valid pointer to an array ofreleaseCountvalidVkDeviceMemoryhandles - If
releaseCountis not 0,pReleaseKeysmust be a valid pointer to an array ofreleaseCountuint64_tvalues - Both of the elements of
pAcquireSyncs, and the elements ofpReleaseSyncsthat are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the sameVkDevice
Layout
struct VkWin32KeyedMutexAcquireReleaseInfoKHR {
VkStructureType sType();
void const * pNext();
uint32_t acquireCount();
VkDeviceMemory const * pAcquireSyncs();
uint64_t const * pAcquireKeys();
uint32_t const * pAcquireTimeouts();
uint32_t releaseCount();
VkDeviceMemory const * pReleaseSyncs();
uint64_t const * pReleaseKeys();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkWin32KeyedMutexAcquireReleaseInfoKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct member offsets.static final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkWin32KeyedMutexAcquireReleaseInfoKHR(ByteBuffer container) Creates aVkWin32KeyedMutexAcquireReleaseInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionintthe number of entries in thepAcquireSyncs,pAcquireKeys, andpAcquireTimeoutsarrays.acquireCount(int value) Sets the specified value to theacquireCount()field.calloc()Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance at the specified memory.static @Nullable VkWin32KeyedMutexAcquireReleaseInfoKHRcreateSafe(long address) static @Nullable VkWin32KeyedMutexAcquireReleaseInfoKHR.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnacquireCount(long struct) Unsafe version ofacquireCount().static voidnacquireCount(long struct, int value) Sets the specified value to theacquireCountfield of the specifiedstruct.static @Nullable LongBuffernpAcquireKeys(long struct) Unsafe version ofpAcquireKeys.static voidnpAcquireKeys(long struct, @Nullable LongBuffer value) Unsafe version ofpAcquireKeys.static @Nullable LongBuffernpAcquireSyncs(long struct) Unsafe version ofpAcquireSyncs.static voidnpAcquireSyncs(long struct, @Nullable LongBuffer value) Unsafe version ofpAcquireSyncs.static @Nullable IntBuffernpAcquireTimeouts(long struct) Unsafe version ofpAcquireTimeouts.static voidnpAcquireTimeouts(long struct, @Nullable IntBuffer value) Unsafe version ofpAcquireTimeouts.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable LongBuffernpReleaseKeys(long struct) Unsafe version ofpReleaseKeys.static voidnpReleaseKeys(long struct, @Nullable LongBuffer value) Unsafe version ofpReleaseKeys.static @Nullable LongBuffernpReleaseSyncs(long struct) Unsafe version ofpReleaseSyncs.static voidnpReleaseSyncs(long struct, @Nullable LongBuffer value) Unsafe version ofpReleaseSyncs.static intnreleaseCount(long struct) Unsafe version ofreleaseCount().static voidnreleaseCount(long struct, int value) Sets the specified value to thereleaseCountfield of the specifiedstruct.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.@Nullable LongBuffera pointer to an array of mutex key values to wait for prior to beginning the submitted work.pAcquireKeys(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepAcquireKeys()field.@Nullable LongBuffera pointer to an array ofVkDeviceMemoryobjects which were imported from Direct3D 11 resources.pAcquireSyncs(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepAcquireSyncs()field.@Nullable IntBuffera pointer to an array of timeout values, in millisecond units, for each acquire specified inpAcquireKeys.pAcquireTimeouts(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepAcquireTimeouts()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable LongBuffera pointer to an array of mutex key values to set when the submitted work has completed.pReleaseKeys(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepReleaseKeys()field.@Nullable LongBuffera pointer to an array ofVkDeviceMemoryobjects which were imported from Direct3D 11 resources.pReleaseSyncs(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepReleaseSyncs()field.intthe number of entries in thepReleaseSyncsandpReleaseKeysarrays.releaseCount(int value) Sets the specified value to thereleaseCount()field.set(int sType, long pNext, int acquireCount, @Nullable LongBuffer pAcquireSyncs, @Nullable LongBuffer pAcquireKeys, @Nullable IntBuffer pAcquireTimeouts, int releaseCount, @Nullable LongBuffer pReleaseSyncs, @Nullable LongBuffer pReleaseKeys) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_KHRvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
ACQUIRECOUNT
public static final int ACQUIRECOUNTThe struct member offsets. -
PACQUIRESYNCS
public static final int PACQUIRESYNCSThe struct member offsets. -
PACQUIREKEYS
public static final int PACQUIREKEYSThe struct member offsets. -
PACQUIRETIMEOUTS
public static final int PACQUIRETIMEOUTSThe struct member offsets. -
RELEASECOUNT
public static final int RELEASECOUNTThe struct member offsets. -
PRELEASESYNCS
public static final int PRELEASESYNCSThe struct member offsets. -
PRELEASEKEYS
public static final int PRELEASEKEYSThe struct member offsets.
-
-
Constructor Details
-
VkWin32KeyedMutexAcquireReleaseInfoKHR
Creates aVkWin32KeyedMutexAcquireReleaseInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkWin32KeyedMutexAcquireReleaseInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
acquireCount
public int acquireCount()the number of entries in thepAcquireSyncs,pAcquireKeys, andpAcquireTimeoutsarrays. -
pAcquireSyncs
a pointer to an array ofVkDeviceMemoryobjects which were imported from Direct3D 11 resources. -
pAcquireKeys
a pointer to an array of mutex key values to wait for prior to beginning the submitted work. Entries refer to the keyed mutex associated with the corresponding entries inpAcquireSyncs. -
pAcquireTimeouts
a pointer to an array of timeout values, in millisecond units, for each acquire specified inpAcquireKeys. -
releaseCount
public int releaseCount()the number of entries in thepReleaseSyncsandpReleaseKeysarrays. -
pReleaseSyncs
a pointer to an array ofVkDeviceMemoryobjects which were imported from Direct3D 11 resources. -
pReleaseKeys
a pointer to an array of mutex key values to set when the submitted work has completed. Entries refer to the keyed mutex associated with the corresponding entries inpReleaseSyncs. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
acquireCount
Sets the specified value to theacquireCount()field. -
pAcquireSyncs
Sets the address of the specifiedLongBufferto thepAcquireSyncs()field. -
pAcquireKeys
Sets the address of the specifiedLongBufferto thepAcquireKeys()field. -
pAcquireTimeouts
Sets the address of the specifiedIntBufferto thepAcquireTimeouts()field. -
releaseCount
Sets the specified value to thereleaseCount()field. -
pReleaseSyncs
Sets the address of the specifiedLongBufferto thepReleaseSyncs()field. -
pReleaseKeys
Sets the address of the specifiedLongBufferto thepReleaseKeys()field. -
set
public VkWin32KeyedMutexAcquireReleaseInfoKHR set(int sType, long pNext, int acquireCount, @Nullable LongBuffer pAcquireSyncs, @Nullable LongBuffer pAcquireKeys, @Nullable IntBuffer pAcquireTimeouts, int releaseCount, @Nullable LongBuffer pReleaseSyncs, @Nullable LongBuffer pReleaseKeys) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkWin32KeyedMutexAcquireReleaseInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkWin32KeyedMutexAcquireReleaseInfoKHR callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nacquireCount
public static int nacquireCount(long struct) Unsafe version ofacquireCount(). -
npAcquireSyncs
Unsafe version ofpAcquireSyncs. -
npAcquireKeys
Unsafe version ofpAcquireKeys. -
npAcquireTimeouts
Unsafe version ofpAcquireTimeouts. -
nreleaseCount
public static int nreleaseCount(long struct) Unsafe version ofreleaseCount(). -
npReleaseSyncs
Unsafe version ofpReleaseSyncs. -
npReleaseKeys
Unsafe version ofpReleaseKeys. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nacquireCount
public static void nacquireCount(long struct, int value) Sets the specified value to theacquireCountfield of the specifiedstruct. -
npAcquireSyncs
Unsafe version ofpAcquireSyncs. -
npAcquireKeys
Unsafe version ofpAcquireKeys. -
npAcquireTimeouts
Unsafe version ofpAcquireTimeouts. -
nreleaseCount
public static void nreleaseCount(long struct, int value) Sets the specified value to thereleaseCountfield of the specifiedstruct. -
npReleaseSyncs
Unsafe version ofpReleaseSyncs. -
npReleaseKeys
Unsafe version ofpReleaseKeys. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-