Class VkExportFenceWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,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 set to 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
::handleTypes
does not includeEXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT
, aVkExportFenceWin32HandleInfoKHR
structure must not be included in thepNext
chain ofVkFenceCreateInfo
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR
- If
pAttributes
is notNULL
,pAttributes
must be a valid pointer to a validSECURITY_ATTRIBUTES
value
Layout
struct VkExportFenceWin32HandleInfoKHR {
VkStructureType sType()
;
void const * pNext()
;
SECURITY_ATTRIBUTES
const * pAttributes()
;
DWORD dwAccess()
;
LPCWSTR name()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkExportFenceWin32HandleInfoKHR
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 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 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
ConstructorDescriptionVkExportFenceWin32HandleInfoKHR
(ByteBuffer container) Creates aVkExportFenceWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR
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 newVkExportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkExportFenceWin32HandleInfoKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkExportFenceWin32HandleInfoKHR.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
dwAccess()
aDWORD
specifying access rights of the handle.dwAccess
(int value) Sets the specified value to thedwAccess()
field.malloc()
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(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 int
ndwAccess
(long struct) Unsafe version ofdwAccess()
.static void
ndwAccess
(long struct, int value) Unsafe version ofdwAccess
.static ByteBuffer
nname
(long struct) Unsafe version ofname()
.static void
nname
(long struct, ByteBuffer value) Unsafe version ofname
.static String
nnameString
(long struct) Unsafe version ofnameString()
.static SECURITY_ATTRIBUTES
npAttributes
(long struct) Unsafe version ofpAttributes()
.static void
npAttributes
(long struct, SECURITY_ATTRIBUTES value) Unsafe version ofpAttributes
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.a pointer to a WindowsSECURITY_ATTRIBUTES
structure specifying security attributes of the handle.pAttributes
(SECURITY_ATTRIBUTES value) Sets the address of the specifiedSECURITY_ATTRIBUTES
to thepAttributes()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, SECURITY_ATTRIBUTES pAttributes, int dwAccess, ByteBuffer name) 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_EXPORT_FENCE_WIN32_HANDLE_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. -
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 aVkExportFenceWin32HandleInfoKHR
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<VkExportFenceWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
pAttributes
a pointer to a WindowsSECURITY_ATTRIBUTES
structure specifying security attributes of the handle. -
dwAccess
public int dwAccess()aDWORD
specifying 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_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pAttributes
Sets the address of the specifiedSECURITY_ATTRIBUTES
to 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 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 newVkExportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
. -
create
Returns a newVkExportFenceWin32HandleInfoKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkExportFenceWin32HandleInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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.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 VkExportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkExportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkExportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkExportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkExportFenceWin32HandleInfoKHR.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()
. -
npAttributes
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
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
-