Class VkExportSemaphoreWin32HandleInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkExportSemaphoreWin32HandleInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkExportSemaphoreWin32HandleInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying additional attributes of Windows handles exported from a semaphore.Description
If
VkExportSemaphoreCreateInfois not included in the samepNextchain, this structure is ignored.If
VkExportSemaphoreCreateInfois included in thepNextchain ofVkSemaphoreCreateInfowith a WindowshandleType, but eitherVkExportSemaphoreWin32HandleInfoKHRis not included in thepNextchain, or if it is butpAttributesis set toNULL, default security descriptor values will be used, and child processes created by the application will not inherit the handle, as described in the MSDN documentation for “Synchronization Object Security and Access Rights”1. Further, if the structure is not present, the access rights used depend on the handle type.For handles of the following types:
EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BITThe implementation must ensure the access rights allow both signal and wait operations on the semaphore.
For handles of the following types:
EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BITThe access rights must be:
GENERIC_ALLValid Usage
- If
VkExportSemaphoreCreateInfo::handleTypesdoes not includeEXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BITorEXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT,VkExportSemaphoreWin32HandleInfoKHRmust not be included in thepNextchain ofVkSemaphoreCreateInfo
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR- If
pAttributesis notNULL,pAttributesmust be a valid pointer to a validSECURITY_ATTRIBUTESvalue
Layout
struct VkExportSemaphoreWin32HandleInfoKHR { VkStructureTypesType(); void const *pNext();SECURITY_ATTRIBUTESconst *pAttributes(); DWORDdwAccess(); LPCWSTRname(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkExportSemaphoreWin32HandleInfoKHR.BufferAn array ofVkExportSemaphoreWin32HandleInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkExportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)Creates aVkExportSemaphoreWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkExportSemaphoreWin32HandleInfoKHRcalloc()Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withmemCalloc.static VkExportSemaphoreWin32HandleInfoKHR.Buffercalloc(int capacity)Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.static VkExportSemaphoreWin32HandleInfoKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkExportSemaphoreWin32HandleInfoKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkExportSemaphoreWin32HandleInfoKHRcallocStack()Deprecated.static VkExportSemaphoreWin32HandleInfoKHR.BuffercallocStack(int capacity)Deprecated.static VkExportSemaphoreWin32HandleInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkExportSemaphoreWin32HandleInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkExportSemaphoreWin32HandleInfoKHRcreate()Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withBufferUtils.static VkExportSemaphoreWin32HandleInfoKHR.Buffercreate(int capacity)Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.static VkExportSemaphoreWin32HandleInfoKHRcreate(long address)Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance for the specified memory address.static VkExportSemaphoreWin32HandleInfoKHR.Buffercreate(long address, int capacity)Create aVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance at the specified memory.static VkExportSemaphoreWin32HandleInfoKHRcreateSafe(long address)static VkExportSemaphoreWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity)intdwAccess()aDWORDspecifying access rights of the handle.VkExportSemaphoreWin32HandleInfoKHRdwAccess(int value)Sets the specified value to thedwAccess()field.static VkExportSemaphoreWin32HandleInfoKHRmalloc()Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withmemAlloc.static VkExportSemaphoreWin32HandleInfoKHR.Buffermalloc(int capacity)Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.static VkExportSemaphoreWin32HandleInfoKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkExportSemaphoreWin32HandleInfoKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.static VkExportSemaphoreWin32HandleInfoKHRmallocStack()Deprecated.static VkExportSemaphoreWin32HandleInfoKHR.BuffermallocStack(int capacity)Deprecated.static VkExportSemaphoreWin32HandleInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkExportSemaphoreWin32HandleInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.java.nio.ByteBuffername()a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created semaphore.VkExportSemaphoreWin32HandleInfoKHRname(java.nio.ByteBuffer value)Sets the address of the specified encoded string to thename()field.java.lang.StringnameString()a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created semaphore.static intndwAccess(long struct)Unsafe version ofdwAccess().static voidndwAccess(long struct, int value)Unsafe version ofdwAccess.static java.nio.ByteBuffernname(long struct)Unsafe version ofname().static voidnname(long struct, java.nio.ByteBuffer value)Unsafe version ofname.static java.lang.StringnnameString(long struct)Unsafe version ofnameString().static org.lwjgl.system.windows.SECURITY_ATTRIBUTESnpAttributes(long struct)Unsafe version ofpAttributes().static voidnpAttributes(long struct, org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)Unsafe version ofpAttributes.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.org.lwjgl.system.windows.SECURITY_ATTRIBUTESpAttributes()a pointer to a WindowsSECURITY_ATTRIBUTESstructure specifying security attributes of the handle.VkExportSemaphoreWin32HandleInfoKHRpAttributes(org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)Sets the address of the specifiedSECURITY_ATTRIBUTESto thepAttributes()field.longpNext()NULLor a pointer to a structure extending this structure.VkExportSemaphoreWin32HandleInfoKHRpNext(long value)Sets the specified value to thepNext()field.VkExportSemaphoreWin32HandleInfoKHRset(int sType, long pNext, org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess, java.nio.ByteBuffer name)Initializes this struct with the specified values.VkExportSemaphoreWin32HandleInfoKHRset(VkExportSemaphoreWin32HandleInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkExportSemaphoreWin32HandleInfoKHRsType(int value)Sets the specified value to thesType()field.VkExportSemaphoreWin32HandleInfoKHRsType$Default()Sets theSTRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHRvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkExportSemaphoreWin32HandleInfoKHR
public VkExportSemaphoreWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkExportSemaphoreWin32HandleInfoKHRinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
pAttributes
@Nullable public org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes()
a pointer to a WindowsSECURITY_ATTRIBUTESstructure specifying security attributes of the handle.
-
dwAccess
public int dwAccess()
aDWORDspecifying access rights of the handle.
-
name, nameString
public java.nio.ByteBuffer name() public java.lang.String nameString()
a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created semaphore.
-
sType
public VkExportSemaphoreWin32HandleInfoKHR sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkExportSemaphoreWin32HandleInfoKHR sType$Default()
Sets theSTRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHRvalue to thesType()field.
-
pNext
public VkExportSemaphoreWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNext()field.
-
pAttributes
public VkExportSemaphoreWin32HandleInfoKHR pAttributes(@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)
Sets the address of the specifiedSECURITY_ATTRIBUTESto thepAttributes()field.
-
dwAccess
public VkExportSemaphoreWin32HandleInfoKHR dwAccess(int value)
Sets the specified value to thedwAccess()field.
-
name
public VkExportSemaphoreWin32HandleInfoKHR name(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thename()field.
-
set
public VkExportSemaphoreWin32HandleInfoKHR set(int sType, long pNext, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess, java.nio.ByteBuffer name)
Initializes this struct with the specified values.
-
set
public VkExportSemaphoreWin32HandleInfoKHR set(VkExportSemaphoreWin32HandleInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkExportSemaphoreWin32HandleInfoKHR malloc()
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkExportSemaphoreWin32HandleInfoKHR calloc()
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkExportSemaphoreWin32HandleInfoKHR create()
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated withBufferUtils.
-
create
public static VkExportSemaphoreWin32HandleInfoKHR create(long address)
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkExportSemaphoreWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer create(long address, int capacity)
Create aVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkExportSemaphoreWin32HandleInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkExportSemaphoreWin32HandleInfoKHR.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 VkExportSemaphoreWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkExportSemaphoreWin32HandleInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkExportSemaphoreWin32HandleInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkExportSemaphoreWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkExportSemaphoreWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkExportSemaphoreWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
npAttributes
@Nullable public static org.lwjgl.system.windows.SECURITY_ATTRIBUTES npAttributes(long struct)
Unsafe version ofpAttributes().
-
ndwAccess
public static int ndwAccess(long struct)
Unsafe version ofdwAccess().
-
nname
public static java.nio.ByteBuffer nname(long struct)
Unsafe version ofname().
-
nnameString
public static java.lang.String nnameString(long struct)
Unsafe version ofnameString().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
npAttributes
public static void npAttributes(long struct, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)Unsafe version ofpAttributes.
-
ndwAccess
public static void ndwAccess(long struct, int value)Unsafe version ofdwAccess.
-
nname
public static void nname(long struct, java.nio.ByteBuffer value)Unsafe version ofname.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-