Class VkExportFenceWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If VkExportFenceCreateInfo is not included in the same pNext chain, this structure is ignored.
If VkExportFenceCreateInfo is included in the pNext chain of VkFenceCreateInfo with a Windows handleType, but either VkExportFenceWin32HandleInfoKHR is not included in the pNext chain, or it is included but pAttributes is NULL, 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 will be
DXGI_SHARED_RESOURCE_READ | DXGI_SHARED_RESOURCE_WRITE
for handles of the following types:
EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT
Valid Usage
- If
VkExportFenceCreateInfo::handleTypesdoes not includeEXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT, aVkExportFenceWin32HandleInfoKHRstructure must not be included in thepNextchain ofVkFenceCreateInfo
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR- If
pAttributesis notNULL,pAttributesmust be a valid pointer to a validSECURITY_ATTRIBUTESvalue
Layout
struct VkExportFenceWin32HandleInfoKHR {
VkStructureType sType();
void const * pNext();
SECURITY_ATTRIBUTES const * pAttributes();
DWORD dwAccess();
LPCWSTR name();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkExportFenceWin32HandleInfoKHRstructs.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 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 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
ConstructorsConstructorDescriptionVkExportFenceWin32HandleInfoKHR(ByteBuffer container) Creates aVkExportFenceWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHRinstance 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 newVkExportFenceWin32HandleInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkExportFenceWin32HandleInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkExportFenceWin32HandleInfoKHR.Bufferinstance at the specified memory.static @Nullable VkExportFenceWin32HandleInfoKHRcreateSafe(long address) static @Nullable VkExportFenceWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity) intdwAccess()aDWORDspecifying access rights of the handle.dwAccess(int value) Sets the specified value to thedwAccess()field.malloc()Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHRinstance 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.name()a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created fence.name(ByteBuffer value) Sets the address of the specified encoded string to thename()field.a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created fence.static intndwAccess(long struct) Unsafe version ofdwAccess().static voidndwAccess(long struct, int value) Unsafe version ofdwAccess.static ByteBuffernname(long struct) Unsafe version ofname().static voidnname(long struct, ByteBuffer value) Unsafe version ofname.static StringnnameString(long struct) Unsafe version ofnameString().static @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTESnpAttributes(long struct) Unsafe version ofpAttributes().static voidnpAttributes(long struct, @Nullable 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.@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTESa pointer to a WindowsSECURITY_ATTRIBUTESstructure specifying security attributes of the handle.pAttributes(@Nullable 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.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess, ByteBuffer name) 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_EXPORT_FENCE_WIN32_HANDLE_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. -
PATTRIBUTES
public static final int PATTRIBUTESThe struct member offsets. -
DWACCESS
public static final int DWACCESSThe struct member offsets. -
NAME
public static final int NAMEThe struct member offsets.
-
-
Constructor Details
-
VkExportFenceWin32HandleInfoKHR
Creates aVkExportFenceWin32HandleInfoKHRinstance 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<VkExportFenceWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
pAttributes
public @Nullable 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
a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created fence. -
nameString
a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created fence. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pAttributes
public VkExportFenceWin32HandleInfoKHR pAttributes(@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value) Sets the address of the specifiedSECURITY_ATTRIBUTESto thepAttributes()field. -
dwAccess
Sets the specified value to thedwAccess()field. -
name
Sets the address of the specified encoded string to thename()field. -
set
public VkExportFenceWin32HandleInfoKHR set(int sType, long pNext, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess, ByteBuffer name) 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 newVkExportFenceWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkExportFenceWin32HandleInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkExportFenceWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkExportFenceWin32HandleInfoKHR.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 VkExportFenceWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkExportFenceWin32HandleInfoKHR 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 VkExportFenceWin32HandleInfoKHR.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 VkExportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkExportFenceWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkExportFenceWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkExportFenceWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.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(). -
npAttributes
public static @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES npAttributes(long struct) Unsafe version ofpAttributes(). -
ndwAccess
public static int ndwAccess(long struct) Unsafe version ofdwAccess(). -
nname
Unsafe version ofname(). -
nnameString
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
Unsafe version ofname. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-