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
,NativeResource
,Pointer
public class VkWin32KeyedMutexAcquireReleaseInfoKHR
extends Struct<VkWin32KeyedMutexAcquireReleaseInfoKHR>
implements NativeResource
Use the Windows keyed mutex mechanism to synchronize work.
Valid Usage
- Each member of
pAcquireSyncs
andpReleaseSyncs
must be a device memory object imported by settingVkImportMemoryWin32HandleInfoKHR
::handleType
toEXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT
orEXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_KHR
- If
acquireCount
is not 0,pAcquireSyncs
must be a valid pointer to an array ofacquireCount
validVkDeviceMemory
handles - If
acquireCount
is not 0,pAcquireKeys
must be a valid pointer to an array ofacquireCount
uint64_t
values - If
acquireCount
is not 0,pAcquireTimeouts
must be a valid pointer to an array ofacquireCount
uint32_t
values - If
releaseCount
is not 0,pReleaseSyncs
must be a valid pointer to an array ofreleaseCount
validVkDeviceMemory
handles - If
releaseCount
is not 0,pReleaseKeys
must be a valid pointer to an array ofreleaseCount
uint64_t
values - Both of the elements of
pAcquireSyncs
, and the elements ofpReleaseSyncs
that 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
Modifier and TypeClassDescriptionstatic class
An array ofVkWin32KeyedMutexAcquireReleaseInfoKHR
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct member offsets.static final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkWin32KeyedMutexAcquireReleaseInfoKHR
(ByteBuffer container) Creates aVkWin32KeyedMutexAcquireReleaseInfoKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
the number of entries in thepAcquireSyncs
,pAcquireKeys
, andpAcquireTimeouts
arrays.acquireCount
(int value) Sets the specified value to theacquireCount()
field.calloc()
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) malloc()
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nacquireCount
(long struct) Unsafe version ofacquireCount()
.static void
nacquireCount
(long struct, int value) Sets the specified value to theacquireCount
field of the specifiedstruct
.static LongBuffer
npAcquireKeys
(long struct) Unsafe version ofpAcquireKeys
.static void
npAcquireKeys
(long struct, LongBuffer value) Unsafe version ofpAcquireKeys
.static LongBuffer
npAcquireSyncs
(long struct) Unsafe version ofpAcquireSyncs
.static void
npAcquireSyncs
(long struct, LongBuffer value) Unsafe version ofpAcquireSyncs
.static IntBuffer
npAcquireTimeouts
(long struct) Unsafe version ofpAcquireTimeouts
.static void
npAcquireTimeouts
(long struct, IntBuffer value) Unsafe version ofpAcquireTimeouts
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static LongBuffer
npReleaseKeys
(long struct) Unsafe version ofpReleaseKeys
.static void
npReleaseKeys
(long struct, LongBuffer value) Unsafe version ofpReleaseKeys
.static LongBuffer
npReleaseSyncs
(long struct) Unsafe version ofpReleaseSyncs
.static void
npReleaseSyncs
(long struct, LongBuffer value) Unsafe version ofpReleaseSyncs
.static int
nreleaseCount
(long struct) Unsafe version ofreleaseCount()
.static void
nreleaseCount
(long struct, int value) Sets the specified value to thereleaseCount
field of the specifiedstruct
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.a pointer to an array of mutex key values to wait for prior to beginning the submitted work.pAcquireKeys
(LongBuffer value) Sets the address of the specifiedLongBuffer
to thepAcquireKeys()
field.a pointer to an array ofVkDeviceMemory
objects which were imported from Direct3D 11 resources.pAcquireSyncs
(LongBuffer value) Sets the address of the specifiedLongBuffer
to thepAcquireSyncs()
field.a pointer to an array of timeout values, in millisecond units, for each acquire specified inpAcquireKeys
.pAcquireTimeouts
(IntBuffer value) Sets the address of the specifiedIntBuffer
to thepAcquireTimeouts()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.a pointer to an array of mutex key values to set when the submitted work has completed.pReleaseKeys
(LongBuffer value) Sets the address of the specifiedLongBuffer
to thepReleaseKeys()
field.a pointer to an array ofVkDeviceMemory
objects which were imported from Direct3D 11 resources.pReleaseSyncs
(LongBuffer value) Sets the address of the specifiedLongBuffer
to thepReleaseSyncs()
field.int
the number of entries in thepReleaseSyncs
andpReleaseKeys
arrays.releaseCount
(int value) Sets the specified value to thereleaseCount()
field.set
(int sType, long pNext, int acquireCount, LongBuffer pAcquireSyncs, LongBuffer pAcquireKeys, IntBuffer pAcquireTimeouts, int releaseCount, LongBuffer pReleaseSyncs, LongBuffer pReleaseKeys) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_KHR
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkWin32KeyedMutexAcquireReleaseInfoKHR
instance at the current position of the specifiedByteBuffer
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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkWin32KeyedMutexAcquireReleaseInfoKHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
acquireCount
public int acquireCount()the number of entries in thepAcquireSyncs
,pAcquireKeys
, andpAcquireTimeouts
arrays. -
pAcquireSyncs
a pointer to an array ofVkDeviceMemory
objects 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 thepReleaseSyncs
andpReleaseKeys
arrays. -
pReleaseSyncs
a pointer to an array ofVkDeviceMemory
objects 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_KHR
value 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 specifiedLongBuffer
to thepAcquireSyncs()
field. -
pAcquireKeys
Sets the address of the specifiedLongBuffer
to thepAcquireKeys()
field. -
pAcquireTimeouts
Sets the address of the specifiedIntBuffer
to thepAcquireTimeouts()
field. -
releaseCount
Sets the specified value to thereleaseCount()
field. -
pReleaseSyncs
Sets the address of the specifiedLongBuffer
to thepReleaseSyncs()
field. -
pReleaseKeys
Sets the address of the specifiedLongBuffer
to 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 newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated withBufferUtils
. -
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkWin32KeyedMutexAcquireReleaseInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and 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 theacquireCount
field 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 thereleaseCount
field 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
-